ikea/README.md

24 lines
1.6 KiB
Markdown
Raw Normal View History

2019-05-22 15:52:38 -07:00
# The Infinite IKEA (For Minetest)
This is a pre-alpha game for the [Minetest](https://www.minetest.net) game engine focussed around implementing an accurate depiction of [SCP-3008](http://www.scp-wiki.net/scp-3008), while keeping with the Open Source heritage of the SCP Wiki itself.
## Contributing
If you would like to contribute to the project, take a look at [the issue tracker](https://gitlab.com/benrob0329/ikea/issues) for information about that is currently on the TODO. Contributions to the Wiki regarding any implemented game-play are also appreciated.
**All code is licensed under an Apache 2.0 license unless otherwise noted.**
**All media (anything not code) is licensed under a [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/) unless otherwise noted**
### Textures
All textures should use colors from GIMP's "Caramel" pallette whenever possible. When the colors there won't do the trick, similar colors should be used. Generally changing only the hue or only the brightness will keep a similar feel with the rest of the colors.
### Code Style
Generally, standard Minetest Mod code styling should be used. Try to match what you see, but here are some bullet points for it:
* Use 1 **Tab** for each indentation level (you can change how big the tabs are in your own editor, but make sure its a "hard tab")
* Strings Should Always Be Encased In Double Quotes
* Commas after every entry in any multi-item table
* The closing brackets for registrations (node, item, etc) should be on their own line, and on the same indentation level as the definition function.