Update README.md #515
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,49 +1,100 @@ | ||
| [](https://github.com/TheSuperHackers/GeneralsGameCode/actions/workflows/build-games.yml) | ||
| [](https://github.com/TheSuperHackers/GeneralsGameCode) | ||
| [](https://www.community-outpost.com/discord) | ||
| [](https://www.youtube.com/@xezon0/videos) | ||
| [](https://www.gamereplays.org/community/-cnc_zero_hour-Section.html) | ||
DevGeniusCode marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| [](https://github.com/TheSuperHackers/GeneralsGameCode/issues?q=label%3ABug) | ||
| [](https://github.com/TheSuperHackers/GeneralsGameCode/issues?q=label%3AEnhancement) | ||
| [](https://github.com/TheSuperHackers/GeneralsGameCode/issues?q=label%3ABlocker) | ||
| [](https://github.com/TheSuperHackers/GeneralsGameCode/issues?q=label%3ACritical) | ||
| [](https://github.com/TheSuperHackers/GeneralsGameCode/issues?q=label%3AMajor) | ||
|
|
||
| # Welcome to the Generals Game Code Project | ||
|
|
||
| GeneralsGameCode is a community-driven project aimed at maintaining and improving the classic RTS game, *Command & | ||
DevGeniusCode marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Conquer: Generals* and its expansion *Zero Hour*. This repository contains the source code for both the original game | ||
DevGeniusCode marked this conversation as resolved.
Show resolved
Hide resolved
DevGeniusCode marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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 | ||
|
|
||
| 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. | ||
DevGeniusCode marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| 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. | ||
|
|
||
| ## 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 | ||
DevGeniusCode marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| - **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). | ||
|
There was a problem hiding this comment. I'd take this out or explicitely state that it's a future goal. I will probably be years before we get to this There was a problem hiding this comment. (This was just regarding the There was a problem hiding this comment. New units and balance changes also refers to game data, not game code, so it does not fit here. There was a problem hiding this comment. Can we remove this? I think it must be removed because this line will make the competitive community jump fences. |
||
| - **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. | ||
|
|
||
| ## 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). | ||
|
|
||
| ### Disclaimer | ||
|
|
||
| The current builds may have bugs or unexpected behavior. We will aim to release stable versions that are as free from | ||
DevGeniusCode marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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 | ||
DevGeniusCode marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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 | ||
DevGeniusCode marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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. | ||
|
|
||
| ## Contributing | ||
|
|
||
| We welcome contributions to the project! If you’re interested in contributing, you should have some knowledge of C++ and | ||
DevGeniusCode marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Visual Studio. We also allow this to be built without Visual Studio. Join the developer chat on Discord for more | ||
DevGeniusCode marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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). | ||
DevGeniusCode marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## License & Legal Disclaimer | ||
|
|
||
| This project is not affiliated with, nor endorsed by, Electronic Arts in any way. All trademarks are the property of | ||
DevGeniusCode marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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) | ||
| for details. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.