Fish Fight version of ‘Platformer Book’

[erlend-sh]

We should eventually have our own version of this booklet to onboard new contributors:

https://not-fl3.github.io/platformer-book/intro.html

Anyone is welcome to have a go at writing one of the missing pages of the tutorial, or rewriting the existing pages using our game as the reference codebase. Start an issue or chat with us about it and we’ll walk you through it.

Because FF uses Macroquad, we gotta start off explaining how to use mq. The tutorial will basically make a lightweight reimplementation of Fish Fight as a demonstration of how to make a game with Mq.

So this tutorial will explain how to make a game exactly like Fish Fight. But because the Fish Fight codebase itself is a fast moving target, we’re not gonna couple the tutorial to the exact production game.

---

A good start would be the first three that are missing in the booklet:

• Game core
• Game loop
• World

The way to approach the writing is very simple:

1. Inspect Fish Fight source code and ask #code channel Macroquad discord some initial questions about “what is game core?”
2. Write a stub of 50-100 words about ‘game core’ and check in with community. advisors again to make sure it makes sense.
3. Extend the stub by 2-3x words and finish the doc.

[erlend-sh]

We will be adopting the same docs strategy that @cdsupina has implemented for Theta Wave: https://github.com/thetawavegame/thetawave-legacy/tree/master/book

Our /docs folder will eventually be refactored to mdbook standards, so we can build a static website from our .md files. There will be at least two sections:

1. Platformer Tutorial
2. Fish Fight internals

The internals section will cover the types of tutorials we’re currently adding to /docs.

[tigleym]

Hey @erlend-sh / @cdsupina I've got a working version on a fork of the repo at: https://tigleym.github.io/FishFight/

Some more info on this:

• Static assets for the website are generated and being served on the gh-pages branch.
• This process is automated using a GitHub action. On the forked repo, we trigger a new build and deploy the book whenever we push to the book_dev branch. This of course can be modified to another branch.

Let me know what either of you think about this!

[erlend-sh]

That’s exactly what we want 👍