Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mechanicalflower/marble
⚽ A marble race minigame
https://github.com/mechanicalflower/marble
game gamedev godot godot-engine godot4 marble racing-game
Last synced: about 1 month ago
JSON representation
⚽ A marble race minigame
- Host: GitHub
- URL: https://github.com/mechanicalflower/marble
- Owner: MechanicalFlower
- License: mit
- Created: 2022-12-26T11:04:54.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-01T14:18:50.000Z (about 1 month ago)
- Last Synced: 2024-12-01T15:25:26.222Z (about 1 month ago)
- Topics: game, gamedev, godot, godot-engine, godot4, marble, racing-game
- Language: GDScript
- Homepage: https://mechanicalflower.github.io/Marble/
- Size: 102 MB
- Stars: 9
- Watchers: 1
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ⚽ Marble
A marble race minigame, made with [Godot Engine](https://godotengine.org/).
## 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](https://manpages.ubuntu.com/manpages/focal/en/man8/snap.8.html), 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](https://docs.appimage.org/introduction/quickstart.html#how-to-run-an-appimage).
### 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.
## Contributing
We welcome community contributions to this project.
Please read our [Contributor Guide](CONTRIBUTING.md) for more information on how to get started.
## Releasing
Please read our [Release Guide](RELEASING.md) for more information on how we manage our releases.