diff --git a/README.md b/README.md new file mode 100644 index 0000000..a514ec3 --- /dev/null +++ b/README.md @@ -0,0 +1,77 @@ + +
+ +# 🐸 Frogger3D + +![Godot Badge](https://img.shields.io/badge/godot-4.2-blue?logo=Godot-Engine&logoColor=white) +![license](https://img.shields.io/badge/license-MIT-green?logo=open-source-initiative&logoColor=white) + +A [frogger](https://en.wikipedia.org/wiki/Frogger), made with [Godot Engine](https://godotengine.org/). + +Download on Github + +
+ +## 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 `Marble.exe`. +- **MacOS**: Double click on `Marble.app`. +- **Linux**: In a terminal, run `./Marble.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/Marble.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`](https://just.systems/man/en/) as command runner, +- [`pre-commit`](https://pre-commit.com/) to run formatters, this requires [Python 3](https://docs.python.org/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.