Currently in development, Poly-Crafting-Idle is a game framework for creating low-poly games in UnityEngine with procedural generation and physics simulation capabilities. It provides the utilities and systems for designing these low-poly games with fully destructible environments. Systems will include crafting, machine construction, farming, wildlife, idle, advancement, mining, combat, enemy and npc. The designed games should run on any platform including mobile.
You can install by cloning the repo to a local folder and importing it to UnityEngine or you can launch UnityEngine and import it directly from GitHub.
If you want to contribute to this project and make it better, your help is very welcome. Contributing is a great way to learn more about social coding on GitHub, new technologies and their ecosystems and how to make constructive, helpful bug reports, feature requests and the noblest of all contributions: a good, clean pull request.
- Create a personal fork of the project on GitHub.
- Clone the fork on your local machine. Your remote repo on GitHub is called origin.
- Add the original repository as a remote called upstream.
- If you created your fork a while ago be sure to pull upstream changes into your local repository.
- Create a new branch to work on! Branch from develop if it exists, else from master.
- Implement/fix your feature, comment your code.
- Follow the code style of the project, including indentation.
- If the project has tests run them!
- Write or adapt tests as needed.
- Add or change the documentation as needed.
- Squash your commits into a single commit with git's interactive rebase. Create a new branch if necessary.
- Push your branch to your fork on GitHub, the remote origin.
- From your fork open a pull request in the correct branch. Target the project's develop branch if there is one, else go for master!
- ...
- Once the pull request is approved and merged you can pull the changes from upstream to your local repo and delete your extra branch(es).
- And last but not least: Always write your commit messages in the present tense. Your commit message should describe what the commit, when applied, does to the code – not what you did to the code.
Copyright (C) 2021 GamingBuddhist & KataReborn
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see https://www.gnu.org/licenses/.