🌟 If you find this project useful, please consider giving it a star! 🌟

</div> <p align="center"><img align="center" src="https://github.com/lanedirt/OGameX/assets/6917405/c81061d5-0310-4574-a91d-1ea155b567c0" alt="OGameX logo" /></p> <p align="center"> <a href="https://main.ogamex.dev">Live demo 🚀</a> • <a href="#installation">Installation 📦</a> • <a href="https://github.com/lanedirt/OGameX/blob/main/CONTRIBUTING.md">Contributing 💻</a> </p> <p align="center"> <strong>Open-source OGame redesign clone</strong> </p> <div align="center">

</div> <div align="center">

</div>

OGameX is an open-source OGame redesign clone. This clone is built fully from scratch using the Laravel 12.x framework and uses modern PHP practices. All major functionality is covered by unit and feature tests which automatically run on every build.

We welcome any and all contributions to this project! If you want to help out, please read the contributing section. If you have any questions you can join the OGameX discord to get in touch with the maintainers and other contributors.

Disclaimer: this project is purely fan-based and does not contain any commercial features. All backend code is written from scratch. The rights and concepts for the artwork and frontend belong to the original creators: GameForge GmbH. Support them by checking out the official version: https://ogame.org.

🖥️ Live demo

Main branch (nightly builds): https://main.ogamex.dev
Latest stable release (0.13.0): https://release.ogamex.dev

📝 Table of Contents

1. Example screenshots
2. About the author
3. Goal
4. Roadmap
- a) Upcoming Features
5. Contributing
6. Disclaimer
7. Installation
- a) Development: Install OGameX using Docker
- b) Production: Install OGameX using Docker
8. Upgrade
9. Support
10. Sponsorship
11. License
12. OGameX related projects

<a name="screenshots"></a> 🖥️ 1. Example screenshots

<a name="author"></a> ✨ 2. About the author

My (@lanedirt) journey into software development began in 2007 at the age of 14 when I discovered the source code for Ugamela, an early open-source PHP clone of OGame. I really liked running my own browser game server and dedicated myself to modifying this version and translating it to Dutch, leading to the launch of OGameX.nl. This server, active from 2007 to 2009, nurtured a small yet engaged community. This experience not only sparked my passion for software development but also laid the groundwork for my professional career. OGame has always held a special place in my heart, which is why now, 15 years later, I've decided to return to it and create this open-source clone from the ground up.

<a name="goal"></a> ✨ 3. Goal

The primary goal of this fan-based project is to engineer a faithful rendition of OGame, specifically reflecting its state prior to the Lifeforms update introduced in 2022. This initiative, purely fan-based and non-commercial, is pursued strictly for educational purposes.

<a name="roadmap"></a> 🖥️ 4. Roadmap

OGameX is under active development with a lot of core features already implemented and working:

Planets / buildings / research / shipyard / defense / galaxy / highscores / messages
Fleet dispatch missions (transport, deployment, colonisation, espionage, attack, recycle, moon destruction)
Missile attacks
Battle engine
- Rust version for high performance via PHP FFI (up to 200x faster compared to PHP)
- PHP version as fall-back
Moon
- Moon creation through debris field after battle
- Moon buildings, phalanx, jump gate
Admin panel
Expedition mission with various outcomes
Basic dark matter features (non-commercial)

<a name="upcoming-features"></a> Upcoming Features

The next major upcoming features that are being worked on:

Improved fleet mission processing via worker queue
Alliances
ACS fleet dispatch missions
All dark matter features (non-commercial)
Multi-language (making all in-game strings translatable)

<a name="contributing"></a> 🚀 5. Contributing

Contributions are warmly welcomed, whether in development, testing, or spreading the word. Feel free to submit pull requests or contact me for any other contributions.

A good starting point are issues labeled as "good first issue".

Read the CONTRIBUTING.md file for more information.

<a name="disclaimer"></a> 📓 6. Disclaimer

This project is a non-commercial hobby project. All rights and concepts related to OGame are owned by GameForge GmbH. We encourage supporters to try the official OGame at https://ogame.org to support its creators.

<a name="installation"></a> 🖥️ 7. Installation

The recommended way to install OGameX is by running the bundled Docker containers. This takes care of all the dependencies and is the easiest way to get started.

If you instead wish to install OGameX manually, see the list of requirements for Laravel 12.x and how to deploy manually to a server here: https://laravel.com/docs/12.x/deployment.

<a name="development"></a> a) Install for local development

For local development use the default docker-compose file that is included in this repository. This configuration is optimized for development and includes several tools that are useful for debugging and testing.

Please note that performance of the development mode is slow on Windows (compared to MacOS/Linux) due to overhead of running Docker on Windows. Loading pages with development mode enabled can take multiple seconds on Windows. If you want to run OGameX on Windows, I advise to use the production mode instead. One of the main differences is that the production configuration enables PHP OPcache which speeds up the application, but this also means that the PHP files are not updated (instantly) when you change them. This makes it less suitable for development.

Clone the repository.

$ git clone https://github.com/lanedirt/OGameX.git
$ cd OGameX

Launch the project using Docker Compose:

$ docker compose up -d

The default setup binds to ports 80/443. Modify docker-compose.yml if needed. PhpMyAdmin is also included for database management and is bound to port 8080. If you don't create a .env, the default .env.example will be copied to create it.

Important: it can take up to 10 minutes for the ogamex-app container to start, this is because of composer initialization and Rust compiling that happens on the first run. Please be patient and wait for all containers to have fully started.

After the docker containers have started, visit http://localhost to access OGameX.

Create a new account to start using OGameX. The first account created will be automatically assigned the admin role.

Note: if you need to run manual php artisan commands, you can SSH into the ogamex-app container with the docker compose exec -it ogamex-app bash command.

<a name="production"></a> b) Install for production

For production there is a separate docker-compose file called docker-compose.prod.yml. This configuration contains several performance optimizations and security settings that are not present in the developmen

OGameX

Install / Use

README