From 93082071f6ac28ec47c5b564f8df694f997a331a Mon Sep 17 00:00:00 2001 From: Leendert de Borst Date: Sun, 6 Oct 2024 15:36:19 +0200 Subject: [PATCH 1/2] Update readme for new version --- README.md | 65 +++++++++++++++++++++++++----- config/app.php | 2 +- docs/prepare-new-github-release.md | 12 ++++++ 3 files changed, 67 insertions(+), 12 deletions(-) create mode 100644 docs/prepare-new-github-release.md diff --git a/README.md b/README.md index e43b8e05..d908d726 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ Disclaimer: this project is purely fan-based and does not contain any commercial ## 🖥️ Live demo - Main branch (nightly builds): [https://main.ogamex.dev](https://main.ogamex.dev) -- Latest stable release **(0.7.0)**: [https://release.ogamex.dev](https://release.ogamex.dev) +- Latest stable release **(0.8.0)**: [https://release.ogamex.dev](https://release.ogamex.dev) ## 📝 Table of Contents - [1. Example screenshots](#screenshots) @@ -43,7 +43,8 @@ Disclaimer: this project is purely fan-based and does not contain any commercial - [b) Production: Install OGameX using Docker](#production) - [c) Tips for initial setup](#tips-for-initial-setup) - [8. Support](#support) -- [9. License](#license) +- [9. Sponsorship](#sponsorship) +- [10. License](#license) ## 🖥️ Example screenshots Screenshot 2024-04-28 at 16 57 38 @@ -62,35 +63,34 @@ The primary goal of this fan-based project is to engineer a faithful rendition o OGameX is under active development with several core features already implemented: -- Basic registration and login -- Planet creation and resource management (metal, crystal, deuterium, energy) +- Registration and login +- Planets and resource management (metal, crystal, deuterium, energy) - Building and updating resources, facilities, shipyards, and defenses -- Basic galaxy overview +- Galaxy overview - Planet switching - Highscore system -- Basic messages system +- Messages system - Battle system +- Basic admin panel - Fleet dispatch missions - Transport - Deployment - Colonisation - Espionage - Attack -- Basic admin panel + - Recycle ### a) Upcoming Features New features are continuously being added. Upcoming major features: -- Recycle fleet dispatch mission - Support for Moons - Moon creation through debris field after battle - Moon buildings - Phalanx - Moon destruction fleet dispatch mission -- ACS fleet dispatch missions - Alliance system -- Improve galaxy overview -- Improve message system +- ACS fleet dispatch missions + ## 🚀 Contributing @@ -120,7 +120,16 @@ See the full list of requirements for Laravel 11.x and how to deploy to a server 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. + ``` + $ git clone https://github.com/lanedirt/OGameX.git + $ cd OGameX + ``` + 2. Copy `.env.example` to `.env`. + ``` + $ cp .env.example .env + ``` + 3. Launch the project using Docker Compose: ``` $ docker compose up -d @@ -149,7 +158,16 @@ several performance optimizations and security settings that are not present in You should review all settings before deploying this project to a publicly accessible server. 1. Clone the repository. + ``` + $ git clone https://github.com/lanedirt/OGameX.git + $ cd OGameX + ``` + 2. Copy `.env.example-prod` to `.env`. + ``` + $ cp .env.example-prod .env + ``` + 3. Launch the project using Docker Compose: ``` $ docker compose -f docker-compose.prod.yml up -d --build --force-recreate @@ -186,6 +204,31 @@ After completing the setup, visit https://localhost to access OGameX. You first Did you encounter issues in this project? Please open a ticket on GitHub and we'll try to help you out as soon as possible. +## 💰 Sponsorship +We thank the following parties for sponsoring this project: + + + + + + + +
+ + JetBrains Logo + +
+ JetBrains +
+ Providing free open-source licenses for PhpStorm, WebStorm, and DataGrip. + 		+ + + +
+ +Interested in supporting OGameX? We welcome sponsorships of all sizes! Your support helps us maintain and improve this open-source project. Please get in touch with us via GitHub or Discord to discuss sponsorship opportunities. + ## 📰 License 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. diff --git a/config/app.php b/config/app.php index 645bd073..496b7533 100644 --- a/config/app.php +++ b/config/app.php @@ -128,5 +128,5 @@ | Custom OGameX app settings |-------------------------------------------------------------------------- */ - 'version' => '0.7.0', + 'version' => '0.8.0', ]; diff --git a/docs/prepare-new-github-release.md b/docs/prepare-new-github-release.md new file mode 100644 index 00000000..21a265f0 --- /dev/null +++ b/docs/prepare-new-github-release.md @@ -0,0 +1,12 @@ +# Release Preparation Checklist + +Follow the steps in the checklist below to prepare a new release for the GitHub repository. + +- [ ] Update ./README.md and set version in line Latest stable release **(0.7.0)**: to the new version. +- [ ] Update ./config/app.php and set 'version' => '0.7.0' to the new version. +- [ ] Update README screenshots if applicable +- [ ] Update README current/upcoming features + +Optional steps: +- [ ] Update docker instructions if any changes have been made to the docker setup +- [ ] Update README with sponsorship info if sponsorship has been added \ No newline at end of file From 1a68caf79dd564a436395d8d136d10678c32cd98 Mon Sep 17 00:00:00 2001 From: Leendert de Borst <6917405+lanedirt@users.noreply.github.com> Date: Sun, 6 Oct 2024 15:45:07 +0200 Subject: [PATCH 2/2] Update screenshots in README --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d908d726..d4bb866e 100644 --- a/README.md +++ b/README.md @@ -47,9 +47,13 @@ Disclaimer: this project is purely fan-based and does not contain any commercial - [10. License](#license) ## 🖥️ Example screenshots -Screenshot 2024-04-28 at 16 57 38 -Screenshot 2024-04-28 at 16 57 09 -Screenshot 2024-04-28 at 16 58 08 + + +Screenshot 2024-10-06 at 15 41 14 +Screenshot 2024-10-06 at 15 41 45 +Screenshot 2024-10-06 at 15 42 05 +Screenshot 2024-10-06 at 15 42 44 +Screenshot 2024-10-06 at 15 43 18 ## ✨ About the author