Skip to content

Commit

Permalink
Reformat ini examples in docs
Browse files Browse the repository at this point in the history
Co-authored-by: Metadorius <[email protected]>
  • Loading branch information
ZivDero and Metadorius committed Sep 18, 2024
1 parent 7121e5e commit 3d85eb9
Show file tree
Hide file tree
Showing 4 changed files with 149 additions and 146 deletions.
6 changes: 3 additions & 3 deletions docs/Mapping.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This page describes all mapping-related additions and changes introduced by Vini
In `BATTLE.INI`:
```ini
[Campaign]
IntroMovie=<string> ; The intro movie name (without the .VQA extension) to play at the start of the campaign? Defaults to <none>.
IntroMovie=<none> ; string, the intro movie name (without the .VQA extension) to play at the start of the campaign.
```

### DebugOnly
Expand All @@ -28,7 +28,7 @@ IntroMovie=<string> ; The intro movie name (without the .VQA extension) to play
In `BATTLE.INI`:
```ini
[Campaign]
DebugOnly=<boolean> ; Is this campaign only available in Developer mode? Defaults to no.
DebugOnly=no ; boolean, is this campaign only available in Developer mode?
```
For testing/debugging versions of the Tiberian Sun and Firestorm campaigns, download [BATTLE_DEBUG_CAMPAIGN.INI](https://github.com/Vinifera-Developers/Vinifera-Files/blob/master/files/BATTLE_DEBUG_CAMPAIGN.INI) and place it in your game install directory.

Expand All @@ -41,7 +41,7 @@ For testing/debugging versions of the Tiberian Sun and Firestorm campaigns, down
In a scenario file:
```ini
[Basic]
IceDestructionEnabled=<boolean> ; Can ice tiles be destroyed in the scenario? Defaults to yes.
IceDestructionEnabled=yes ; boolean, can ice tiles be destroyed in the scenario?
```

## Script Actions
Expand Down
22 changes: 11 additions & 11 deletions docs/Miscellanous.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ This page describes every change in Vinifera that wasn't categorized into a prop
In `RULES.INI`:
```ini
[MultiplayerDefaults]
AutoDeployMCV=<boolean> ; Player MCV's will auto-deploy on game start. (Defaults to no).
; NOTE: This option only has an effect if the unit count is set to 1.
PrePlacedConYards=<boolean> ; Pre-place construction yards instead of spawning an MCV. (Defaults to no).
; NOTE: This option has priority over AutoDeployMCV.
AutoDeployMCV=no ; boolean, should player MCV's auto-deploy on game start?
PrePlacedConYards=no ; boolean, should pre-place construction yards instead of spawning an MCV?
; NOTE: This option only has an effect if the unit count is set to 1.
; NOTE: This option has priority over AutoDeployMCV.
```

## Multi-Engineer
Expand All @@ -34,8 +34,8 @@ PrePlacedConYards=<boolean> ; Pre-place construction yards instead of spawning a
In `RULES.INI`:
```ini
[General]
EngineerDamage=<float> ; The engineer will damage a building by this percent of its full health each time it enters. Defaults to 0.0.
EngineerCaptureLevel=<float> ; If the building’s health is equal to or below this percentage of its strength it can be captured by an engineer. Defaults to 1.0.
EngineerDamage=0.0 ; float, the engineer will damage a building by this percent of its full health each time it enters.
EngineerCaptureLevel=1.0 ; float, if the building’s health is equal to or below this percentage of its strength it can be captured by an engineer.
```
```{warning}
Upon observing the values used in `FIRESTRM.INI`, this could potentially cause an issue with the vanilla game. `FIRESTRM.INI` has the values `EngineerCaptureLevel=1.0` and `EngineerDamage=0.0`. Below are some values to help test these bug fixes and their potential impact on the vanilla game.
Expand All @@ -56,9 +56,9 @@ Red Alert Multiplayer (MPLAYER.INI) values:
In `RULES.INI`:
```ini
[MultiplayerDefaults]
BuildOffAlly=<boolean> ; Can players build their own structures adjacent to structures owned by their allies? (Defaults to yes).
BuildOffAlly=yes ; boolean, can players build their own structures adjacent to structures owned by their allies?

[BuildingTypes]
[SOMEBUILDING] ; BuildingType
EligibleForAllyBuilding=<boolean> ; Is this building eligible for proximity checks by players who are its owner's allies?
; For buildings with `ConstructionYard=yes` this defaults to yes, otherwise it defaults to no.
```
Expand All @@ -73,10 +73,10 @@ While this is INI file is optional, it is recommended the `ProjectName` and `Pro
In `VINIFERA.INI`:
```ini
[General]
ProjectName=<string> ; The project's title name string. Limited to 64 characters.
ProjectName=<string> ; The project's title name string. Limited to 64 characters.
ProjectVersion=<string> ; The project's version string. Limited to 64 characters.
IconFile=<string> ; The name of the icon file (including the .ICO extension) to use for the games window. Limited to 64 characters.
CursorFile=<string> ; The name of the cursor file (including the .CUR extension) to use for the game's cursor. Limited to 64 characters.
IconFile=<string> ; The name of the icon file (including the .ICO extension) to use for the games window. Limited to 64 characters.
CursorFile=<string> ; The name of the cursor file (including the .CUR extension) to use for the game's cursor. Limited to 64 characters.
```
```{note}
The filenames also support subdirectories.
Expand Down
Loading

0 comments on commit 3d85eb9

Please sign in to comment.