Mod Developers Guide - Revision history

JustADutchman: /* Sharing code with "require" */

2026-09-01T13:12:26Z

Sharing code with "require"

← Older revision		Revision as of 13:12, 1 September 2026
Line 78:		Line 78:
	For example, if you have utility functions in a file named 'Utilities.lua', simply write <code>require('Utilities')</code> at the top of another file to include it (omit the <code>.lua</code>).		For example, if you have utility functions in a file named 'Utilities.lua', simply write <code>require('Utilities')</code> at the top of another file to include it (omit the <code>.lua</code>).

	~~Note that all~~ lua files ~~must be~~ in ~~the same directory~~ (~~subdirectories are currently not supported~~).		You can also require lua files in subdirectories. If you have a subdirectory called 'Util', and in that subdirectory a file called 'Player.lua', simply write <code>require('Util.Player')</code>.

	== Printing Output ==		== Printing Output ==

Fizzer at 06:40, 31 August 2026

2026-08-31T06:40:53Z

← Older revision		Revision as of 06:40, 31 August 2026
Line 7:		Line 7:
	== Getting started creating a mod ==		== Getting started creating a mod ==

	There are ~~two~~ ways to load mod code into War.app: Using the Standalone Client, or directly uploading from your ~~editor~~. ~~Uploading from your editor is the preferred way since it allows for more rapid iteration. However, it also requires an extension to your editor, which only exists for VS Code.~~ If ~~you want to develop from an editor other than VS Code, or if~~ you want to develop without an active internet connection, you should use the Standalone Client method.		There are three ways to load mod code into War.app: Using the Standalone Client, directly uploading from VSCode, or directly uploading from a folder on your disk. If you want to develop without an active internet connection, you should use the Standalone Client method, otherwise the other methods are recommended since they allow for more rapid iteration.

	=== Developing with ~~the Standalone Client~~ ===		=== Developing with direct upload from your disk ===

	# Open the page https://www.war.app/EnableModDevelopment to enable mod development for your War.app account.		# Open the page https://www.war.app/EnableModDevelopment to enable mod development for your War.app account.
	# Download the ~~[[Standalone Client]]~~ and ~~run~~ it.		# Ensure you have python 3 installed.
	# Obtain the source code to an example mod, such as the Randomized Wastelands Mod from https://github.com/FizzerWL/ExampleMods/tree/master/RandomizedWastelandsMod. Download the lua files to a folder on your device. ~~(The easiest way is to use Github's "Download zip" button if you're not a git user)~~		# Download the python uploader script from https://raw.githubusercontent.com/FizzerWL/War.app-Mod-Uploader/refs/heads/main/UpdateMod.py
	# ~~Launch~~ the ~~Standalone Client~~, ~~sign in. Click~~ the ~~"Mod Development Console" button. You can also use the hotkey Ctrl+Shift+M~~ to ~~bring up this dialog any time~~, and ~~also note that this dialog can be docked to sides of your screen if you wish~~.		# Open the Mod Development Console at https://www.war.app/Mods/Develop
	# ~~Click the "Create New Mod" button and give~~ your mod ~~a name~~.		# Click the "Create New Mod" button and give your mod a name. Ensure the "Development" box is checked. After creating it, make note of your Mod ID.
	~~# Provide path to your folder with lua files that you downloaded in step 3~~.		# Visit https://www.war.app/API/GetAPIToken and note your API Token.
	~~# Click Submit to create the mod~~.		# Obtain the source code to an example mod, such as the Randomized Wastelands Mod from https://github.com/FizzerWL/ExampleMods/tree/master/RandomizedWastelandsMod. Download the lua files to a folder on your device.
	~~# From the single-player main menu, click "Custom Game", then scroll down~~ and click Change Mods.		# Run the attached python script, providing the folder to your example mod, mod ID, and API token.
	# You should see the mod you created here. Check the box to turn it on and click Submit.		# Now that your mod is updated, let's run it. Visit https://www.war.app/SinglePlayer?CustomGame=1 and click Change Mods. You should see the mod you created here. Check the box to turn it on and click Submit.
	# If you've cloned the Randomized Wastelands mod, you'll also need to turn on wastelands if you want it to do anything. You can also turn off fog to more easily see its effects. Create the game, and see the wastelands be adjusted!		# If you've cloned the Randomized Wastelands mod, you'll also need to turn on wastelands if you want it to do anything. You can also turn off fog to more easily see its effects. Create the game, and see the wastelands be adjusted!

			You can now make modifications to the mod on your disk, and the python script will automatically notice those changes, upload them to the War.app server, and your opened browser window will automatically notice the new code and re-load it immediately. There's no need to refresh your browser to see your code changes.

	~~Now you can make modifications~~ to the ~~lua code, press the "Reload code" button and try them out!~~		Be sure to read the rest of this page for essential information on mod development.

	=== Developing with direct upload from ~~your editor~~ ===		=== Developing with direct upload from VSCode ===

	# Open the page https://www.war.app/EnableModDevelopment to enable mod development for your War.app account.		# Open the page https://www.war.app/EnableModDevelopment to enable mod development for your War.app account.
