diff --git a/README.md b/README.md index 9e9fe0ea..6194cdd7 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,92 @@ -# 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 +- **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. -## Screenshots +## Getting Started -### Track JB -![Screenshot-JB-2024-12-26](media/Screenshot-JB-2024-12-26.png) +### 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**. -### Snow 1 -![Screenshot-S1-2024-12-26](media/Screenshot-S1-2024-12-26.png) +For Android devices, download the game directly from [Google Play](https://play.google.com/store). -### Retro race track 1 -![Screenshot-RR1-2022-10-17](media/Screenshot-RR1-2023-02-25.png) +### Installation +1. **Computer**: + - Download the appropriate executable for your system from the [Releases](https://github.com/gre-42/MGame/releases) page. + - Extract the downloaded file and run the executable. -### Island 0 -![Screenshot-I0-2024-12-26](media/Screenshot-I0-2024-12-26.png) +2. **Android**: + - Visit the [Google Play Store](https://play.google.com/store/apps/details?id=com.hallo2hallo.vanillarally) and search for "MGame". + - Download and install the app. -### Forest 0 -![Screenshot-F0-2024-12-26](media/Screenshot-F0-2024-12-26.png) +### Controls +- **Keyboard**: + - WASD keys to steer. + - ESC for the menu. +- **Controller**: + - Look in the ESC-Menu in "Controller" -### Desert 1 -![Screenshot-DS1-2025-01-03](media/Screenshot-DS1-2025-01-03.png) +## Screenshots +Take a sneak peek into the gameplay experience: -### Race track 0 -![Screenshot-R0-2023-12-26](media/Screenshot-R0-2024-12-26.png) - -### Großglockner High Alpine Road +### Realistic Tracks +- **Großglockner High Alpine Road** ![Screenshot-GH-2024-01-27](media/Screenshot-GH-2024-12-26.png) - -### New York City +- **New York City** ![Screenshot-NYC-2022-12-07](media/Screenshot-NYC-2023-12-07.png) - -### New York City (fly) +- **New York City (fly)** ![Screenshot-NYC-2022-04-14](media/Screenshot-NYC-2022-04-14-fly.jpg) - -### New York City (at night) +- **New York City (at night)** ![Screenshot-NYC-night-2022-06-09](media/Screenshot-NYC-night-2022-06-09.png) -### City 0 +### Themed Environments +- **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** +![Screenshot-DS1-2025-01-03](media/Screenshot-DS1-2025-01-03.png) +- **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) -### Aircraft carrier 0 +### Fun Extras +- **Aircraft carrier 0** ![Screenshot-A0-2022-07-17](media/Screenshot-A0-2022-07-17.png) - -### Team deathmatch 0 +- **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. +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! + +### Make your own map +Get creative! Get your own tracks using OpenStreetMap data. [Guide Coming Soon] + +## License +MGame does not have a license yet. + +## Acknowledgments +Special thanks to the [OpenStreetMap community](https://www.openstreetmap.org/) for providing high-quality mapping data. Join the OpenStreetMap community to contribute to the mapping data that powers MGame!