Skip to content

Latest commit

 

History

History
24 lines (15 loc) · 1.01 KB

CONTRIBUTING.md

File metadata and controls

24 lines (15 loc) · 1.01 KB

Contribution rules

  • Using git is preferred over GitHub web/Gitlab WebIDE.
  • Describe what you changed in the commits: no stupid commits like "Update README.md"

Structure information

One of the core ideas of Mineshaft, is the replaceable modules. You can replace any piece of the Mineshaft modules with your own.Think of Mineshaft as a puzzle where you can replace pieces with different ones. The "puzzle" is split into these directories:

  • core is core components and classes
  • render is the rendering engine. The rendering engine manages how does the game get displayed. it also manages shading.
  • gen is the world generation engine.
  • assets are the assets like music, sounds, textures, and other stuff.

Setting up the developement enivroment

As always, clone the repository by any means, ssh,GCM core, normal clone,etc.

git clone https://github.com/Mineshaft-game/Mineshaft

after that, create a remote named gitlab using git remote add gitlab https://gitlab.com/double-fractal/mineshaft2d/Mineshaft