cakefoot/README.md

89 lines
4.5 KiB
Markdown
Raw Permalink Normal View History

![](doc/Cakefoot_logo.png)
Fork it up! _Cakefoot_ is a challenging, single-button dodge em up on rails. Pilot a walking cake hold to accelerate, let go to drift back and survive against all odds. Featuring 22 epic levels, arcade mode, unlockables, and high scores, _Cakefoot_ is endlessly replayable, and impossible to defeat.
![](https://5.shampoo.ooo/video/Cakefoot_the_cookie_crumbles.gif)
2024-03-22 12:27:20 -04:00
_Cakefoot_ is one of the first games made with the open-source [SPACE🪐BOX](https://open.shampoo.ooo/shampoo/spacebox) engine and is free to [play online](https://cakefoot.dank.game). It is the first game available for the [dank.game](https://dank.game) web games portal.
2024-04-02 20:38:19 -04:00
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](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 [levels.json](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 ###
Other changes will require code edits. See the [Build](#Build) section.
2024-04-02 20:38:19 -04:00
Build
=====
Clone both the game code and the [SPACE🪐BOX](https://open.shampoo.ooo/shampoo/spacebox) 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 a corresponding target in the [Makefile](Makefile). There is some documentation in the Makefile itself that should be checked. The current supported platforms are web browsers, Linux, Windows, and MacOS.
Until further documentation is added, one way to get started building for a platform is to first build the [box demo](https://open.shampoo.ooo/shampoo/spacebox/src/branch/main/demo/box) for the desired platform in a separate project.
Once the box demo is confirmed to build, try making a build of Cakefoot, for example the Linux version
$ make Cakefoot-linux_debug.x86_64
Press kit
=========
2024-03-20 21:53:39 -04:00
There is a [press kit](Press_kit.md) included in Markdown format in the root of the repository. This can be converted into an HTML page using the conversion tool [Pandoc](https://pandoc.org/). Once Pandoc is installed, run the make target from the terminal to generate a file `press.html` in the root folder.
$ make press
2024-04-02 20:38:19 -04:00
The generated page will look like [this](https://cakefoot.dank.game/press.html). To edit the press kit, for example if this repository is being used for a mod or another game, edit the [markdown file](Press_kit.md), [CSS rules](src/Press_kit_style.html), [metadata](src/Press_kit_metadata.yml), and optionally the [template](src/Press_kit_template.html), and re-run the make target.
License
=======
The code is open source under the zlib license, and the assets are released under the Creative Commons BY 4.0 license. This means the game can be legally copied, modified, and used commercially, as long as appropriate credit is given.
See [LICENSE.txt](LICENSE.txt) for details, including how to provide credit.
History
=======
1.1.0
- added coin bank to HUD
- coin status saves per level instead of just as a total count of coins
- coin displays over the player's head after it is grabbed until it is collected
1.0.4
- add options sub-menu to title screen: bgm, sfx, fullscreen, and exit
- hide UI when gamepad is in use, enable when mouse is in use
- indicate selected UI button using hue rotation animation
- support for gamepad hat
- support for disconnecting and reconnecting gamepads
- sanitize collected data in WASM build and write files per session
- add function for finding the closest UI button in a given direction
- bug fix: prevent character from moving when level loads or play is resumed from the pause menu
- bug fix: cancel character walking sfx when paused
Contact
=======
Email or DM questions or [raise an issue](https://open.shampoo.ooo/shampoo/cakefoot/issues). Documentation and any other [pull requests](https://open.shampoo.ooo/shampoo/cakefoot/pulls) are welcome.
2024-03-22 12:27:20 -04:00
| Method | Contact information |
| :------ | :---------------------------- |
| E-mail | cocktail.frank@dank.game |
| Web | <https://dank.game> |
| X | <https://x.com/diskmem> |
| PayPal | <https://paypal.me/ohsqueezy> |