forked from electronicarts/CnC_Generals_Zero_Hour
-
Notifications
You must be signed in to change notification settings - Fork 140
Update README.md #515
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Update README.md #515
Changes from 8 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
c37d3db
Update README.md
DevGeniusCode 7268492
Enhance README.md with status and badge updates
DevGeniusCode f57b276
Improved issue badge visibility and repository link
DevGeniusCode b71ac04
Update README.md with clickable badges
DevGeniusCode 7df07db
Fix repository link in README.md and enhance contribution guidelines
DevGeniusCode f310e35
Refine README.md for clarity and legal disclaimer updates
DevGeniusCode bb23065
Improve formatting in README.md for better readability
DevGeniusCode ea1f7a6
Update README.md to replace outdated badges and improve visibility
DevGeniusCode a4f97e6
Fix broken link in README.md for build instructions
DevGeniusCode 4e64ce6
Refactor README.md for improved clarity and conciseness
DevGeniusCode 9ea4bef
add milestone badges and improve issue tracking visibility, and add C…
DevGeniusCode 7a8ad73
Clean up redundancies, mention Generals, remove wrong info, small tweaks
xezon File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,97 @@ | ||
| [](https://github.com/TheSuperHackers/GeneralsGameCode/actions/workflows/build-games.yml) | ||
| [](https://github.com/TheSuperHackers/GeneralsGameCode) | ||
| [](https://github.com/TheSuperHackers/GeneralsGameCode/releases) | ||
| [](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) | ||
|
|
||
| # Command & Conquer Generals (inc. Zero Hour) Source Code | ||
| # Welcome to the Generals Game Code Project | ||
|
|
||
| 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)). | ||
| 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*. | ||
|
|
||
| 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. | ||
|
|
||
| ## Dependencies | ||
| ## Project Overview | ||
|
|
||
| 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; | ||
| 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. | ||
|
|
||
| - 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 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 | ||
|
|
||
| ## Compiling (Win32 Only) | ||
| 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
|
||
|
|
||
| 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/). | ||
| - **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). | ||
xezon marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - **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. | ||
|
|
||
| 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. | ||
| ## Running the Game | ||
|
|
||
| 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. | ||
| 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). | ||
|
|
||
| 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. | ||
| ### Disclaimer | ||
|
|
||
| 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. | ||
| 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.
Outdated
Show resolved
Hide resolved
|
||
| bugs as possible, but even those may have some unexpected behaviors. | ||
|
|
||
| ### Antivirus Warning | ||
|
|
||
| ## Known Issues | ||
| 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.
Outdated
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). | ||
|
|
||
| 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. | ||
| ## 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.
Outdated
Show resolved
Hide resolved
|
||
| updates, report bugs, and contribute to the project! | ||
|
|
||
| ## 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. | ||
| ## 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 | ||
DevGeniusCode marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| includes guides for building with Docker, CLion, and links to forks supporting additional versions. | ||
|
|
||
| ## License | ||
| ## Contributing | ||
|
|
||
| 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 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.
Outdated
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.
Outdated
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.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## License & Legal Disclaimer | ||
|
|
||
| This project is not affiliated with, nor endorsed by, Electronic Arts in any way. EA has not endorsed and does not | ||
DevGeniusCode marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 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) | ||
| 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.