Stabman!

Disclaimer

This README has been updated for the post-jam version. Most of what's written here is directed at the post-jam version. Jam-version executables are still available for download below, but we recommend the post-jam version :)

For a more detailed version of this README, check out our [GitHub repository][GitHub]'s README.
_(The original README is about double the size of this one, be warned.)_

Screenshots

[Level One Preview Video][level-one-preview-video]

Description

The theme for _Ludum Dare 44_ was...
> Your life is currency

We went for a simple, generic approach:
_You pay with your health to buy items._

The game is a _2D action-platformer_.
Your goal is simply to get to the end of each level.

Throughout the levels you will find _items_ which you can buy using your health as currency.

You regain health by defeating enemies.

Each level acts as a _checkpoint_; when you die, you restart at the beginning of the level.
The game will also automatically save your progress to a savefile, each time you beat a level or die.

As always with our jam games, we never properly finish.
This jam's game was _especially unfinished_.
If you intend to check out our game, we recommend trying our post-jam version.

After the jam ended at the end of April, we continued working on the game
with the goal to release a finished product (like always).
This time, we are proud to say, that we _actually finished this game_!

Controls

The exact controls are specified in the file `resources/config/bindings.ron`.
You can change bindings in this file however you want; the syntax _should_ be self-explanatory enough.
But careful: if you make a syntax error, the game will crash.
See the generated file `logs/panic.log` for error messages, if it crashes.

__Note:__
For the controller buttons we are using the Xbox naming scheme.
So the `A` button would be the `X` button on a DualShock controller, etc.

Action	Keyboard	Controller	Notes
Move LEFT	__`A`__	`DPadLeft`, `JoyStickLeft`
Move RIGHT	__`D`__	`DPadRight`, `JoyStickRight`
Jump	__`Space`__, `K`, `Up`, `W`	`A`	Hold down the jump button for a slower fall (lower gravity).
Attack LEFT	__`Left`__, `H`	`X`
Attack RIGHT	__`Right`__, `L`	`B`
Buy item	__`E`__	`Y`
Dash	__`Shift`__, `J`, `Down`	`ShoulderButtons` (_left_ or _right_)	Need to hold down movement keys + press dash key; diagonal dashes work; can only dash in-air
Toggle pause	`P`	`Start`
Start game from main menu	`Enter`, `Space`	`A`	Starts the _normal_ campaign, not _bonus_.
Continue game from pause menu	`Enter`, `Space`	`A`
Quit game from main menu	`Escape`, `Q`, `Backspace`	`B`
Quit to main menu from pause menu	`Escape`, `Q`, `Backspace`	`B`

---

Development

Tools Used

- __[Rust]__, programming language
- __[Amethyst]__, engine
- __[Deathframe]__, framework
- __[Vim]__, code editor
- __[GitHub]__, git repository hosting
- __[Gimp]__, tile/background/menu graphics
- __[Aseprite]__, sprite graphics
- __[Bosca Ceoil][BoscaCeoil]__, music
- __[FL Studio][FLStudio]__, music
- __[Tiled]__, level design
- __[Google Drive][GoogleDrive]__, file sharing
- __[Trello]__, task management

---

Licensing

This project, including all of its code and assets (such as images, audio, level files),
excluding fonts, are distributed under the terms of the [MIT License][MIT-license].

Fonts

The fonts (found under `resources/fonts`) remain unchanged,
and are licensed individually by their authors.

#### Undefined Medium
- Located at `resources/fonts/undefined-medium.ttf`
- [OFL License][undefined-medium-license]
- [Website][undefined-medium-website]
- [GitHub Repository][undefined-medium-github]
#### Ruji's Handwriting
- Located at `resources/fonts/rujis-handwriting.ttf`
- [OFL License][OFL-license]
- [Author's Website][rujis-handwriting-website]

SDL2

This project uses and redistributes an unchanged copy of [SDL2],
for controller support with [amethyst]'s `sdl_controller` feature.
`SDL2.dll` is distributed under the [zlib license][SDL2-license].

[ludumdare]: https://ldjam.com/events/ludum-dare/44/veggietartar
[LD44-release]: https://github.com/Noah2610/LD44/tree/LD44-release
[bin-jam-windows]: https://drive.google.com/file/d/1RtQ8vsJFH75WyZHTa1W_vxzchw6OhA7Y/view
[bin-jam-linux]: https://drive.google.com/file/d/1xffSHQmDppZ4KGcbApzIFt4l_XvT2pX2/view
[bin-dir]: https://drive.google.com/open?id=1XNMvBsOJkbbii6jp9T7Du9mNnso00Axn
[Rust]: https://www.rust-lang.org/
[Amethyst]: https://amethyst.rs/
[Deathframe]: https://github.com/Noah2610/deathframe
[Vim]: https://www.vim.org/
[GitHub]: https://github.com/Noah2610/LD44
[Gimp]: https://www.gimp.org/
[Aseprite]: https://www.aseprite.org/
[BoscaCeoil]: https://boscaceoil.net/
[FLStudio]: https://www.image-line.com/flstudio
[Tiled]: https://www.mapeditor.org/
[GoogleDrive]: https://drive.google.com/
[Trello]: https://trello.com/b/hkBWXYt9
[MIT-license]: https://github.com/Noah2610/LD44/blob/master/LICENSE
[SDL2]: https://www.libsdl.org/
[SDL2-license]: https://www.libsdl.org/license.php
[undefined-medium-website]: https://undefined-medium.com/
[undefined-medium-github]: https://github.com/andirueckel/undefined-medium
[undefined-medium-license]: https://github.com/andirueckel/undefined-medium/blob/master/OFL.txt
[OFL-license]: https://scripts.sil.org/OFL
[rujis-handwriting-website]: http://rujic.net/
[level-one-preview-video]: https://youtu.be/zPIvTLLeIPY
[itch-io]: https://noahro.itch.io/stabman