Mythmallow

A top-down arena shooter roguelite in which you're a mythical marshmallow fighting against peasant munchies such as chocolates, jellies, or candies!

Goal

Mythmallow is created after playing excessive amount of Brotato as a Rust enthusiast. The purpose is to learn how to develop a game from start to end with Bevy using best practices, and share it with the community as an example.

Installation

Mythmallow is free and open source! It'll be released on Steam and Epic Games Store for a small price in the future for those who want to donate or want to have the convenience of having the game on a gaming platform.

For the time being, the only way to play is to build the game yourself. The game is still in its infancy, so the release process is non-existent.

Steam

Coming soon...

Epic Games

Coming soon...

Pre-built

Coming soon...

Browser

Coming soon...

Crates.io

Coming soon...

Building

You need Nightly Rust Toolchain, Bevy OS Dependencies and LLD or Mold Linker to build the game.

Native (Debug)

To build the game for development in your native platform, you can run:

cargo build

Native (Release)

To build the game for release in your native platform, you can run:

cargo build --release --no-default-features --features native-release

WebAssembly (Debug)

To build the game for development in WebAssembly, you can run:

cargo build --target wasm32-unknown-unknown --no-default-features --features wasm-development

WebAssembly (Release)

To build the game for release in WebAssembly, you can run:

cargo build --release --target wasm32-unknown-unknown --no-default-features --features wasm-release

Usage

Arguments

• In Native:
  • Arguments are parsed from the command line arguments.

    mythmallow --seed 42 --game

• In WebAssembly:
  • Arguments are parsed from the URL.

    https://mythmallow.io/?seed=42&game

--configuration \

Specifies the configuration directory.

• In Native:
  • defaults to current platforms configuration directory (see dirs::config_dir)
• In WebAssembly:
  • defaults to session/configuration which means browsers session storage will be used

--data \

Specifies the data directory.

• In Native:
  • defaults to current platforms data directory (see dirs::data_dir)
• In WebAssembly:
  • defaults to session/data which means browsers session storage will be used

--seed \

Specifies the seed for random number generation in the game.

If not set manually, a random seed will be used.

Warning: This argument is only for debugging purposes. Same seed can result in a different game, in different versions of the game.

--game

Starts the application directly in-game, bypassing menus.

--mode \

Specifies the game mode when starting the application in-game.

Available Game Modes:

• survival

If not set manually, a random game mode will be selected.

--player \

Specifies the player when starting the application in-game.

Available Players:

• From Greek Mythology:
  • artemis
  • hades

If not set manually, a random player will be selected.

--enemies \

Specifies the enemies when starting the application in-game.

Available Enemies:

• sweet

If not set manually, random enemies will be selected.

--inventory \

Specifies the additional starting items, separated with commas, when starting the application in-game.

Available Items:

• bow-of-artemis
• bident-of-hades

If not set, the inventory will only contain the starting item of the selected player.

--level \

Specifies the level of the player when starting the application in-game.

• Should be between [1, 65535]

If not set, level of the player will be set to 1.

--experience \

Specifies the experience of the player when starting the application in-game.

• Works together with --level:
  • if specified experience is smaller than the experience required to reach the specified level
  • level would be set to the specified level
  • experience would be set to the experience required to reach the specified level
  • otherwise
  • experience would be set to the specified experience
  • level would be set to the same level as if you leveled up by gaining the specified experience in game

If not set, experience of the player will be set to 0.00.

--balance \

Specifies the balance of the player when starting the application in-game.

If not set, balance of the player will be set to 0.00.

--free-refreshes \

Specifies the number of free refreshes to give to the player when starting the application in-game.

If not set, player won't have any free refreshes.

--god-mode

Enables god mode.

• You still take damage when god mode is enabled, you just can't die, even if your health is lower than zero.

Arguments for game modes

• In Native:
  • Arguments are parsed from the "mode" command line argument.

    mythmallow --game --mode "survival --wave 2"

• In WebAssembly:
  • Arguments are parsed from the "mode" query parameter.

    https://mythmallow.io/?game&mode=|survival?wave=2|

Survival mode

--wave \

Specifies the wave when starting the application in-game.

If not set manually, or set incorrectly, the first wave will be selected.

Documentation

API Documentation

To view the API documentation, you can run:

cargo doc --open

Design Documentation

To view the design documentation, you can run:

mdbook serve --open

(requires mdbook).

License

Mythmallow is free, open source and permissively licensed!

All code in this repository is dual-licensed under either:

• MIT License (LICENSE-MIT or https://opensource.org/licenses/MIT)
• Apache License, Version 2.0 (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)

This means you can select the license you prefer!