From c37d3db024ab3f013e3799c28a7ecf0a21a1ce02 Mon Sep 17 00:00:00 2001 From: DevGeniusCode <136935333+DevGeniusCode@users.noreply.github.com> Date: Wed, 26 Mar 2025 03:52:55 +0200 Subject: [PATCH 01/11] Update README.md --- README.md | 98 +++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 70 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 4c2482604f..dd80197892 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,91 @@ +![Generals Game Code Logo](path/to/logo.png) -# Command & Conquer Generals (inc. Zero Hour) Source Code +[Build Status][badge 2][Discord][badge 3][Xezon youtube] -This repository includes source code for Command & Conquer Generals, and its expansion pack Zero Hour. This release provides support to the Steam Workshop for both games ([C&C Generals](https://steamcommunity.com/workshop/browse/?appid=2229870) and [C&C Generals - Zero Hour](https://steamcommunity.com/workshop/browse/?appid=2732960)). +# Welcome to the Generals Game Code Project +GeneralsGameCode is a community-driven project aimed at maintaining and improving the classic RTS game, *Command & +Conquer: Generals* and its expansion *Zero Hour*. This repository contains the source code for both the original game +and *Zero Hour*, with a primary focus on *Zero Hour*. -## Dependencies +Additionally, there is a separate repository for managing game assets such as graphics, localization files, and more. -If you wish to rebuild the source code and tools successfully you will need to find or write new replacements (or remove the code using them entirely) for the following libraries; +## Project Overview -- DirectX SDK (Version 9.0 or higher) (expected path `\Code\Libraries\DirectX\`) -- STLport (4.5.3) - (expected path `\Code\Libraries\STLport-4.5.3`) -- 3DSMax 4 SDK - (expected path `\Code\Libraries\Max4SDK\`) -- NVASM - (expected path `\Code\Tools\NVASM\`) -- BYTEmark - (expected path `\Code\Libraries\Source\Benchmark`) -- RAD Miles Sound System SDK - (expected path `\Code\Libraries\Source\WWVegas\Miles6\`) -- RAD Bink SDK - (expected path `\Code\GameEngineDevice\Include\VideoDevice\Bink`) -- SafeDisk API - (expected path `\Code\GameEngine\Include\Common\SafeDisk` and `\Code\Tools\Launcher\SafeDisk\`) -- Miles Sound System "Asimp3" - (expected path `\Code\Libraries\WPAudio\Asimp3`) -- GameSpy SDK - (expected path `\Code\Libraries\Source\GameSpy\`) -- ZLib (1.1.4) - (expected path `\Code\Libraries\Source\Compression\ZLib\`) -- LZH-Light (1.0) - (expected path `\Code\Libraries\Source\Compression\LZHCompress\CompLibSource` and `CompLibHeader`) +The game was originally developed using Visual Studio 6 and C++98. We've updated the code to be compatible with Visual +Studio 2022 and C++20 to improve the development experience and take advantage of modern C++ features. +The main goal of this project is to fix critical bugs and implement improvements while maintaining compatibility with +the original *Zero Hour* version 1.04 in the initial stages. We'll focus on resolving critical bugs, with future plans +to break compatibility with version 1.04 once the community around the project is established, allowing for further bug +fixes and the addition of new features. -## Compiling (Win32 Only) +## Current Focus and Future Plans -To use the compiled binaries, you must own the game. The C&C Ultimate Collection is available for purchase on [EA App](https://www.ea.com/en-gb/games/command-and-conquer/command-and-conquer-the-ultimate-collection/buy/pc) or [Steam](https://store.steampowered.com/bundle/39394/Command__Conquer_The_Ultimate_Collection/). +This project is in the early stages and heavily work in progress, with ongoing work on bug fixes and enhancements. Here's an overview of our current +focus and future plans -The quickest way to build all configurations in the project is to open `rts.dsw` in Microsoft Visual Studio C++ 6.0 (SP6 recommended for binary matching to Generals patch 1.08 and Zero Hour patch 1.04) and select Build -> Batch Build, then hit the “Rebuild All” button. +- **Modernizing the Codebase**: Transitioning to modern C++ standards and refactoring old code. +- **Critical Bug Fixes**: Fixing game-breaking issues (e.g., fullscreen crash). +- **Minor Bug Fixes**: Addressing minor bugs (e.g., UI issues, graphical glitches). +- **Client-Side Features**: Enhancing the game’s client with features such as an improved replay viewer and UI updates. +- **New Gameplay Features**: Adding new in-game features (e.g., new units, balance changes). +- **Multiplayer Improvements**: Implementing a new game server and an upgraded matchmaking lobby. +- **Community-Driven Improvements**: Once the community grows, we plan to incorporate more features, updates, and + changes based on player feedback. -If you wish to compile the code under a modern version of Microsoft Visual Studio, you can convert the legacy project file to a modern MSVC solution by opening `rts.dsw` in Microsoft Visual Studio .NET 2003, and then opening the newly created project and solution file in MSVC 2015 or newer. +## Running the Game -NOTE: As modern versions of MSVC enforce newer revisions of the C++ standard, you will need to make extensive changes to the codebase before it successfully compiles, even more so if you plan on compiling for the Win64 platform. +To run *Zero Hour* using this project, you need to have the original *Command & Conquer: Generals and Zero Hour* game installed. The +easiest way to get it is through *Command & Conquer The Ultimate Collection* +on [Steam](https://store.steampowered.com/bundle/39394) -When the workspace has finished building, the compiled binaries will be copied to the folder called `/Run/` found in the root of each games directory. +Once the game is ready, download the latest version of the project +from [GitHub Releases](https://github.com/TheSuperHackers/GeneralsGameCode/releases), extract the necessary files, and +follow the instructions in the [Wiki](https://github.com/TheSuperHackers/GeneralsGameCode/wiki). +### Disclaimer -## Known Issues +The current builds may have bugs or unexpected behavior. We will aim to release stable versions that are as free from bugs as possible, +but even those may have some unexpected behaviors. -Windows has a policy where executables that contain words “version”, “update” or “install” in their filename will require UAC Elevation to run. This will affect “versionUpdate” and “buildVersionUpdate” projects from running as post-build events. Renaming the output binary name for these projects to not include these words should resolve the issue for you. +### Anti-virus Warning +Some anti-virus software may mistakenly flag this project as a false positive (e.g., Windows Defender). We assure you +that the project is fully safe to use. However, if you have concerns, you can +always [build it yourself](#building-the-game-yourself). -## STLport -STLport will require changes to successfully compile this source code. The file [stlport.diff](stlport.diff) has been provided for you so you can review and apply these changes. Please make sure you are using STLport 4.5.3 before attempting to apply the patch. +## Joining the Community +You can chat and discuss the development of the project on our [Discord channel](https://discord.gg/yourchannel) or on our [Gamereplays forum](https://www.gamereplays.org/community/index.php?showforum=132). Join us to get the latest updates, report bugs, and contribute to the project! -## License +## Building the Game Yourself -This repository and its contents are licensed under the GPL v3 license, with additional terms applied. Please see [LICENSE.md](LICENSE.md) for details. +We provide support for building the project using Visual Studio 6 (VS6) and Visual Studio 2022. For detailed build instructions, +check the [Wiki](https://github.com/TheSuperHackers/GeneralsGameCode/wiki), which also includes guides for building with Docker, +CLion, and links to forks supporting additional versions. + +If you're interested in testing on other platforms, it's possible to build a standalone binary. Follow the instructions +on the [Wiki](https://github.com/TheSuperHackers/GeneralsGameCode/wiki) for further details. + +## Contributing + +We welcome contributions to the project! If you’re interested in contributing, you should have some knowledge of C++ and +Visual Studio. Join the developer chat on Discord for more information on how to get started. You can also check out +the [Wiki](https://github.com/TheSuperHackers/GeneralsGameCode/wiki) for more detailed documentation. + +## Modding + +Interested in creating your own mods? Check out +our [modding guide](https://github.com/TheSuperHackers/GeneralsGameCode/wiki/Modding). + +## Support + +- Sponsor a server. +- Improve graphic assest. +- More information about donation options [here](https://github.com/TheSuperHackers/GeneralsGameCode/wiki/donation). + +## License & Legal Disclaimer +This project is not affiliated with, nor endorsed by, Electronic Arts in any way. All trademarks are the property of their respective owners. + +This project is licensed under the [GPL-3.0 License](https://www.gnu.org/licenses/gpl-3.0.html), which allows you to freely modify and distribute the source code under the terms of this license. From 7268492166d541da5427ed868a0cebf49b5ca829 Mon Sep 17 00:00:00 2001 From: DevGeniusCode <136935333+DevGeniusCode@users.noreply.github.com> Date: Wed, 26 Mar 2025 05:35:49 +0200 Subject: [PATCH 02/11] Enhance README.md with status and badge updates --- README.md | 59 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 34 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index dd80197892..10b30871da 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,14 @@ -![Generals Game Code Logo](path/to/logo.png) - -[Build Status][badge 2][Discord][badge 3][Xezon youtube] +[![Build Status](https://github.com/TheSuperHackers/GeneralsGameCode/actions/workflows/build-games.yml/badge.svg?branch=main)](https://github.com/TheSuperHackers/GeneralsGameCode/actions/workflows/build-games.yml) +![GitHub Repo stars](https://img.shields.io/github/stars/TheSuperHackers/GeneralsGameCode?style=flat&logo=github&label=Stars&color=%23FFD700) +![Discord](https://img.shields.io/discord/951133504605917224?style=flat&logo=discord&label=Discord&labelColor=%239b8ff2) +![YouTube Channel Views](https://img.shields.io/youtube/channel/views/UCi0AO7Bzth2NN8A9z7Gi40Q?style=flat&logo=youtube&logoColor=red&label=Views&labelColor=%23fcc5c5&color=red) +![Website](https://img.shields.io/website?url=https%3A%2F%2Fwww.gamereplays.org%2F&style=flat&label=GameReplays.org&labelColor=%233d77eb) + +![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/bug?style=flat&label=Bug%20Issues&labelColor=%233d77eb&color=%23fcc5c5) +![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/enhancement?style=flat&label=Enhancement%20Issues&labelColor=%233d77eb&color=%23fcc5c5) +![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/blocker?style=flat&label=Blocker%20Issues&labelColor=%233d77eb&color=%23fcc5c5) +![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/critical?style=flat&label=Critical%20Issues&labelColor=%233d77eb&color=%23fcc5c5) +![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/major?style=flat&label=Major%20Issues&labelColor=%233d77eb&color=%23fcc5c5) # Welcome to the Generals Game Code Project @@ -22,8 +30,8 @@ fixes and the addition of new features. ## Current Focus and Future Plans -This project is in the early stages and heavily work in progress, with ongoing work on bug fixes and enhancements. Here's an overview of our current -focus and future plans +This project is in the early stages and heavily work in progress, with ongoing work on bug fixes and enhancements. +Here's an overview of our current focus and future plans - **Modernizing the Codebase**: Transitioning to modern C++ standards and refactoring old code. - **Critical Bug Fixes**: Fixing game-breaking issues (e.g., fullscreen crash). @@ -36,37 +44,35 @@ focus and future plans ## Running the Game -To run *Zero Hour* using this project, you need to have the original *Command & Conquer: Generals and Zero Hour* game installed. The -easiest way to get it is through *Command & Conquer The Ultimate Collection* -on [Steam](https://store.steampowered.com/bundle/39394) - -Once the game is ready, download the latest version of the project -from [GitHub Releases](https://github.com/TheSuperHackers/GeneralsGameCode/releases), extract the necessary files, and -follow the instructions in the [Wiki](https://github.com/TheSuperHackers/GeneralsGameCode/wiki). +To run *Zero Hour* using this project, you need to have the original *Command & Conquer: Generals and Zero Hour* game +installed. The easiest way to get it is through *Command & Conquer The Ultimate Collection* +on [Steam](https://store.steampowered.com/bundle/39394). Once the game is ready, download the latest version of the +project from [GitHub Releases](https://github.com/TheSuperHackers/GeneralsGameCode/releases), extract the necessary +files, and follow the instructions in the [Wiki](https://github.com/TheSuperHackers/GeneralsGameCode/wiki). ### Disclaimer -The current builds may have bugs or unexpected behavior. We will aim to release stable versions that are as free from bugs as possible, -but even those may have some unexpected behaviors. +The current builds may have bugs or unexpected behavior. We will aim to release stable versions that are as free from +bugs as possible, but even those may have some unexpected behaviors. -### Anti-virus Warning +### Antivirus Warning -Some anti-virus software may mistakenly flag this project as a false positive (e.g., Windows Defender). We assure you +Some antivirus software may mistakenly flag this project as a false positive (e.g., Windows Defender). We assure you that the project is fully safe to use. However, if you have concerns, you can always [build it yourself](#building-the-game-yourself). ## Joining the Community -You can chat and discuss the development of the project on our [Discord channel](https://discord.gg/yourchannel) or on our [Gamereplays forum](https://www.gamereplays.org/community/index.php?showforum=132). Join us to get the latest updates, report bugs, and contribute to the project! +You can chat and discuss the development of the project on our +[Discord channel](https://www.community-outpost.com/discord) or on +our [GameReplays forum](https://www.gamereplays.org/community/index.php?showforum=132). Join us to get the latest +updates, report bugs, and contribute to the project! ## Building the Game Yourself -We provide support for building the project using Visual Studio 6 (VS6) and Visual Studio 2022. For detailed build instructions, -check the [Wiki](https://github.com/TheSuperHackers/GeneralsGameCode/wiki), which also includes guides for building with Docker, -CLion, and links to forks supporting additional versions. - -If you're interested in testing on other platforms, it's possible to build a standalone binary. Follow the instructions -on the [Wiki](https://github.com/TheSuperHackers/GeneralsGameCode/wiki) for further details. +We provide support for building the project using Visual Studio 6 (VS6) and Visual Studio 2022. For detailed build +instructions, check the [Wiki](https://github.com/TheSuperHackers/GeneralsGameCode/wiki//build_guides), which also includes guides +for building with Docker, CLion, and links to forks supporting additional versions. ## Contributing @@ -86,6 +92,9 @@ our [modding guide](https://github.com/TheSuperHackers/GeneralsGameCode/wiki/Mod - More information about donation options [here](https://github.com/TheSuperHackers/GeneralsGameCode/wiki/donation). ## License & Legal Disclaimer -This project is not affiliated with, nor endorsed by, Electronic Arts in any way. All trademarks are the property of their respective owners. -This project is licensed under the [GPL-3.0 License](https://www.gnu.org/licenses/gpl-3.0.html), which allows you to freely modify and distribute the source code under the terms of this license. +This project is not affiliated with, nor endorsed by, Electronic Arts in any way. All trademarks are the property of +their respective owners. + +This project is licensed under the [GPL-3.0 License](https://www.gnu.org/licenses/gpl-3.0.html), which allows you to +freely modify and distribute the source code under the terms of this license. From f57b276ab7ab830f786f2040d4b2b875e1fe99b1 Mon Sep 17 00:00:00 2001 From: DevGeniusCode <136935333+DevGeniusCode@users.noreply.github.com> Date: Wed, 26 Mar 2025 05:42:38 +0200 Subject: [PATCH 03/11] Improved issue badge visibility and repository link --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 10b30871da..95568444ec 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,11 @@ ![YouTube Channel Views](https://img.shields.io/youtube/channel/views/UCi0AO7Bzth2NN8A9z7Gi40Q?style=flat&logo=youtube&logoColor=red&label=Views&labelColor=%23fcc5c5&color=red) ![Website](https://img.shields.io/website?url=https%3A%2F%2Fwww.gamereplays.org%2F&style=flat&label=GameReplays.org&labelColor=%233d77eb) -![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/bug?style=flat&label=Bug%20Issues&labelColor=%233d77eb&color=%23fcc5c5) -![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/enhancement?style=flat&label=Enhancement%20Issues&labelColor=%233d77eb&color=%23fcc5c5) -![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/blocker?style=flat&label=Blocker%20Issues&labelColor=%233d77eb&color=%23fcc5c5) -![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/critical?style=flat&label=Critical%20Issues&labelColor=%233d77eb&color=%23fcc5c5) -![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/major?style=flat&label=Major%20Issues&labelColor=%233d77eb&color=%23fcc5c5) +![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/bug?style=flat&label=Bug%20Issues&labelColor=%23c4c4c4&color=%23424242) +![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/enhancement?style=flat&label=Enhancement%20Issues&labelColo=%23c4c4c4&color=%23424242) +![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/blocker?style=flat&label=Blocker%20Issues&labelColor=%23c4c4c4&color=%23424242) +![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/critical?style=flat&label=Critical%20Issues&labelColor=%23c4c4c4&color=%23424242) +![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/major?style=flat&label=Major%20Issues&labelColor=%23c4c4c4&color=%23424242) # Welcome to the Generals Game Code Project @@ -17,6 +17,7 @@ Conquer: Generals* and its expansion *Zero Hour*. This repository contains the s and *Zero Hour*, with a primary focus on *Zero Hour*. Additionally, there is a separate repository for managing game assets such as graphics, localization files, and more. +You can find it [here](https://github.com/TheSuperHackers/GeneralsGamepatch/) and contribute to it as well. ## Project Overview @@ -97,4 +98,5 @@ This project is not affiliated with, nor endorsed by, Electronic Arts in any way their respective owners. This project is licensed under the [GPL-3.0 License](https://www.gnu.org/licenses/gpl-3.0.html), which allows you to -freely modify and distribute the source code under the terms of this license. +freely modify and distribute the source code under the terms of this license. Please see [LICENSE.md](LICENSE.md) +for details. From b71ac046314fba7ffda86af2c60729cd7d3f2d0b Mon Sep 17 00:00:00 2001 From: DevGeniusCode <136935333+DevGeniusCode@users.noreply.github.com> Date: Wed, 26 Mar 2025 05:53:41 +0200 Subject: [PATCH 04/11] Update README.md with clickable badges --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 95568444ec..d9867c44bf 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ [![Build Status](https://github.com/TheSuperHackers/GeneralsGameCode/actions/workflows/build-games.yml/badge.svg?branch=main)](https://github.com/TheSuperHackers/GeneralsGameCode/actions/workflows/build-games.yml) -![GitHub Repo stars](https://img.shields.io/github/stars/TheSuperHackers/GeneralsGameCode?style=flat&logo=github&label=Stars&color=%23FFD700) -![Discord](https://img.shields.io/discord/951133504605917224?style=flat&logo=discord&label=Discord&labelColor=%239b8ff2) -![YouTube Channel Views](https://img.shields.io/youtube/channel/views/UCi0AO7Bzth2NN8A9z7Gi40Q?style=flat&logo=youtube&logoColor=red&label=Views&labelColor=%23fcc5c5&color=red) -![Website](https://img.shields.io/website?url=https%3A%2F%2Fwww.gamereplays.org%2F&style=flat&label=GameReplays.org&labelColor=%233d77eb) - -![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/bug?style=flat&label=Bug%20Issues&labelColor=%23c4c4c4&color=%23424242) -![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/enhancement?style=flat&label=Enhancement%20Issues&labelColo=%23c4c4c4&color=%23424242) -![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/blocker?style=flat&label=Blocker%20Issues&labelColor=%23c4c4c4&color=%23424242) -![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/critical?style=flat&label=Critical%20Issues&labelColor=%23c4c4c4&color=%23424242) -![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/major?style=flat&label=Major%20Issues&labelColor=%23c4c4c4&color=%23424242) +[![GitHub Repo stars](https://img.shields.io/github/stars/TheSuperHackers/GeneralsGameCode?style=flat&logo=github&label=Stars&color=%23FFD700)](https://github.com/TheSuperHackers/GeneralsGameCode) +[![Discord](https://img.shields.io/discord/951133504605917224?style=flat&logo=discord&label=Discord&labelColor=%239b8ff2)](https://www.community-outpost.com/discord) +[![YouTube Channel Views](https://img.shields.io/youtube/channel/views/UCi0AO7Bzth2NN8A9z7Gi40Q?style=flat&logo=youtube&logoColor=red&label=Views&labelColor=%23fcc5c5&color=red)](https://www.youtube.com/@xezon0/videos) +[![Website](https://img.shields.io/website?url=https%3A%2F%2Fwww.gamereplays.org%2F&style=flat&label=GameReplays.org&labelColor=%233d77eb)](https://www.gamereplays.org/community/-cnc_zero_hour-Section.html) + +[![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/bug?style=flat&label=Bug%20Issues&labelColor=%23c4c4c4&color=%23424242)](https://github.com/TheSuperHackers/GeneralsGameCode/issues?q=label%3ABug) +[![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/enhancement?style=flat&label=Enhancement%20Issues&labelColo=%23c4c4c4&color=%23424242)](https://github.com/TheSuperHackers/GeneralsGameCode/issues?q=label%3AEnhancement) +[![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/blocker?style=flat&label=Blocker%20Issues&labelColor=%23c4c4c4&color=%23424242)](https://github.com/TheSuperHackers/GeneralsGameCode/issues?q=label%3ABlocker) +[![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/critical?style=flat&label=Critical%20Issues&labelColor=%23c4c4c4&color=%23424242)](https://github.com/TheSuperHackers/GeneralsGameCode/issues?q=label%3ACritical) +[![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/major?style=flat&label=Major%20Issues&labelColor=%23c4c4c4&color=%23424242)](https://github.com/TheSuperHackers/GeneralsGameCode/issues?q=label%3AMajor) # Welcome to the Generals Game Code Project From 7df07dba3c132c0e14547a2828e0e67082da1a0f Mon Sep 17 00:00:00 2001 From: DevGeniusCode <136935333+DevGeniusCode@users.noreply.github.com> Date: Wed, 26 Mar 2025 15:31:50 +0200 Subject: [PATCH 05/11] Fix repository link in README.md and enhance contribution guidelines --- README.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index d9867c44bf..3488ad8b19 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ [![Build Status](https://github.com/TheSuperHackers/GeneralsGameCode/actions/workflows/build-games.yml/badge.svg?branch=main)](https://github.com/TheSuperHackers/GeneralsGameCode/actions/workflows/build-games.yml) [![GitHub Repo stars](https://img.shields.io/github/stars/TheSuperHackers/GeneralsGameCode?style=flat&logo=github&label=Stars&color=%23FFD700)](https://github.com/TheSuperHackers/GeneralsGameCode) -[![Discord](https://img.shields.io/discord/951133504605917224?style=flat&logo=discord&label=Discord&labelColor=%239b8ff2)](https://www.community-outpost.com/discord) -[![YouTube Channel Views](https://img.shields.io/youtube/channel/views/UCi0AO7Bzth2NN8A9z7Gi40Q?style=flat&logo=youtube&logoColor=red&label=Views&labelColor=%23fcc5c5&color=red)](https://www.youtube.com/@xezon0/videos) +[![Discord](https://img.shields.io/discord/951133504605917224?style=flat&logo=discord&logoColor=6A5ACD&label=Discord&labelColor=D0CBEF&color=6A5ACD)](https://www.community-outpost.com/discord) +[![YouTube Channel Views](https://img.shields.io/youtube/channel/views/UCi0AO7Bzth2NN8A9z7Gi40Q?style=flat&logo=youtube&logoColor=red&label=Views&labelColor=FFBCBC&color=red)](https://www.youtube.com/@xezon0/videos) [![Website](https://img.shields.io/website?url=https%3A%2F%2Fwww.gamereplays.org%2F&style=flat&label=GameReplays.org&labelColor=%233d77eb)](https://www.gamereplays.org/community/-cnc_zero_hour-Section.html) [![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/bug?style=flat&label=Bug%20Issues&labelColor=%23c4c4c4&color=%23424242)](https://github.com/TheSuperHackers/GeneralsGameCode/issues?q=label%3ABug) @@ -17,7 +17,7 @@ Conquer: Generals* and its expansion *Zero Hour*. This repository contains the s and *Zero Hour*, with a primary focus on *Zero Hour*. Additionally, there is a separate repository for managing game assets such as graphics, localization files, and more. -You can find it [here](https://github.com/TheSuperHackers/GeneralsGamepatch/) and contribute to it as well. +You can find it [here](https://github.com/TheSuperHackers/GeneralsGamePatch/) and contribute to it as well. ## Project Overview @@ -37,9 +37,12 @@ Here's an overview of our current focus and future plans - **Modernizing the Codebase**: Transitioning to modern C++ standards and refactoring old code. - **Critical Bug Fixes**: Fixing game-breaking issues (e.g., fullscreen crash). - **Minor Bug Fixes**: Addressing minor bugs (e.g., UI issues, graphical glitches). +- **Cross-Platform Support**: Adding support for more platforms (e.g., Linux, macOS). +- **Engine Improvements**: Enhancing the game engine to improve performance and stability. - **Client-Side Features**: Enhancing the game’s client with features such as an improved replay viewer and UI updates. - **New Gameplay Features**: Adding new in-game features (e.g., new units, balance changes). - **Multiplayer Improvements**: Implementing a new game server and an upgraded matchmaking lobby. +- **Tooling Improvements**: Developing new or improving existing tools for modding and game development. - **Community-Driven Improvements**: Once the community grows, we plan to incorporate more features, updates, and changes based on player feedback. @@ -78,7 +81,8 @@ for building with Docker, CLion, and links to forks supporting additional versio ## Contributing We welcome contributions to the project! If you’re interested in contributing, you should have some knowledge of C++ and -Visual Studio. Join the developer chat on Discord for more information on how to get started. You can also check out +Visual Studio. We also allow this to be built without Visual Studio. Join the developer chat on Discord for more +information on how to get started. You can also check out the [Wiki](https://github.com/TheSuperHackers/GeneralsGameCode/wiki) for more detailed documentation. ## Modding @@ -86,12 +90,6 @@ the [Wiki](https://github.com/TheSuperHackers/GeneralsGameCode/wiki) for more de Interested in creating your own mods? Check out our [modding guide](https://github.com/TheSuperHackers/GeneralsGameCode/wiki/Modding). -## Support - -- Sponsor a server. -- Improve graphic assest. -- More information about donation options [here](https://github.com/TheSuperHackers/GeneralsGameCode/wiki/donation). - ## License & Legal Disclaimer This project is not affiliated with, nor endorsed by, Electronic Arts in any way. All trademarks are the property of From f310e3535d41f32f17bec4ccf59b13d7e79c19a3 Mon Sep 17 00:00:00 2001 From: DevGeniusCode <136935333+DevGeniusCode@users.noreply.github.com> Date: Wed, 26 Mar 2025 18:00:25 +0200 Subject: [PATCH 06/11] Refine README.md for clarity and legal disclaimer updates --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3488ad8b19..4acebbb502 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,7 @@ # Welcome to the Generals Game Code Project GeneralsGameCode is a community-driven project aimed at maintaining and improving the classic RTS game, *Command & -Conquer: Generals* and its expansion *Zero Hour*. This repository contains the source code for both the original game -and *Zero Hour*, with a primary focus on *Zero Hour*. +Conquer: Generals* and its expansion *Zero Hour*. This repository contains the source code for both games, with a primary focus on *Zero Hour*. Additionally, there is a separate repository for managing game assets such as graphics, localization files, and more. You can find it [here](https://github.com/TheSuperHackers/GeneralsGamePatch/) and contribute to it as well. @@ -22,7 +21,7 @@ You can find it [here](https://github.com/TheSuperHackers/GeneralsGamePatch/) an ## Project Overview The game was originally developed using Visual Studio 6 and C++98. We've updated the code to be compatible with Visual -Studio 2022 and C++20 to improve the development experience and take advantage of modern C++ features. +Studio 2022 and C++20. The main goal of this project is to fix critical bugs and implement improvements while maintaining compatibility with the original *Zero Hour* version 1.04 in the initial stages. We'll focus on resolving critical bugs, with future plans @@ -92,8 +91,8 @@ our [modding guide](https://github.com/TheSuperHackers/GeneralsGameCode/wiki/Mod ## License & Legal Disclaimer -This project is not affiliated with, nor endorsed by, Electronic Arts in any way. All trademarks are the property of -their respective owners. +This project is not affiliated with, nor endorsed by, Electronic Arts in any way. EA has not endorsed and does not +support this product. All trademarks are the property of their respective owners. This project is licensed under the [GPL-3.0 License](https://www.gnu.org/licenses/gpl-3.0.html), which allows you to freely modify and distribute the source code under the terms of this license. Please see [LICENSE.md](LICENSE.md) From bb230656428be66cae5b775fbb2a8aebf3dd89ab Mon Sep 17 00:00:00 2001 From: DevGeniusCode <136935333+DevGeniusCode@users.noreply.github.com> Date: Wed, 26 Mar 2025 18:02:05 +0200 Subject: [PATCH 07/11] Improve formatting in README.md for better readability --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4acebbb502..657c947f87 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,8 @@ # Welcome to the Generals Game Code Project GeneralsGameCode is a community-driven project aimed at maintaining and improving the classic RTS game, *Command & -Conquer: Generals* and its expansion *Zero Hour*. This repository contains the source code for both games, with a primary focus on *Zero Hour*. +Conquer: Generals* and its expansion *Zero Hour*. This repository contains the source code for both games, with a +primary focus on *Zero Hour*. Additionally, there is a separate repository for managing game assets such as graphics, localization files, and more. You can find it [here](https://github.com/TheSuperHackers/GeneralsGamePatch/) and contribute to it as well. @@ -74,8 +75,8 @@ updates, report bugs, and contribute to the project! ## Building the Game Yourself We provide support for building the project using Visual Studio 6 (VS6) and Visual Studio 2022. For detailed build -instructions, check the [Wiki](https://github.com/TheSuperHackers/GeneralsGameCode/wiki//build_guides), which also includes guides -for building with Docker, CLion, and links to forks supporting additional versions. +instructions, check the [Wiki](https://github.com/TheSuperHackers/GeneralsGameCode/wiki//build_guides), which also +includes guides for building with Docker, CLion, and links to forks supporting additional versions. ## Contributing From ea1f7a63b7ea070fdc829779e3030f432e7c8d4f Mon Sep 17 00:00:00 2001 From: DevGeniusCode <136935333+DevGeniusCode@users.noreply.github.com> Date: Wed, 26 Mar 2025 19:05:56 +0200 Subject: [PATCH 08/11] Update README.md to replace outdated badges and improve visibility --- README.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/README.md b/README.md index 657c947f87..93cdaa3092 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,6 @@ [![Build Status](https://github.com/TheSuperHackers/GeneralsGameCode/actions/workflows/build-games.yml/badge.svg?branch=main)](https://github.com/TheSuperHackers/GeneralsGameCode/actions/workflows/build-games.yml) [![GitHub Repo stars](https://img.shields.io/github/stars/TheSuperHackers/GeneralsGameCode?style=flat&logo=github&label=Stars&color=%23FFD700)](https://github.com/TheSuperHackers/GeneralsGameCode) -[![Discord](https://img.shields.io/discord/951133504605917224?style=flat&logo=discord&logoColor=6A5ACD&label=Discord&labelColor=D0CBEF&color=6A5ACD)](https://www.community-outpost.com/discord) -[![YouTube Channel Views](https://img.shields.io/youtube/channel/views/UCi0AO7Bzth2NN8A9z7Gi40Q?style=flat&logo=youtube&logoColor=red&label=Views&labelColor=FFBCBC&color=red)](https://www.youtube.com/@xezon0/videos) -[![Website](https://img.shields.io/website?url=https%3A%2F%2Fwww.gamereplays.org%2F&style=flat&label=GameReplays.org&labelColor=%233d77eb)](https://www.gamereplays.org/community/-cnc_zero_hour-Section.html) - +[![GitHub Release](https://img.shields.io/github/v/release/TheSuperHackers/GeneralsGameCode?include_prereleases&sort=date&display_name=tag&style=flat&label=Release)](https://github.com/TheSuperHackers/GeneralsGameCode/releases) [![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/bug?style=flat&label=Bug%20Issues&labelColor=%23c4c4c4&color=%23424242)](https://github.com/TheSuperHackers/GeneralsGameCode/issues?q=label%3ABug) [![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/enhancement?style=flat&label=Enhancement%20Issues&labelColo=%23c4c4c4&color=%23424242)](https://github.com/TheSuperHackers/GeneralsGameCode/issues?q=label%3AEnhancement) [![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/blocker?style=flat&label=Blocker%20Issues&labelColor=%23c4c4c4&color=%23424242)](https://github.com/TheSuperHackers/GeneralsGameCode/issues?q=label%3ABlocker) From a4f97e6006d4695147dc7b653f80ccb282c5d096 Mon Sep 17 00:00:00 2001 From: DevGeniusCode <136935333+DevGeniusCode@users.noreply.github.com> Date: Thu, 27 Mar 2025 01:23:32 +0200 Subject: [PATCH 09/11] Fix broken link in README.md for build instructions --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 93cdaa3092..23d928e7c3 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ updates, report bugs, and contribute to the project! ## Building the Game Yourself We provide support for building the project using Visual Studio 6 (VS6) and Visual Studio 2022. For detailed build -instructions, check the [Wiki](https://github.com/TheSuperHackers/GeneralsGameCode/wiki//build_guides), which also +instructions, check the [Wiki](https://github.com/TheSuperHackers/GeneralsGameCode/wiki/build_guides), which also includes guides for building with Docker, CLion, and links to forks supporting additional versions. ## Contributing From 4e64ce631ff54e819a52b289ab6434020a3c11d2 Mon Sep 17 00:00:00 2001 From: DevGeniusCode <136935333+DevGeniusCode@users.noreply.github.com> Date: Fri, 28 Mar 2025 22:20:36 +0300 Subject: [PATCH 10/11] Refactor README.md for improved clarity and conciseness --- README.md | 28 +++++----------------------- 1 file changed, 5 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 23d928e7c3..61e7896504 100644 --- a/README.md +++ b/README.md @@ -51,23 +51,11 @@ on [Steam](https://store.steampowered.com/bundle/39394). Once the game is ready, project from [GitHub Releases](https://github.com/TheSuperHackers/GeneralsGameCode/releases), extract the necessary files, and follow the instructions in the [Wiki](https://github.com/TheSuperHackers/GeneralsGameCode/wiki). -### Disclaimer - -The current builds may have bugs or unexpected behavior. We will aim to release stable versions that are as free from -bugs as possible, but even those may have some unexpected behaviors. - -### Antivirus Warning - -Some antivirus software may mistakenly flag this project as a false positive (e.g., Windows Defender). We assure you -that the project is fully safe to use. However, if you have concerns, you can -always [build it yourself](#building-the-game-yourself). ## Joining the Community -You can chat and discuss the development of the project on our -[Discord channel](https://www.community-outpost.com/discord) or on -our [GameReplays forum](https://www.gamereplays.org/community/index.php?showforum=132). Join us to get the latest -updates, report bugs, and contribute to the project! +You can chat and discuss the development of the project on our [Discord channel](https://www.community-outpost.com/discord) to get the latest updates, +report bugs, and contribute to the project! ## Building the Game Yourself @@ -77,20 +65,14 @@ includes guides for building with Docker, CLion, and links to forks supporting a ## Contributing -We welcome contributions to the project! If you’re interested in contributing, you should have some knowledge of C++ and -Visual Studio. We also allow this to be built without Visual Studio. Join the developer chat on Discord for more -information on how to get started. You can also check out +We welcome contributions to the project! If you’re interested in contributing, you should have knowledge of C++. Join +the developer chat on Discord for more information on how to get started. You can also check out the [Wiki](https://github.com/TheSuperHackers/GeneralsGameCode/wiki) for more detailed documentation. -## Modding - -Interested in creating your own mods? Check out -our [modding guide](https://github.com/TheSuperHackers/GeneralsGameCode/wiki/Modding). ## License & Legal Disclaimer -This project is not affiliated with, nor endorsed by, Electronic Arts in any way. EA has not endorsed and does not -support this product. All trademarks are the property of their respective owners. +EA has not endorsed and does not support this product. All trademarks are the property of their respective owners. This project is licensed under the [GPL-3.0 License](https://www.gnu.org/licenses/gpl-3.0.html), which allows you to freely modify and distribute the source code under the terms of this license. Please see [LICENSE.md](LICENSE.md) From 9ea4befe299567cf5da949c7ebba984bada75f2a Mon Sep 17 00:00:00 2001 From: DevGeniusCode <136935333+DevGeniusCode@users.noreply.github.com> Date: Wed, 30 Apr 2025 11:51:49 +0300 Subject: [PATCH 11/11] add milestone badges and improve issue tracking visibility, and add CONTRIBUTING.md reference. --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 61e7896504..201f1de4f1 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,15 @@ -[![Build Status](https://github.com/TheSuperHackers/GeneralsGameCode/actions/workflows/build-games.yml/badge.svg?branch=main)](https://github.com/TheSuperHackers/GeneralsGameCode/actions/workflows/build-games.yml) -[![GitHub Repo stars](https://img.shields.io/github/stars/TheSuperHackers/GeneralsGameCode?style=flat&logo=github&label=Stars&color=%23FFD700)](https://github.com/TheSuperHackers/GeneralsGameCode) [![GitHub Release](https://img.shields.io/github/v/release/TheSuperHackers/GeneralsGameCode?include_prereleases&sort=date&display_name=tag&style=flat&label=Release)](https://github.com/TheSuperHackers/GeneralsGameCode/releases) +![GitHub milestone details](https://img.shields.io/github/milestones/progress-percent/TheSuperHackers/GeneralsGameCode/3) +![GitHub milestone details](https://img.shields.io/github/milestones/progress-percent/TheSuperHackers/GeneralsGameCode/1) +![GitHub milestone details](https://img.shields.io/github/milestones/progress-percent/TheSuperHackers/GeneralsGameCode/4) +![GitHub milestone details](https://img.shields.io/github/milestones/progress-percent/TheSuperHackers/GeneralsGameCode/5) +![GitHub milestone details](https://img.shields.io/github/milestones/progress-percent/TheSuperHackers/GeneralsGameCode/6) + [![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/bug?style=flat&label=Bug%20Issues&labelColor=%23c4c4c4&color=%23424242)](https://github.com/TheSuperHackers/GeneralsGameCode/issues?q=label%3ABug) -[![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/enhancement?style=flat&label=Enhancement%20Issues&labelColo=%23c4c4c4&color=%23424242)](https://github.com/TheSuperHackers/GeneralsGameCode/issues?q=label%3AEnhancement) -[![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/blocker?style=flat&label=Blocker%20Issues&labelColor=%23c4c4c4&color=%23424242)](https://github.com/TheSuperHackers/GeneralsGameCode/issues?q=label%3ABlocker) -[![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/critical?style=flat&label=Critical%20Issues&labelColor=%23c4c4c4&color=%23424242)](https://github.com/TheSuperHackers/GeneralsGameCode/issues?q=label%3ACritical) +[![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/enhancement?style=flat&label=Enhancement%20Issues&labelColor=%23c4c4c4&color=%23424242)](https://github.com/TheSuperHackers/GeneralsGameCode/issues?q=label%3AEnhancement) [![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/major?style=flat&label=Major%20Issues&labelColor=%23c4c4c4&color=%23424242)](https://github.com/TheSuperHackers/GeneralsGameCode/issues?q=label%3AMajor) +[![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/critical?style=flat&label=Critical%20Issues&labelColor=%23c4c4c4&color=%23424242)](https://github.com/TheSuperHackers/GeneralsGameCode/issues?q=label%3ACritical) +[![GitHub issues by-label](https://img.shields.io/github/issues/TheSuperHackers/GeneralsGameCode/blocker?style=flat&label=Blocker%20Issues&labelColor=%23c4c4c4&color=%23424242)](https://github.com/TheSuperHackers/GeneralsGameCode/issues?q=label%3ABlocker) # Welcome to the Generals Game Code Project @@ -66,7 +70,8 @@ includes guides for building with Docker, CLion, and links to forks supporting a ## Contributing We welcome contributions to the project! If you’re interested in contributing, you should have knowledge of C++. Join -the developer chat on Discord for more information on how to get started. You can also check out +the developer chat on Discord for more information on how to get started. Please make sure to read our +[Contributing Guidelines](CONTRIBUTING.md) before submitting a pull request. You can also check out the [Wiki](https://github.com/TheSuperHackers/GeneralsGameCode/wiki) for more detailed documentation.