Skip to content

MechanicalFlower/Marble

Repository files navigation

⚽ Marble

Godot Badge license reuse

A marble race minigame, made with Godot Engine.

Download on Github Download on itch.io Get it from the Snap Store Download as AppImage

About

Marble is an open source mini-game about marble racing.

Controls

  • Tab to follow an other marble.
  • ESC to open and close menu.

Features

  • Name your marbles.
  • Start procedural races.
  • Watch the real-time ranking.

There are two racing modes: normal and explosion.

In explosion, a timer starts, and when it reaches zero the last marble explodes. The race is infinite, and the game ends when only one marble remains.

Screenshots

Installation

From a release

Released binaries are available on Itch.io and 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 Snap

With the Snap command line, run:

snap install marble-race

To run the game:

marble-race.marble

From an AppImage

The AppImage is available on the Github repository, in the release section.

More details on how to run an AppImage, on the official documentation.

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:

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

Contributor Covenant

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.