ohsqueezy 8b2125f606 | ||
---|---|---|
doc | ||
lib | ||
resource | ||
src | ||
www | ||
.gitignore | ||
.gitmodules | ||
LICENSE.txt | ||
Makefile | ||
Press_Kit.md | ||
README.md | ||
clang_sanitize_ignorelist.txt | ||
config.json | ||
favicon.ico | ||
index.html |
README.md
Cakefoot is a challenging, single-button dodge 'em up on rails. Pilot a walking cake -- hold to accelerate, let go to drift back, and avoid enemy patterns. Featuring an epic 22-level quest, arcade mode, unlockables, and high scores, Cakefoot is endlessly replayable, and impossible to defeat.
Cakefoot is one of the first games made with the open-source SPACE🪐BOX engine and is free to play online. It is the first game available for the dank.game web games portal.
Mod
It is possible to edit or add levels, sprites, and some design parameters without needing to rebuild the game.
Config and assets
Asset swaps and some style edits, such as colors and fonts, are the easiest mods to do. Change the relevant values in config.json. In some cases, the values can even be changed while the game is running just by saving the file changes.
Levels
Levels in resource/levels.json are also easy to add and mod using JSON, but the syntax is not documented yet. The shape of the curve, checkpoints, and enemies are all definable in the level syntax.
Code
Anything not in the config or the levels file will have to be changed in code, so they will require compiling the code.
Build
Clone both the game code and the SPACE🪐BOX engine code using --recursive
. The engine code will be in lib/sb/
along with documentation and demos.
$ git clone --recursive https://open.shampoo.ooo/shampoo/cakefoot/
Each platform has its own target in the Makefile. There is some documentation in the Makefile itself that should be checked. The current supported platforms are web browsers, Linux, and Windows. Until further documentation is added, the best way to get started on building for a platform is by installing the prerequisites for SPACE🪐BOX, compiling the box demo for the desired platform, and attempting to build a Cakefoot target.
To build on Linux, for example, once SPACE🪐BOX is confirmed to be working, run
$ make Cakefoot-linux_debug.x86_64
Press kit
There is a press kit included in Markdown format in the root of the repository. This can be converted into an HTML page using the conversion tool Pandoc. Once Pandoc is installed, run the make target from the terminal to generate a file press.html
in the root folder.
$ make press
The generated page will look like this. To edit the press kit, for example if this repository is being used for a mod or another game, edit the markdown file, CSS rules, metadata, and optionally the template, and re-run the make target.
License
The code is open source under the zlib license. The images and sound effects are released as CC BY 4.0, meaning they can be used commercially, but credit must be given. The background music is copyrighted and cannot be used commercially.
See LICENSE.txt for details.
Contact
Email or DM questions or raise an issue. Documentation and any other pull requests are welcome.
Method | Contact information |
---|---|
cocktail.frank@dank.game | |
Web | https://dank.game |
X | https://x.com/diskmem |
PayPal | https://paypal.me/ohsqueezy |