Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 68 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,85 @@
# MGame
# MGame

A rally game based on OpenStreetMap data.
MGame is a rally game powered by **OpenStreetMap** data, bringing real-world maps to your gaming experience!

The [release section on GitHub](https://github.com/gre-42/MGame/releases) contains executables of the PC version (Linux and Windows), while the Android build can be downloaded [from Google Play](https://play.google.com/store/apps/details?id=com.hallo2hallo.vanillarally).
## Features

For instructions how to add a custom stage, see [CONTRIBUTING](CONTRIBUTING.md).
- **Real-world map integration**: Drive on tracks based on OpenStreetMap data.
- **Cross-platform support**: Play on Linux, Windows, or Android.
- **Dynamic environments**: Explore stages with varying times of day and weather.

## Getting Started and Download

You can download the latest version of MGame from the [Releases](https://github.com/gre-42/MGame/releases) section on GitHub for **Windows** and **Linux**. For Android devices, download the game directly from [Google Play](https://play.google.com/store).

## Screenshots

### Track JB
![Screenshot-JB-2024-12-26](media/Screenshot-JB-2024-12-26.png)
Take a sneak peek into the gameplay experience:

### Snow 1
![Screenshot-S1-2024-12-26](media/Screenshot-S1-2024-12-26.png)
### Realistic Tracks

### Retro race track 1
![Screenshot-RR1-2022-10-17](media/Screenshot-RR1-2023-02-25.png)
- **Großglockner High Alpine Road**
![Screenshot-GH-2024-01-27](media/Screenshot-GH-2024-12-26.png)
- **New York City**
![Screenshot-NYC-2022-12-07](media/Screenshot-NYC-2023-12-07.png)
- **New York City (fly)**
![Screenshot-NYC-2022-04-14](media/Screenshot-NYC-2022-04-14-fly.jpg)
- **New York City (at night)**
![Screenshot-NYC-night-2022-06-09](media/Screenshot-NYC-night-2022-06-09.png)

### Island 0
![Screenshot-I0-2024-12-26](media/Screenshot-I0-2024-12-26.png)
### Themed Environments

### Forest 0
- **Island 0**
![Screenshot-I0-2024-12-26](media/Screenshot-I0-2024-12-26.png)
- **Forest 0**
![Screenshot-F0-2024-12-26](media/Screenshot-F0-2024-12-26.png)

### Desert 1
- **Desert 1**
![Screenshot-DS1-2025-01-03](media/Screenshot-DS1-2025-01-03.png)

### Race track 0
- **Track JB**
![Screenshot-JB-2024-12-26](media/Screenshot-JB-2024-12-26.png)
- **Snow 1**
![Screenshot-S1-2024-12-26](media/Screenshot-S1-2024-12-26.png)
- **Retro race track 1**
![Screenshot-RR1-2022-10-17](media/Screenshot-RR1-2023-02-25.png)
- **Race track 0**
![Screenshot-R0-2023-12-26](media/Screenshot-R0-2024-12-26.png)
- **City 0**
![Screenshot-T0-2022-10-02](media/Screenshot-T0-2022-10-02.png)

### Großglockner High Alpine Road
![Screenshot-GH-2024-01-27](media/Screenshot-GH-2024-12-26.png)
### Fun Extras

- **Aircraft carrier 0**
![Screenshot-A0-2022-07-17](media/Screenshot-A0-2022-07-17.png)
- **Team deathmatch 0**
![Screenshot-TD0-2023-02-25](media/Screenshot-TD0-2023-02-25.png)

## Contributing

We welcome contributions to make MGame even better! Here’s how you can help:

### Open an Issue

Directly under https://github.com/gre-42/MGame/issues with enough description. If its a bug, please add your Operating Systen and the version, also the version of the game you are playing.

### Help developing

1. Fork the repository and pull your forked repository
2. Create a feature branch: `git checkout -b feature-name`.
3. Commit your changes: `git commit -m 'Add some feature'`.
4. Push to the branch: `git push origin feature-name`.
5. Open a Pull Request.

### Translations

Want MGame in your language? Help translate by contributing to the localization files!

### Add a custom stage

Instruction on how to get creative and add your own track, see [CONTRIBUTING](CONTRIBUTING.md).

## License

MGame is open-source software licensed under the [MIT License](LICENSE.md).

## Acknowledgments

Expand Down