Custom Modes - Revision history

GoogleFrog at 08:55, 3 July 2023

2023-07-03T08:55:54Z

RandomX at 18:52, 9 January 2022

2022-01-09T18:52:32Z

RandomX at 18:49, 9 January 2022

2022-01-09T18:49:52Z

RandomX: Added missing comma in code, added feature as experiment to see if it works: syantaxhighlight.

2021-10-27T05:17:25Z

Added missing comma in code, added feature as experiment to see if it works: syantaxhighlight.

GoogleFrog: /* Specification */

2021-04-10T06:24:24Z

Specification

GoogleFrog: /* Specification */

2021-02-16T07:49:47Z

Specification

GoogleFrog: /* Example */

2021-01-30T04:26:13Z

Example

GoogleFrog: /* Specification */

2021-01-30T04:15:15Z

Specification

GoogleFrog: /* Specification */

2021-01-30T03:56:47Z

Specification

GoogleFrog: /* Specification */

2021-01-30T03:55:51Z

Specification

← Older revision		Revision as of 08:55, 3 July 2023
Line 2:		Line 2:

	This system can be used to save and share disabled lists and [[Quick Stat Tweaks]] to create new game modes without going through the work of full modding.		This system can be used to save and share disabled lists and [[Quick Stat Tweaks]] to create new game modes without going through the work of full modding.
		+
		+	== Sharing Custom Modes ==
		+
		+	Upload your custom modes via the "Upload new game mode" button here: http://zero-k.info/Mods

	== Specification ==		== Specification ==

@@ Line 4: / Line 4: @@
 == Specification ==
-Custom modes are json files and may have the following parameters.
+Custom modes are <abbr title="JavaScript Object Notation">JSON</abbr> files that may have the following parameters.
 {| class="wikitable"
@@ Line 43: / Line 43: @@
 }</syntaxhighlight>
-Be careful with the commas in <abbr title="JavaScript Object Notation">JSON</abbr>, as they need to be placed after all but the last item in the set.
+Be careful with the commas in JSON, as they need to be placed after all but the last item in the set.
 [[Category:Development]]{{Navbox manual}}

@@ Line 1: / Line 1: @@
-Custom modes are mods, maps, or just a set of Adv Options that can be selected when hosting the game or in the battle room via 'Select Custom Mode' in Adv Options. Each custom mode is defined by a file in <code>Zero-K/CustomModes</code>. The game deploys a few of these files, but players can also create their own and share them around to act as presets.
+Custom modes are mods, maps, or just a set of Adv Options that can be selected when hosting the game or in the battle room via 'Select Custom Mode' in Adv Options. Each custom mode is defined by a file in <samp>Zero-K/CustomModes</samp>. The game deploys a few of these files, but players can also create their own and share them around to act as presets.
 This system can be used to save and share disabled lists and [[Quick Stat Tweaks]] to create new game modes without going through the work of full modding.
@@ Line 16: / Line 16: @@
 | description || The tooltip for the mode in the 'Select Custom Mode' menu.
 |-
-| roomType || Optional. Can be Custom, 1v1, Team, FFA, Chicken.
+| roomType || Optional. Can be Custom, 1v1, Team, <abbr title="free for all">FFA</abbr>, Chicken.
 |-
-| map || Optional. Use this to set the map. The text must match exactly, as is written below the minimap in the battleroom.
+| map || Optional. Use this to set the map. The text must match exactly, as is written below the minimap in the battle room.
 |-
 | game || Optional. Set a mutator or game. It should match game name exactly, as is shown left of the map when the game is selected.
@@ Line 43: / Line 43: @@
 }</syntaxhighlight>
-Be careful with the commas in json, as they need to be placed after all but the last item in the set.
+Be careful with the commas in <abbr title="JavaScript Object Notation">JSON</abbr>, as they need to be placed after all but the last item in the set.
 [[Category:Development]]{{Navbox manual}}

@@ Line 26: / Line 26: @@
 | hideFromHostMenu || Optional boolean. This is used to hide a mode from the Game Type menu while hosting.
 |-
-| options || Optional table of Adv Option values. All the keys can be found [https://github.com/ZeroK-RTS/Zero-K/blob/master/ModOptions.lua here].
+| options || Optional table of Adv Option values. All the keys can be found in the file [https://github.com/ZeroK-RTS/Zero-K/blob/master/ModOptions.lua ModOptions.lua].
 |}
 == Example ==
-Here is an example that would run Zero Wars with a 2x health multiplier.
+Here is an example that would run Zero Wars with a 2× health multiplier.
- <nowiki>{
+<syntaxhighlight>{
-     "shortName": "zw_hp_tweak"
+     "shortName": "zw_hp_tweak",
      "name" : "Zero Wars with Tweaks v1.0",
      "description" : "Send waves of units across the map to destroy the enemy nexus",
@@ Line 41: / Line 41: @@
          "hpmult" : 2
+     }
-}</nowiki>
+}</syntaxhighlight>
 Be careful with the commas in json, as they need to be placed after all but the last item in the set.
 [[Category:Development]]{{Navbox manual}}

@@ Line 10: / Line 10: @@
 ! Key !! Usage
 |-
-| shortName || A unique name identifying the custom mode. Do not be change it when making an update, or else duplicate files for old versions will be created. Must match the file name of the mode when uploaded.
+| shortName || A unique name identifying the custom mode. '''Do not change it when making an update''', or else duplicate files for old versions will be created. Must match the file name of the mode when uploaded.
 |-
 | name || This is required to display the mode in the mode list. Bad things will happen if there is a clash. Add a version number to the end of this name and increment it upon each update.