OGameX is an open-source OGame clone aiming to recreate the official OGame experience, developed originally by GameForge GmbH. This clone is built from scratch using the Laravel 11.x framework and uses modern PHP practices.

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

• 1. Example screenshots
• 2. About the author
• 3. Goal
• 4. Current State of the Project
  • a) Upcoming Features
• 5. Contributing
• 6. Disclaimer
• 7. Installation
  • a) Development: Install OGameX using Docker
  • b) Production: Install OGameX using Docker
  • c) Tips for initial setup
• 8. Support
• 9. License

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.

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 2020. This initiative, purely fan-based and non-commercial, is pursued strictly for educational purposes.

OGameX is under active development with several core features already implemented:

• Basic registration and login
• Planet creation and resource management (metal, crystal, deuterium, energy)
• Building and updating resources, facilities, shipyards, and defenses
• Basic galaxy overview
• Planet switching
• Highscore system
• Basic messages system
• Fleet dispatch missions
  • Transport
  • Deployment
  • Colonisation
• Basic admin panel

New features are continuously being added. Upcoming features:

• Remaining fleet dispatch missions (espionage, recycling, attack, ACS)
• Battlesystem
• Support for Moons
  • Moon destruction fleet dispatch mission
• Alliance system
• Improve galaxy overview
• Improve message system

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.

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.

The easiest way to get OGameX up and running on your own machine is by running the Docker containers via the docker-compose.yml file that is supplied in this repository.

Alternatively, you can also deploy this project manually on any host that supports at least the following:

• PHP >= 8.2
• MySQL/MariaDB
• Ability to enable specific PHP extensions (Ctype, cURL, DOM, Fileinfo and more...)

See the full list of requirements for Laravel 11.x and how to deploy to a server here: https://laravel.com/docs/11.x/deployment.

For local development you can run 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.

1. Clone the repository.
2. Copy .env.example to .env.
3. Launch the project using Docker Compose:

$ docker compose up -d

Note: The default setup binds to ports 80/443. Modify docker-compose.yml if needed.

4. Access the "ogame-app" Docker container:

$ docker exec -it ogame-app /bin/bash

5. Run Laravel setup commands to download composer dependencies, generate an encryption key and prepare the database:

$ composer install
$ php artisan key:generate
$ php artisan migrate

After completing the setup, visit http://localhost to access OGameX. You first need to create an account (no email validation), afterwards you can login using that account.

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

Caution: the production configuration is not yet fully optimized and should be used with caution. As an example, the database root user uses a default password which should be changed to something unique. You should review all settings before deploying this project to a publicly accessible server.

1. Clone the repository.
2. Copy .env.example-prod to .env.
3. Launch the project using Docker Compose:

$ docker compose -f docker-compose.prod.yml up -d --build --force-recreate

Note: The default setup binds to ports 80/443. Modify docker-compose.yml if needed.

4. Access the "ogame-app" Docker container:

$ docker exec -it ogame-app /bin/bash

5. Run Laravel setup commands to download composer dependencies, generate an encryption key, cache configuration and prepare the database:

$ composer install --no-dev
$ php artisan key:generate
$ php artisan migrate --force
$ php artisan cache:clear && php artisan config:cache && php artisan route:cache && php artisan view:cache

After completing the setup, visit http://localhost to access OGameX. You first need to create an account (no email validation), afterwards you can login using that account.

• Admin account: By default, the first registered user is assigned the admin role which can see the admin bar and is able to change server settings. You can also assign the admin role manually via the command line:

  $ php artisan ogamex:assign-admin-role {username}
  

  To remove the admin role from a user, use the following command:

    $ php artisan ogamex:remove-admin-role {username}
  

Encountered issues? Open a ticket on GitHub.

The OGameX Laravel source code is open-source software licensed under the MIT license. See the LICENSE file for more details. All rights and concepts related to OGame are owned by GameForge GmbH.