diff --git a/CONTRIBUTION_GUIDELINES.md b/CONTRIBUTION_GUIDELINES.md new file mode 100644 index 000000000..9e68eeb08 --- /dev/null +++ b/CONTRIBUTION_GUIDELINES.md @@ -0,0 +1,103 @@ +# How to Contribute to the Generals Zero Hour Patch Repository + +Welcome to the **Generals Zero Hour** patch repository! We are thrilled about the open-source release of the game engine, and we invite you to contribute to improving the game in various ways. Whether you're a graphic designer, sound designer, translator, or developer, your contributions will be highly appreciated. Together, we can make this iconic game even better! + +### Contribution Statistics So Far: +- Over **1000 textures and models** have been fixed. +- More than **1500 sound files** have been improved. +- Over **500 bugs** have been resolved. +- Updates have been made to tens of thousands of lines of localization across multiple languages! + +Feel free to open new issues, suggest fixes, or propose improvements. Your input is always welcome, and together we can make the game even better! + +#### **For CPP Developers** +If you’re an expert in C++, we invite you to review over 250 issues documented in our repository at [GeneralsGameCode Issues](https://github.com/TheSuperHackers/GeneralsGameCode/issues). Feel free to explore, contribute your expertise, and help us enhance the project! Your skills are incredibly valuable, and we greatly appreciate your contributions. 🙏 + +## 1. **Graphics Contributions** +If you are a graphic designer, you can help enhance various assets in the game: +- **Textures:** Help upgrade or create new textures for characters, buildings, and backgrounds. +- **W3D Models:** Create or improve W3D models for units, vehicles, and structures. +- **Animations:** Add new animations or improve existing ones for characters and vehicles. +- **Visual Effects:** Improve visual effects such as explosions, smoke, and other dynamic elements in the game. + +You can find the graphics-related issues and contribute to the project here: +- **[GitHub - Art Issues](https://github.com/TheSuperHackers/GeneralsGamePatch/labels/Art)** 🎨 + +## 2. **Audio Contributions** +If you're passionate about sound design and music, you can contribute by: +- **Enhancing Music:** Update, improve, or create new music tracks to enrich the game's atmosphere. +- **Sound Effects:** Create or improve sound effects (such as vehicle noises, explosions, and dialogue). + +Join the audio improvement efforts here: +- **[GitHub - Audio Issues](https://github.com/TheSuperHackers/GeneralsGamePatch/labels/Audio)** 🎧 + +## 3. **Text and Language Contributions** +If you have a knack for writing or editing, we welcome your help with: +- **Text Improvements:** Fixing errors, clarifying the existing text, or refining the language. +- **Localization:** Help us make the game accessible in different languages by translating or improving translations. +- **Cultural understanding:** If there are expressions that are not appropriate for a particular culture or the game world, you can suggest changes and improvements to the language to make it more appropriate. + +We currently support the following languages: English, Russian, Ukrainian, Arabic, Spanish, brazilian, France, Polish, Chinese, Korean, Italian and German: +- **[GitHub - Text & Localization Issues](https://github.com/TheSuperHackers/GeneralsGamePatch/labels/Text)** 📝🌍 + +## 4. **AI Improvements** +If you are interested in AI development or game logic, you can contribute by improving the artificial intelligence of the game. Some areas where you can help include: +- **INI File Tweaks:** Modify and improve the AI behavior by editing the game's INI configuration files. +- **Unit Movement Fixes:** Identify and resolve issues related to unit movement, such as stuck units or inefficient pathfinding. +- **AI Tactics and Strategy:** Enhance the AI's decision-making processes, making them more challenging and fun to play against. +- **Bug Fixes:** Help identify and fix bugs related to AI behavior, such as incorrect responses to player actions or broken strategies. + +Improving the AI can significantly enhance the challenge and experience for players, making the game more engaging and dynamic. + +Join the AI-related efforts here: +- **[GitHub - AI Issues](https://github.com/TheSuperHackers/GeneralsGamePatch/labels/AI)** 🤖 + + +## 5. **Bug Fixes & Game Enhancements** +Our experts are hard at work processing the code and creating a compilation shell, but there are still many ways you can help improve the game: +- **Bug Fixes:** Help identify and resolve bugs in the game. +- **Game Enhancements:** Work on improving the game shell, user interface, performance, or compatibility. +- **Content Creation:** If you're a map creator, or have expertise in modding, we invite you to contribute new content or improve existing ones. + +Join the AI-related efforts here: +- **[GitHub - BUG Issues](https://github.com/TheSuperHackers/GeneralsGamePatch/labels/BUG)** 🐞 + + +## 6. **Tools for Development** +To help you with your contributions, we recommend the following tools: + +### **GeneralsModBuilder** +The **GeneralsModBuilder** is a key tool for creating and processing mods for *Generals Zero Hour*. It allows you to easily: +- **Process Textures and Models:** Convert and edit textures, 3D models, and more. +- **Test Changes Quickly:** Check how your changes appear in the game in real-time. +[In Future] - **Create MOD Files:** Package your changes into mod files that can be easily shared and installed. +[In Future] - **Maintain Compatibility:** Ensure your contributions work with different game versions. + +If you're a Python developer, you can also contribute to improving GeneralsModBuilder itself by enhancing its functionality, fixing bugs, or adding new features to the tool. Your contributions will make modding easier and more efficient for the entire community! + +### **Additional Tools:** +- **3ds Max or Blender:** For creating and editing 3D models. +- **Photoshop or GIMP:** For editing textures and creating new graphic assets. +- **Audacity:** For sound editing and creating audio effects. + +### **Game Testing:** +Once you’ve processed your contributions, we encourage you to test your changes: +- **In-Game Testing:** Use **GeneralsModBuilder** to test your changes within the game and ensure everything works properly. +- **Stability Testing:** Check that the game remains stable after the changes and doesn’t experience any crashes or performance issues. +- **Compatibility Testing:** Ensure your new content integrates well with the rest of the game and doesn’t cause conflicts with other mods. + + +Visit our GitHub repository to find the right spot for your contributions: +- **Repository:** [GitHub - Generals Zero Hour](https://github.com/TheSuperHackers/GeneralsGamePatch) + +Feel free to open new issues, suggest fixes, or propose improvements. Your expertise and creativity will help make the game better for everyone. 🙌 + +--- + +### **How to Contribute in Practice** +If you're ready to contribute, whether it’s by opening a pull request (PR) or submitting changes, we have a guide that outlines the process for you. This guide includes important details such as how to document your changes, formatting guidelines, YAML files, and other best practices to ensure your contributions are smooth and effective. + +For full instructions on how to contribute, please refer to our [Contribution Guidelines](https://github.com/TheSuperHackers/GeneralsGamePatch/blob/main/CONTRIBUTE.md). This guide will help you understand the technical and procedural steps required to contribute successfully to the project. + +### We're looking forward to your contributions! +Every contribution, no matter how big or small, is valuable. Let's work together to improve *Generals Zero Hour* and create a fantastic expe diff --git a/README.md b/README.md index 86ab7e448..a7dd74bb5 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,9 @@ In our first survey we asked the community what they think about addressing bugs ## CONTRIBUTE -[How to contribute](CONTRIBUTE.md) +If you're interested in contributing to the project, please refer to our detailed [Contribution Guidelines](CONTRIBUTE.md) for technical instructions on how to get started. + +For general guidance and suggestions on how to contribute in various areas (graphics, sound, AI, etc.), check out our [How to Contribute](CONTRIBUTION_GUIDELINES.md) document. ## LICENSE