Mankind
The best between worlds
Repository for Mankind, the open project from Akira community.
Project Purpose
We are trying to build a society in a 2D top-down world where people will be able to craft, farm, study, buy and sell and define the fate of his character/avatar. This is a game that is being built by the community. Well, can be a game in the future, but for now has been a play ground for practicing unity engine. Of course, we try to coordinate some of the aspects we can have in the game in order to establish some bare-bones of the idea, otherwise would be too loose. It is the first attempt to build a game where everyone can contribute, collaborate with art, ui, music, programming. Whatever you good at, you can help to shape this world.
Come and join us to discover what is possible to build working together free from the chains of a scope. :)
Useful links
Discord | Twitch | Unity Documentation | Project Roadmap
Why Contribute
To Improve your skill, learn a new one or just to help the community and build this amazing world. ❤
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 2020.1.8f1, 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
- Assets
- _Game
- Animation
- Art
- Resources
- Scenes
- Scripts
- Settings
- External packages are installed directly in the Assets folder
- _Game
- Assets
Scripts
- Follow the C# name convention
- Camel Case (camelCase): In this standard, the first letter of the word always in small letter and after that each word starts with a capital letter.
- Pascal Case (PascalCase): In this the first letter of every word is in capital letter.
- Underscore Prefix (_underScore): For underscore ( __ ), the word after _ use camelCase terminology.
| Kind | Rule |
|---|---|
| Private field | _lowerCamelCase |
| Public field | UpperCamelCase |
| Protected field | UpperCamelCase |
| Internal field | UpperCamelCase |
| Property | UpperCamelCase |
| Method | UpperCamelCase |
| Class | UpperCamelCase |
| Interface | IUpperCamelCase |
| Local variable | lowerCamelCase |
| Parameter | lowerCamelCase |
Contributing Guide
1. Fork the original repository to your own repository
2. Clone it to your local
3. Contribute to it
4. Push it to your remote repo
5. Send a PR to the main repo
6. Your contribution will be evaluated then we will merge your changes with the original repository.
Please don't create other branches