Line 42:		Line 44:

	Be sure to read the rest of this page for essential information on mod development.		Be sure to read the rest of this page for essential information on mod development.


			=== Developing with the Standalone Client ===

			# Open the page https://www.war.app/EnableModDevelopment to enable mod development for your War.app account.
			# Download the [[Standalone Client]] and run it.
			# Obtain the source code to an example mod, such as the Randomized Wastelands Mod from https://github.com/FizzerWL/ExampleMods/tree/master/RandomizedWastelandsMod. Download the lua files to a folder on your device. (The easiest way is to use Github's "Download zip" button if you're not a git user)
			# Launch the Standalone Client, sign in. Click the "Mod Development Console" button. You can also use the hotkey Ctrl+Shift+M to bring up this dialog any time, and also note that this dialog can be docked to sides of your screen if you wish.
			# Click the "Create New Mod" button and give your mod a name.
			# Provide path to your folder with lua files that you downloaded in step 3.
			# Click Submit to create the mod.
			# From the single-player main menu, click "Custom Game", then scroll down and click Change Mods.
			# You should see the mod you created here. Check the box to turn it on and click Submit.
			# If you've cloned the Randomized Wastelands mod, you'll also need to turn on wastelands if you want it to do anything. You can also turn off fog to more easily see its effects. Create the game, and see the wastelands be adjusted!

			Now you can make modifications to the lua code, press the "Reload code" button and try them out!


	== Video Tutorial ==		== Video Tutorial ==

Fizzer at 02:35, 18 April 2026

2026-04-18T02:35:52Z

JustADutchman: Added Community Annotations to the tips page

2025-12-08T16:35:07Z

Added Community Annotations to the tips page

← Older revision		Revision as of 16:35, 8 December 2025
Line 92:		Line 92:

	Note that all mods uploaded to Warzone must use the MIT license, or something equally or more permissable. Any mods without a license specified are assumed to be using MIT. <!-- this is a request rather than definite license compliance: --> Additionally, for mods to be used by Warzone, they must use the MIT license, or something equally or more permissable.		Note that all mods uploaded to Warzone must use the MIT license, or something equally or more permissable. Any mods without a license specified are assumed to be using MIT. <!-- this is a request rather than definite license compliance: --> Additionally, for mods to be used by Warzone, they must use the MIT license, or something equally or more permissable.

			The [[Mod API Reference]] can be found here on the wiki, but there is also a community project that brings the Mod API documentation into Visual Studio Code using annotations. Since this is community driven, it won't always be up to date if Warzone releases a new update and it could contain mistakes. The project and documentation to include it in your visual studio code editor can be found here: https://github.com/JustMe003/ModTemplates

	== See Also ==		== See Also ==

DanWL60: /* Tips */ licensing clarification

2025-04-19T20:14:28Z

Tips: licensing clarification

← Older revision		Revision as of 20:14, 19 April 2025
Line 91:		Line 91:
	Be sure to test in multi-player! When running Server code in multi-player, your lua code runs on the Warzone server which uses a different lua engine. In theory, everything should be the same, but there is still an opportunity for differences. To ensure everything you're doing works, it's recommended you test in multi-player, not only before you're ready to go public, but also occasionally during your development process.		Be sure to test in multi-player! When running Server code in multi-player, your lua code runs on the Warzone server which uses a different lua engine. In theory, everything should be the same, but there is still an opportunity for differences. To ensure everything you're doing works, it's recommended you test in multi-player, not only before you're ready to go public, but also occasionally during your development process.

	Note that all mods uploaded to Warzone must use the MIT license, or something equally or more permissable. Any mods without a license specified are assumed to be using MIT.		Note that all mods uploaded to Warzone must use the MIT license, or something equally or more permissable. Any mods without a license specified are assumed to be using MIT. <!-- this is a request rather than definite license compliance: --> Additionally, for mods to be used by Warzone, they must use the MIT license, or something equally or more permissable.

	== See Also ==		== See Also ==

