jesusmgg / mankind

CDGD01 - Community Driven Game Development

Mankind

O Melhor entre os mundos

Repository for Mankind, the open project from Akira community.

Useful links

Discord | Twitch | Unity Documentation | Project Roadmap

Why Contribute

To Improve your skill, learn a new one or just to help the community. ❤

Before You Start / Project Guidelines

• See the project issues to implement or suggest a new feature.
• If you need any extra information, feel free to contact us in the discord channel.

Unity Version

For this project, we will use Unity 2019.4 LTS, whatever the latest patch version is.

Things not allowed

There are a number of things we disallow or discourage, in order to keep the project organised and fun for everyone.

Please:

• Don’t update the version of Unity.
• Don’t add a new package to the project.
• Don’t update a package that is being used by the project.
• Don’t delete assets or scenes that are not strictly related to your contribution. Refactoring (renaming, moving) them is ok.
• Don’t add testing scenes, testing scripts, and in general assets that you should keep to yourself. Use them to test/prototype, and then exclude them when you push.

Any of these rules can be “broken” if there is a reason. Please discuss on the forums explaining why you think you need (e.g.) to add a new package, update one, etc.

In any case, absolutely:

• Do not add any kind of profanity, obscene content, or text or graphics that can be offensive to others.
• Do not contribute anything that is not your own creation. No models ripped from other games, no textures taken from the web, no royalty-free audio (unless you made it), no stolen bits of code (unless they are “open” and come with an open source license themselves).
• Don’t make a PR just to make one (i.e. you are testing things, or participating in a contest).

If you do any of the above, we reserve the right to ban you from contributing to the project any further. In case of doubt regarding intellectual property, ask first on the forums.

Project Structure

• Folders
  • Upper case for first letter
    • Scenes
      • MainMenu.
    • Scripts
      • Controllers
        • Player
          • PlayerController.cs
          • PlayerHealth.cs
        • Enemy
          • EnemyController.cs
          • EnemyHealth.cs
    • Graphics
      • Materials
      • Prefabs
      • Sprites
• Scripts
  • Follow the C# name convention

Contributing Guide [TEMP]

0. Create a github account.

   0.1 - If you are new to git, access this little guide.

1. To fork the project, just click the upper right button "Fork".

   

   1.1 - To clone the project:

    1.1.1 - git clone https://github.com/**your_github_user_name**/mankind.git
   

   

   1.2 - To Just download the project, just click the upper button called "Code" > "Download Zip".

2. Go to downloaded folder and open the terminal.

3. Go to development branch.

    3.1 - With the terminal, type: git checkout development.
   

4. Add your contribution.

5. Commit your change.

6. Send a Pull Request (PR) to the main repository.

   6.1 - to create a PR, in the main repository, just go to "Pull Request" tab, then click the "Create Pull Request", with the details of your changes.

   

7. If the owner of the repo is okay with your contribution then they will merge your changes with the original repository.

Alternative guide: GitHub fork docs

License

TODO

FAQ

This readme is based on the unity open project?
	Yes!