From 1c9fcb2ca45aac253dcd62eda98197e555383187 Mon Sep 17 00:00:00 2001 From: Jaredl-Code <217964373+Jaredl-LV@users.noreply.github.com> Date: Sun, 6 Jul 2025 17:28:23 -0700 Subject: [PATCH] Added placeholder pages for content that is incomplete. Fixed various spelling errors. Adjusted case on some links and files for Consistency with the rest of the wiki. Updated some of the links destinations. --- Asset/Art/cameo_sizes.md | 2 +- Asset/GameDesign/ini/ini-linter.md | 6 +++--- Asset/Home.md | 12 +++++------ Asset/Patch/contribution.md | 6 +++--- Asset/Patch/credits.md | 1 + Asset/Patch/faq.md | 1 + ..._to_involved.md => how_to_get_involved.md} | 0 Asset/Patch/installation.md | 1 + Asset/Patch/known_issues.md | 1 + Asset/_Sidebar.md | 21 +++++++++---------- 10 files changed, 27 insertions(+), 24 deletions(-) create mode 100644 Asset/Patch/credits.md create mode 100644 Asset/Patch/faq.md rename Asset/Patch/{how_to_involved.md => how_to_get_involved.md} (100%) create mode 100644 Asset/Patch/installation.md create mode 100644 Asset/Patch/known_issues.md diff --git a/Asset/Art/cameo_sizes.md b/Asset/Art/cameo_sizes.md index 4936c4a7..1c199de4 100644 --- a/Asset/Art/cameo_sizes.md +++ b/Asset/Art/cameo_sizes.md @@ -11,5 +11,5 @@ Large Portrait - 122 X 98 ## General Portrait Sizes -Small Portait - 118 X 117 +Small Portrait - 118 X 117 Large Portrait - 334 X 330 diff --git a/Asset/GameDesign/ini/ini-linter.md b/Asset/GameDesign/ini/ini-linter.md index b1dfae80..31d68646 100644 --- a/Asset/GameDesign/ini/ini-linter.md +++ b/Asset/GameDesign/ini/ini-linter.md @@ -12,7 +12,7 @@ The ZeroSyntax extension pack comes with 4 main features: This changes how VSCode displays the INI files, making it easier to read and understand the contents. 2. Formatting for INI files. -When working with older files or when expirmenting, INI files can be come messy. This feature will clean up the file +When working with older files or when experimenting, INI files can be come messy. This feature will clean up the file and make correct indentation based on the indentation settings in VSCode. 3. Linting for INI files. @@ -25,7 +25,7 @@ development and prevent typos. ## Installation -Instaltion is super easy, and can be done stright from the editor. +Installation is super easy, and can be done straight from the editor. Use this link: [ZeroSyntax Pack](vscode:extension/vitexftw.zs-pack) or one of the following methods: ### Visual Studio Code @@ -43,7 +43,7 @@ Use this link: [ZeroSyntax Pack](vscode:extension/vitexftw.zs-pack) or one of th ### Visual Studio Extension -**Comming Soon...** +**Coming Soon...** > [!NOTE] > You might need to reload the editor after installing the extension for it to take effect. diff --git a/Asset/Home.md b/Asset/Home.md index 6bde0940..08f8331d 100644 --- a/Asset/Home.md +++ b/Asset/Home.md @@ -13,15 +13,15 @@ goal of this project is to provide a higher quality and more polished experience ## **Getting Started** To get started with the project, you can submit issues or pull requests (PRs). Additionally, you can install the current -asset patch using **GeneralsModBuilder** (see the [installation guide](Installation_Instructions)), +asset patch using **GeneralsModBuilder** (see the [installation guide](installation)), which allows you to install the patch directly into your game directory and try it out. ## **Quick Links** -- [How to Get Involved](how_to_involved) -- [Installation Instructions](Installation_Instructions) -- [List of Improvements and Fixes](List_of_Improvements) -- [FAQ](FAQ) +- [How to Get Involved](how_to_get_involved) +- [Installation Guide](installation) +- [List of Improvements and Fixes](https://github.com/TheSuperHackers/GeneralsGamePatch?tab=readme-ov-file#change-logs) +- [FAQ](faq) ## **Types of Assets, Usage, and Configuration Instructions** @@ -35,7 +35,7 @@ This project focuses on various types of assets within *Generals: Zero Hour*. Th and gameplay. For a detailed list of asset types and guidelines on how to contribute or fix them, refer to -the [How to Get Involved](how_to_involved) page. +the [How to Get Involved](how_to_get_involved) page. For detailed information on how to use and configure the different types of assets in the game, such as the behavior of various GUI elements, control mechanics, and more, see the relevant section in the wiki navigation, such as [WND](wnd_reference), diff --git a/Asset/Patch/contribution.md b/Asset/Patch/contribution.md index 7fb7825b..727cb893 100644 --- a/Asset/Patch/contribution.md +++ b/Asset/Patch/contribution.md @@ -73,7 +73,7 @@ Bad: > Fixed particle effect of USA Missile Defender When a text refers to a faction unit, structure, upgrade or similar, then the unit should be worded without any -abbrevations and should be prefixed with the faction name. Valid faction names are USA, China, GLA, Boss, Civilian. +abbreviations and should be prefixed with the faction name. Valid faction names are USA, China, GLA, Boss, Civilian. Subfaction names can be appended too, for example GLA Stealth. Good: @@ -104,7 +104,7 @@ The `Patch104p` word and `@keyword` are mandatory. `author` and date can be omit | @feature | Adding something new | | @fix | Fixing something, but is not a user facing bug | | @performance | Improving performance | -| @refactor | Moving or rewriting code, but does not change the behaviour | +| @refactor | Moving or rewriting code, but does not change the behavior | | @tweak | Changing some values or settings | Block comment sample @@ -153,6 +153,6 @@ appended. The rationale explains why the given change makes sense. Every change needs to be accompanied with a yaml definition file for the change log generation. It is supposed to contain concise information for the change. The yaml file needs to be created inside the `Patch104pZH/Design/Changes` folder or the appropriate subfolder. There is a template.yaml file that can be used as a base. The name of the file -begins with the number of the Pull Request and a few words to summarize the essence of the change, seperated by +begins with the number of the Pull Request and a few words to summarize the essence of the change, separated by underscores. It is possible that a new change extends an existing yaml file instead of creating a new one. In that case a txt file with the same naming rules can be created to refer to the actual yaml file. diff --git a/Asset/Patch/credits.md b/Asset/Patch/credits.md new file mode 100644 index 00000000..e443a413 --- /dev/null +++ b/Asset/Patch/credits.md @@ -0,0 +1 @@ +# This page is a work in progress and is currently incomplete diff --git a/Asset/Patch/faq.md b/Asset/Patch/faq.md new file mode 100644 index 00000000..e443a413 --- /dev/null +++ b/Asset/Patch/faq.md @@ -0,0 +1 @@ +# This page is a work in progress and is currently incomplete diff --git a/Asset/Patch/how_to_involved.md b/Asset/Patch/how_to_get_involved.md similarity index 100% rename from Asset/Patch/how_to_involved.md rename to Asset/Patch/how_to_get_involved.md diff --git a/Asset/Patch/installation.md b/Asset/Patch/installation.md new file mode 100644 index 00000000..e443a413 --- /dev/null +++ b/Asset/Patch/installation.md @@ -0,0 +1 @@ +# This page is a work in progress and is currently incomplete diff --git a/Asset/Patch/known_issues.md b/Asset/Patch/known_issues.md new file mode 100644 index 00000000..e443a413 --- /dev/null +++ b/Asset/Patch/known_issues.md @@ -0,0 +1 @@ +# This page is a work in progress and is currently incomplete diff --git a/Asset/_Sidebar.md b/Asset/_Sidebar.md index f57ba276..f30bf2b1 100644 --- a/Asset/_Sidebar.md +++ b/Asset/_Sidebar.md @@ -3,14 +3,13 @@ ## [Home](Home) --- -## [Patch](patch) +## Patch - [Installation](installation) -- [Patch Notes](patch_notes) -- [How to Get Involved](how_to_involved) -- [How to Contribution](contribution) -- [Lincense](license) +- [How to Get Involved](how_to_get_involved) +- [How to Contribute](contribution) +- [License](https://github.com/TheSuperHackers/GeneralsGamePatch/blob/main/LICENSE.txt) - [Credits](credits) -- [Changelog](changelog) +- [Changelog](https://github.com/TheSuperHackers/GeneralsGamePatch?tab=readme-ov-file#change-logs) - [FAQ](faq) - [Known Issues](known_issues) - [Contact & Community](contact_community) @@ -29,23 +28,23 @@ - BIK - Game Design - INI - - [INI Files](GameDesign/ini_files) + - INI Files - [`map.ini`](map_ini) - [ZeroSyntax VSCode Extension](ini-linter) - SCB - [SCB Links](scb_links) - Maps - - [Map](map_ini) + - [`map.ini`](map_ini) - [World Builder Links](worldbuilder_links) - Localization - [Localization Contribution](localization_contribution) - - [LOCA - Unit Quotes](unit_quotes.txt) + - [LOCA - Unit Quotes](https://raw.githubusercontent.com/TheSuperHackers/GeneralsWiki/refs/heads/main/Asset/Localization/unit_quotes.txt) - [CSF Format](csf_format) - GUI - [WND Reference](wnd_reference) - [Texturing](texturing) - - [WND Controls](WND_Controls) + - WND Controls - [Default- User](wnd_controls_user) - [Checkbox](wnd_controls_checkbox) - [Combobox](wnd_controls_combobox) @@ -61,6 +60,6 @@ ## Tools - FinalBIG -- Generals Mod Builder +- [Generals Mod Builder](https://github.com/TheSuperHackers/GeneralsModBuilder)