Fizzer at 20:49, 18 April 2025

2025-04-18T20:49:19Z

← Older revision		Revision as of 20:49, 18 April 2025
Line 100:		Line 100:
	* [[Mod Hooks]]		* [[Mod Hooks]]
	* [[Mod Game Data Storage]]		* [[Mod Game Data Storage]]
			* [[Mod Images]]
	* [https://discord.gg/hqGkVXagyt Warzone Mod Makers Discord]		* [https://discord.gg/hqGkVXagyt Warzone Mod Makers Discord]

	[[Category:Mod Developers Guide\|!]]		[[Category:Mod Developers Guide\|!]]

DanWL60: Puts the page under ! in the Mod Developers Guide category

2025-02-06T16:48:02Z

Puts the page under ! in the Mod Developers Guide category

← Older revision		Revision as of 16:48, 6 February 2025
Line 102:		Line 102:
	* [https://discord.gg/hqGkVXagyt Warzone Mod Makers Discord]		* [https://discord.gg/hqGkVXagyt Warzone Mod Makers Discord]

	[[Category:Mod Developers Guide]]		[[Category:Mod Developers Guide\|!]]

Kaninchen: added Mod Security to See Also, please see discussion to discuss if it should get its own section

2024-04-18T17:07:31Z

added Mod Security to See Also, please see discussion to discuss if it should get its own section

← Older revision		Revision as of 17:07, 18 April 2024
Line 94:		Line 94:

	== See Also ==		== See Also ==
			* [[Mod Security]]
	* [[Mod API Reference]]		* [[Mod API Reference]]
	* [[Mod Backwards Compatibility]]		* [[Mod Backwards Compatibility]]

Kaninchen: /* Global State */ spelling error

2024-03-19T18:16:32Z

Global State: spelling error

← Older revision		Revision as of 18:16, 19 March 2024
Line 75:		Line 75:
	Never assume any state will persist, unless specifically called out in the documentation. For example, don't write to a global variable in one hook and access it in another.		Never assume any state will persist, unless specifically called out in the documentation. For example, don't write to a global variable in one hook and access it in another.

	If you try to in a single-player game, you may find that global state does persist. However, don't be tempted to rely on this, since globals are always wiped in multi-player, and globals will also get wiped in single-player if someone saves and re-loads their game. Therefore, ensure you code as if globals will never persist between hook calls, except where ~~expliclty~~ allowed.		If you try to in a single-player game, you may find that global state does persist. However, don't be tempted to rely on this, since globals are always wiped in multi-player, and globals will also get wiped in single-player if someone saves and re-loads their game. Therefore, ensure you code as if globals will never persist between hook calls, except where explicitly allowed.

	== Data Storage ==		== Data Storage ==

DanWL60: /* See Also */

2023-11-12T01:47:38Z

← Older revision		Revision as of 02:35, 18 April 2026
Line 3:		Line 3:
	This guide assumes that you know the Lua programming language. If you've worked with other languages, such as Javascript, Lua should be very easy to learn. Many tutorials are available on the internet if you search for them.		This guide assumes that you know the Lua programming language. If you've worked with other languages, such as Javascript, Lua should be very easy to learn. Many tutorials are available on the internet if you search for them.

	Note that you must be a ~~Warzone~~ [[member]] to develop mods, as mods are a member feature.		Note that you must be a War.app [[member]] to develop mods, as mods are a member feature.

	== Getting started creating a mod ==		== Getting started creating a mod ==

	There are two ways to load mod code into ~~Warzone~~: Using the Standalone Client, or directly uploading from your editor. Uploading from your editor is the preferred way since it allows for more rapid iteration. However, it also requires an extension to your editor, which only exists for VS Code. If you want to develop from an editor other than VS Code, or if you want to develop without an active internet connection, you should use the Standalone Client method.		There are two ways to load mod code into War.app: Using the Standalone Client, or directly uploading from your editor. Uploading from your editor is the preferred way since it allows for more rapid iteration. However, it also requires an extension to your editor, which only exists for VS Code. If you want to develop from an editor other than VS Code, or if you want to develop without an active internet connection, you should use the Standalone Client method.

	=== Developing with the Standalone Client ===		=== Developing with the Standalone Client ===

	# Open the page https://www.~~warzone~~.~~com~~/EnableModDevelopment to enable mod development for your ~~Warzone~~ account.		# Open the page https://www.war.app/EnableModDevelopment to enable mod development for your War.app account.
	# Download the [[Standalone Client]] and run it.		# Download the [[Standalone Client]] and run it.
	# Obtain the source code to an example mod, such as the Randomized Wastelands Mod from https://github.com/FizzerWL/ExampleMods/tree/master/RandomizedWastelandsMod. Download the lua files to a folder on your device. (The easiest way is to use Github's "Download zip" button if you're not a git user)		# Obtain the source code to an example mod, such as the Randomized Wastelands Mod from https://github.com/FizzerWL/ExampleMods/tree/master/RandomizedWastelandsMod. Download the lua files to a folder on your device. (The easiest way is to use Github's "Download zip" button if you're not a git user)
Line 26:		Line 26:
	=== Developing with direct upload from your editor ===		=== Developing with direct upload from your editor ===

	# Open the page https://www.~~warzone~~.~~com~~/EnableModDevelopment to enable mod development for your ~~Warzone~~ account.		# Open the page https://www.war.app/EnableModDevelopment to enable mod development for your War.app account.
	# Install VS Code from https://code.visualstudio.com/		# Install VS Code from https://code.visualstudio.com/
	# Obtain the source code to an example mod, such as the Randomized Wastelands Mod from https://github.com/FizzerWL/ExampleMods/tree/master/RandomizedWastelandsMod. Download the lua files to a folder on your device. (The easiest way is to use Github's "Download zip" button if you're not a git user)		# Obtain the source code to an example mod, such as the Randomized Wastelands Mod from https://github.com/FizzerWL/ExampleMods/tree/master/RandomizedWastelandsMod. Download the lua files to a folder on your device. (The easiest way is to use Github's "Download zip" button if you're not a git user)
	# Download the ~~Warzone~~ Mod Helper VS Code extension VSIX file from https://github.com/FizzerWL/~~WarzoneModHelper~~/releases. Install it by launching VS Code, pressing Ctrl+Shift+P, entering "Install from VSIX" and selecting the VSIX file you downloaded.		# Download the War.app Mod Helper VS Code extension VSIX file from https://github.com/FizzerWL/War.appModHelper/releases. Install it by launching VS Code, pressing Ctrl+Shift+P, entering "Install from VSIX" and selecting the VSIX file you downloaded.
	# (optional) Install the Lua IDE extension: https://marketplace.visualstudio.com/items?itemName=sumneko.lua		# (optional) Install the Lua IDE extension: https://marketplace.visualstudio.com/items?itemName=sumneko.lua
	# Open the Mod Development Console at https://www.~~warzone~~.~~com~~/Mods/Develop		# Open the Mod Development Console at https://www.war.app/Mods/Develop
	# Click the "Create New Mod" button and give your mod a name. Ensure the "Development" box is checked. After creating it, make note of your Mod ID.		# Click the "Create New Mod" button and give your mod a name. Ensure the "Development" box is checked. After creating it, make note of your Mod ID.
	# In VS Code, open the RandomizedWastelandsMod folder you downloaded earlier. Open one of the lua files in this folder.		# In VS Code, open the RandomizedWastelandsMod folder you downloaded earlier. Open one of the lua files in this folder.
	# Visit https://www.~~warzone~~.~~com~~/API/GetAPIToken and copy your API Token to the clipboard.		# Visit https://www.war.app/API/GetAPIToken and copy your API Token to the clipboard.
	# In VS Code, press Ctrl+Shift+P and select "Upload Mod". Enter your Mod ID you noted earlier, and paste your API Token when prompted. Ensure it says "Mod updated successfully" in the bottom right corner.		# In VS Code, press Ctrl+Shift+P and select "Upload Mod". Enter your Mod ID you noted earlier, and paste your API Token when prompted. Ensure it says "Mod updated successfully" in the bottom right corner.
	# Now that your mod is updated, let's run it. Visit https://www.~~warzone~~.~~com~~/SinglePlayer?CustomGame=1 and click Change Mods. You should see the mod you created here. Check the box to turn it on and click Submit.		# Now that your mod is updated, let's run it. Visit https://www.war.app/SinglePlayer?CustomGame=1 and click Change Mods. You should see the mod you created here. Check the box to turn it on and click Submit.
	# If you've cloned the Randomized Wastelands mod, you'll also need to turn on wastelands if you want it to do anything. You can also turn off fog to more easily see its effects. Create the game, and see the wastelands be adjusted!		# If you've cloned the Randomized Wastelands mod, you'll also need to turn on wastelands if you want it to do anything. You can also turn off fog to more easily see its effects. Create the game, and see the wastelands be adjusted!

Line 49:		Line 49:
	== Hooks ==		== Hooks ==

	~~Warzone~~ will call into a mod's lua code using what are called '''hooks'''. For example, it will call a hook named <code>Server_StartGame</code> when a game is beginning and give your mod an opportunity to change things about how the map is set up.		War.app will call into a mod's lua code using what are called '''hooks'''. For example, it will call a hook named <code>Server_StartGame</code> when a game is beginning and give your mod an opportunity to change things about how the map is set up.

	For full details on what hooks are available, see [[Mod Hooks]].		For full details on what hooks are available, see [[Mod Hooks]].
Line 85:		Line 85:
	Note that if a game takes more than a minute to advance, the mods will time out and the game will not advance. This time counts all mods enabled for that game combined, so mod authors should work to ensure their mods are efficient as possible.		Note that if a game takes more than a minute to advance, the mods will time out and the game will not advance. This time counts all mods enabled for that game combined, so mod authors should work to ensure their mods are efficient as possible.

	If a game times out more than 10 times in a row, ~~Warzone~~ will end the game automatically.		If a game times out more than 10 times in a row, War.app will end the game automatically.

	== Tips ==		== Tips ==

	Be sure to test in multi-player! When running Server code in multi-player, your lua code runs on the ~~Warzone~~ server which uses a different lua engine. In theory, everything should be the same, but there is still an opportunity for differences. To ensure everything you're doing works, it's recommended you test in multi-player, not only before you're ready to go public, but also occasionally during your development process.		Be sure to test in multi-player! When running Server code in multi-player, your lua code runs on the War.app server which uses a different lua engine. In theory, everything should be the same, but there is still an opportunity for differences. To ensure everything you're doing works, it's recommended you test in multi-player, not only before you're ready to go public, but also occasionally during your development process.

	Note that all mods uploaded to ~~Warzone~~ must use the MIT license, or something equally or more permissable. Any mods without a license specified are assumed to be using MIT. <!-- this is a request rather than definite license compliance: --> Additionally, for mods to be used by ~~Warzone~~, they must use the MIT license, or something equally or more permissable.		Note that all mods uploaded to War.app must use the MIT license, or something equally or more permissable. Any mods without a license specified are assumed to be using MIT. <!-- this is a request rather than definite license compliance: --> Additionally, for mods to be used by War.app, they must use the MIT license, or something equally or more permissable.

	The [[Mod API Reference]] can be found here on the wiki, but there is also a community project that brings the Mod API documentation into Visual Studio Code using annotations. Since this is community driven, it won't always be up to date if ~~Warzone~~ releases a new update and it could contain mistakes. The project and documentation to include it in your visual studio code editor can be found here: https://github.com/JustMe003/ModTemplates		The [[Mod API Reference]] can be found here on the wiki, but there is also a community project that brings the Mod API documentation into Visual Studio Code using annotations. Since this is community driven, it won't always be up to date if War.app releases a new update and it could contain mistakes. The project and documentation to include it in your visual studio code editor can be found here: https://github.com/JustMe003/ModTemplates

	== See Also ==		== See Also ==
Line 103:		Line 103:
	* [[Mod Game Data Storage]]		* [[Mod Game Data Storage]]
	* [[Mod Images]]		* [[Mod Images]]
	* [https://discord.gg/hqGkVXagyt ~~Warzone~~ Mod Makers Discord]		* [https://discord.gg/hqGkVXagyt War.app Mod Makers Discord]

	[[Category:Mod Developers Guide\|!]]		[[Category:Mod Developers Guide\|!]]

← Older revision		Revision as of 01:47, 12 November 2023
Line 99:		Line 99:
	* [[Mod Hooks]]		* [[Mod Hooks]]
	* [[Mod Game Data Storage]]		* [[Mod Game Data Storage]]
			* [https://discord.gg/hqGkVXagyt Warzone Mod Makers Discord]

	[[Category:Mod Developers Guide]]		[[Category:Mod Developers Guide]]