<challenge>.ini 3.1

The human-readable name of your challenge, keep it short as there is limited screen space on the Challenges menu.

For example: "Hide behind me"

How difficult is your challenge to the average gamer?

• "Easy"
• "Medium"
• "Hard"
• "Insane"

Note: This is not related to the AI difficulty, it's just a guide for users as to how hard the challenge is.

In Warzone 2.x, difficulty was expressed as a number, probably between 1 and 100 (or 0 and 99). The values shown above are for Warzone 3.1 and above.

3.1

The map filename, but without path or extension. Case sensitive.

Example: "Sk-MizaMaze"

mapName

Map

mapWidth

mapHeight

3.1

Must be the same number as the number of player slots (excluding Scavenger faction) on the Map. So if you're using a 4 player map, MaxPlayers would be 4 (even if you don't plan to fill all the slots).

Scripts can refer to maxPlayers and playerData[] globals to get information about the players.

maxPlayers

Players & Alliances

playerData[]

Should the Scavenger faction be enabled?

• true – yes, enable Scavengers
• false – disable Scavengers

Default: If the property is not defined, players can choose whether to include scavengers or not.

Note: The map must contain pre-placed Scavenger objects if you want to use Scavengers. See Adding Scavengers to Maps for more information.

scavengers

scavengerPlayer

Scavenger faction

Adding Scavengers to Maps

What base type should be set for the game?

• 1 – No bases
  (See: CAMP_CLEAN)
• 2 – Basic bases
  (See: CAMP_BASE)
• 3 – Full bases
  (See: CAMP_WALLS)

Default: Allow player to decide while setting up the game.

See Player Initialisation for full details of the effects of base types.

baseType

Player Initialisation

The rate at which power is generated by oil derricks, which must be one of the following:

• 400 – low output
• 700 – medium output
• 1000 – high output

Default: Allow player to decide while setting up the game.

Note: Not the same as starting power, which is determined by the base type (Bases) setting during Player Initialisation.

powerType

derrickPositions[]

RESOURCE_ EXTRACTOR

POWER_GEN

setPower()

playerPower()

A sentence that describes what the challenge is about.

For example: "Stay behind your AI allies and beat the enemy in close quarters, man-to-man combat."

Default: No description.

It's shown in a tooltip when the user hovers their mouse over the map name on the Challenges menu.

Should the player be allowed to choose which position they start in?

• true – yes, player can change their start position on the map
• false – no, player position is locked

Default: false

playerData[]

Player object

startPositions[]

The name of the player as they will appear on the Challenge set-up screen, in-game chat and intel screen.

Example: "Bob Hoskins"

Default: "Nexus"

playerData[]

Player object

Which team is the player in?

Give more than one player the same team to create an alliance between those players.

Teams are zero-referenced, so 0 = Team A, 1 = Team B, etc.

If the "team" property is not specified, the player slot is disabled.

Player object

Faction, Team & Player Colours

Players & Alliances

Set the difficulty level for the player.

• "Easy"
• "Medium"
• "Hard"
• "Insane"

Default: "Medium"

difficulty

Players & Alliances

playerData[]

Player object

PLAYER_DATA

Which map starting position should this player be in?

Position slots in the .ini file are one-referenced, so this should be a number between 1 and MaxPlayers (inclusive).

If not specified, defaults to 1 for the human player.

Note that in your scripts, the position slots are zero-referenced. So position 1 in the .ini file is equivalent to position 0 in your script.

playerData[]

Player object

startPositions[]

Which AI bot will control this player?

This is not an .ai file, it is the filename (without path or extension) of the .js file containing your AI.

Example: semperfi.js

Default: No AI associated with player.

Warzone will search the challenges/ folder first, and if it can't find the script there it will then search multiplay/skirmish/ folder. This is useful because if you want an AI that's only available in challenge games, and not skirmish or multiplayer games, you can put it in the challenges/ folder.

If you do not want an AI to be associated with the player, you can specify null or simply omit the "ai" property. For example, you might have a ready-built base but don't want it to do anything other than have its automated defence structures firing at enemies.

Human players should not have an "ai" property, obviously. If you want to override the script (rules.js) associated with humans, use the "rules" property in the [scripts] section (see below).

Scripting (JS & WZScript)

Specify custom game rules for your challenge using this property.

Example: towerdefence.js

If specified, the standard rules.js will not be loaded. Instead, the specified script will be run in the context of the human player ([player_1]).

Like the "ai" property in [player_N] sections, this should just be a filename and Warzone will search the challenges/ folder first, and if it can't find the script there it will then search multiplay/skirmish/ folder.

Game Rules & SitRep

rules.js

Player Initialisation

Scripting (JS & WZScript)

Allows you to run an additional script (linked to the human player) during the game.

For example, you could use the script to define missions or send in reinforcements. In Warzone 3.2, where the JS API can interact with chat messages, you could even use the "extra" script to provide custom chat commands or status reports.