README.md

🍈 MelonCrusade

A frogger-like 3D platformer game, made with Godot Engine.

About

Dodge traffic on a busy road, then cross a river by jumping on floating logs and climb a rock to reach the melon.

Installation

From a release

Released binaries are available on the Github repository, in the release section.

Download the zip archive, accordingly to your OS, and unzip it.

• Windows: Double click on MelonCrusade.exe.
• MacOS: Double click on MelonCrusade.app.
• Linux: In a terminal, run ./MelonCrusade.x86_64.

From source

Important

For this installation, you need to have the Godot Editor installed.

Clone the source locally:

git clone https://github.com/MechanicalFlower/MelonCrusade.git

You need to install addons first:

godot --headless --script plug.gd install

And simply run the game as any Godot project:

godot

Development

The project use:

• just as command runner,
• pre-commit to run formatters, this requires Python 3.

Important

Actually, just recipes only support Linux.

To check all available recipes, run:

just

To run formatters:

just fmt

To install, and run the game:

just install-addons
just godot

Tip

In just recipes, the Godot Editor is installed automatically. This ensure that you use the right version of the engine.

Contributing

We welcome community contributions to this project.

Please read our Contributor Guide for more information on how to get started.

Releasing

Please read our Release Guide for more information on how we manage our releases.