2.2 KiB
The Game Design
Truthfully non-linear, but in a loose order of priority.
Index
About Forkable Game Design
This is a game design document template, ready to be forked by you.
Features
- Open to be forked by anyone, really.
- Wiki-friendly hierarchical structure.
- Mermaid used/recommended for flowchartsm, and diagrams (sequence, state, etc.).
- Team-friendly, assuming your team can use Git and Markdown.
TODO
- Document game object states/state machines.
- Needed by (or can be used by) players, NPCs, and tetrominoes alike.
- Mermaid can diagram them. Put mermaid to work.
- Roadmaps and asset lists can be beneficial. Maybe more project management than design doc turf though.
How To Fork
I don't personally use Github. I don't want to make it easy for code to become training data, though in truth I know that's a losing battle since intellectual property law is likely only applied one-way from wealthy to unwealthy individuals. Either way, I fight in my own way.
To fork this repository onto Github, if that is your preferred forge, simply:
git clone https://git.misc.work/jahn/forkable-game-design.git my-gamecd my-gamegit remote remove origin
Then create a repository on Github, and follow Github's steps for pushing an existing repo. From there, it's yours. You can sync to upstream if you'd like by adding an additional remote, but your project should grow individually so I'll leave that as an exercise to the reader. I won't be changing much here anyway.
This is yours.
Please remove this preface after you fork it. Leave the link at the bottom if you'd like but it's not a priority. It's yours.
Design docs as Git repos, and the organizational efforts are a brainchild of Jahn at misc.work