Welcome to my GoDot Repository! This repository is dedicated to showcasing my journey through game development using the powerful and open-source Godot Engine. Here, you'll find a collection of both 2D and 3D games, each stored in its own subdirectory and numerically ordered by creation date for easy navigation.
Welcome to GoDot, a curated collection of my game development endeavors using the Godot Engine. This repository serves as a living portfolio, featuring a diverse array of games, experiments, and prototypes that I've developed. Ranging from simple 2D puzzles to complex 3D adventures, each game represents a step in my ongoing journey to master the art and science of game development.
- Godot Engine: Most recent stable version recommended. The games are developed with various versions, so the latest provides the best backward compatibility.
- Git: For cloning and managing contributions to the repository.
- Basic Knowledge of Godot: Familiarity with Godot's interface and scripting language (GDScript) will help you understand and run the projects.
- A Compatible Device: A computer capable of running the Godot Engine and the projects within this repository.
- Clone the repository with the following command:
git clone https://github.com/BrenoFariasdaSilva/GoDot.git
cd GoDot- Install the project dependencies with the following command:
make installThis will install the Godot Engine and any other dependencies required to run the projects in this repository.
In order to run the project, you must open the GoDot GUI and import the desired directory of this repository. Then, you can run the project by clicking the play button.
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. If you have suggestions for improving the code, your insights will be highly welcome. In order to contribute to this project, please follow the guidelines below or read the CONTRIBUTING.md file for more details on how to contribute to this project, as it contains information about the commit standards and the entire pull request process. Please follow these guidelines to make your contributions smooth and effective:
-
Set Up Your Environment: Ensure you've followed the setup instructions in the Setup section to prepare your development environment.
-
Make Your Changes:
- Create a Branch:
git checkout -b feature/YourFeatureName - Implement Your Changes: Make sure to test your changes thoroughly.
- Commit Your Changes: Use clear commit messages, for example:
- For new features:
git commit -m "FEAT: Add some AmazingFeature" - For bug fixes:
git commit -m "FIX: Resolve Issue #123" - For documentation:
git commit -m "DOCS: Update README with new instructions" - For refactorings:
git commit -m "REFACTOR: Enhance component for better aspect" - For snapshots:
git commit -m "SNAPSHOT: Temporary commit to save the current state for later reference"
- For new features:
- See more about crafting commit messages in the CONTRIBUTING.md file.
- Create a Branch:
-
Submit Your Contribution:
- Push Your Changes:
git push origin feature/YourFeatureName - Open a Pull Request (PR): Navigate to the repository on GitHub and open a PR with a detailed description of your changes.
- Push Your Changes:
-
Stay Engaged: Respond to any feedback from the project maintainers and make necessary adjustments to your PR.
-
Celebrate: Once your PR is merged, celebrate your contribution to the project!
This project is licensed under the Apache License 2.0. This license permits use, modification, distribution, and sublicense of the code for both private and commercial purposes, provided that the original copyright notice and a disclaimer of warranty are included in all copies or substantial portions of the software. It also requires a clear attribution back to the original author, Breno Farias da Silva, of the repository, in . For more details, see the LICENSE file in this repository.