WoW:Getting started with writing AddOns - Revision history

Move page script: Move page script moved page Getting started with writing AddOns to WoW:Getting started with writing AddOns without leaving a redirect

2023-08-15T04:48:27Z

Move page script moved page Getting started with writing AddOns to Getting started with writing AddOns without leaving a redirect

← Older revision	Revision as of 04:48, 15 August 2023
(No difference)

Bear at 04:00, 15 August 2023

2023-08-15T04:00:37Z

← Older revision		Revision as of 04:00, 15 August 2023
Line 2:		Line 2:
	The following is a guide for getting started with building WoW AddOns. Creating your own AddOns can be a difficult process at first, but can be very satisfying and is a great way to learn programming in general.		The following is a guide for getting started with building WoW AddOns. Creating your own AddOns can be a difficult process at first, but can be very satisfying and is a great way to learn programming in general.

	If you are mostly interested in what files and structure comprise a WoW AddOn, you can skip to [[~~WoW:~~AddOn\|WoW AddOn]], and come back here or move on from there.		If you are mostly interested in what files and structure comprise a WoW AddOn, you can skip to [[AddOn\|WoW AddOn]], and come back here or move on from there.

	== What should I make ==		== What should I make ==
Line 20:		Line 20:
	* [[AddOn]] - These pages explain the basic structure of a WoW AddOn.		* [[AddOn]] - These pages explain the basic structure of a WoW AddOn.
	* [[World of Warcraft API]] - These are the functions and ways to talk to WoW with Lua.		* [[World of Warcraft API]] - These are the functions and ways to talk to WoW with Lua.
	* [[Curse Forge]] or [[WoW Interface (site)\|WoW Interface]] - Find a real but simple example of an existing AddOn. Most real AddOns, even the simple ones, however can be difficult to read for getting started, with many moving parts.		* [[\Curse Forge]] or [[\WoW Interface (site)\|WoW Interface]] - Find a real but simple example of an existing AddOn. Most real AddOns, even the simple ones, however can be difficult to read for getting started, with many moving parts.
	* [[Lua editors]] - A long list of code editors and other tools often used by other AddOn creators.		* [[Lua editors]] - A long list of code editors and other tools often used by other AddOn creators.

Bear at 03:57, 15 August 2023

2023-08-15T03:57:47Z

Bear: /* SavedVariables */

2022-08-10T19:19:23Z

SavedVariables

← Older revision		Revision as of 19:19, 10 August 2022
Line 134:		Line 134:
	* The SavedVariables is only read from on UI loading, not real time, and only saved to on UI unloading. This will generally be from a user logging in or logging out.		* The SavedVariables is only read from on UI loading, not real time, and only saved to on UI unloading. This will generally be from a user logging in or logging out.
	* Basically, WoW makes a SavedVariables file for you named after your AddOn. You only get to specify in your TOC which variables get saved into that file.		* Basically, WoW makes a SavedVariables file for you named after your AddOn. You only get to specify in your TOC which variables get saved into that file.


	== Advanced but Important Topics ==		== Advanced but Important Topics ==

Bear: /* File Types */

2022-08-10T19:19:09Z

File Types

← Older revision		Revision as of 19:19, 10 August 2022
Line 46:		Line 46:
	There are three main types of files that you'll need to worry about with AddOn editing:		There are three main types of files that you'll need to worry about with AddOn editing:
	* [[TOC File]] - This file is required for any WoW AddOn, and supplies WoW with information about your AddOn and its files.		* [[TOC File]] - This file is required for any WoW AddOn, and supplies WoW with information about your AddOn and its files.
	* ~~LUA~~ Files - This contains Lua code for your AddOn.		* Lua Files - This contains Lua code for your AddOn.
	* XML Files - This holds the layout of UI windows, buttons, and similar for your AddOn.		* XML Files - This holds the layout of UI windows, buttons, and similar for your AddOn.

Bear at 19:18, 10 August 2022

2022-08-10T19:18:50Z

← Older revision		Revision as of 19:18, 10 August 2022
Line 97:		Line 97:
	Beware Lua functions and variables are globals by default and are directly visible to the other addons. If authors blindly use simple and common names, like:		Beware Lua functions and variables are globals by default and are directly visible to the other addons. If authors blindly use simple and common names, like:
	<pre>		<pre>
	addonEnabled = true;		addonEnabled = true;
	function GetArrowsCount()		function GetArrowsCount()
	...		...
	end		end
	</pre>		</pre>

	An addon will easily conflict with variables of the same name from other addons or from the Blizzard interface. Instead, you should write your addon more like a Lua module: place all the data and functions in a single global table, named after the addon, and use local declarations otherwise (no other globals), like:		An addon will easily conflict with variables of the same name from other addons or from the Blizzard interface. Instead, you should write your addon more like a Lua module: place all the data and functions in a single global table, named after the addon, and use local declarations otherwise (no other globals), like:
	<pre>		<pre>
	MarksmanAddOn = { }; -- about the only global name in the addon		MarksmanAddOn = { }; -- about the only global name in the addon
	local addonEnabled = true; -- local names are all ok		local addonEnabled = true; -- local names are all ok
	function MarksmanAddOn:GetArrowsCount()		function MarksmanAddOn:GetArrowsCount()
	... -- function is now inside the global table		v... -- function is now inside the global table
	end		end
	MarksmanAddOn.arrowsCount = MarksmanAddOn:GetArrowsCount()		MarksmanAddOn.arrowsCount = MarksmanAddOn:GetArrowsCount()
	</pre>		</pre>

	For large add-ons this can get complicated, and the current version of Lua doesn't offer much to help. Use a full, clear, name for the global table, and assign a shorter name in your .lua files, like:		For large add-ons this can get complicated, and the current version of Lua doesn't offer much to help. Use a full, clear, name for the global table, and assign a shorter name in your .lua files, like:
	<pre>		<pre>
	local mod = MarksmanAddOn;		local mod = MarksmanAddOn;

	-- then you can write		-- then you can write
	mod.arrowsCount = mod:GetArrowsCount()		mod.arrowsCount = mod:GetArrowsCount()
	</pre>		</pre>

Bear: /* TOC File */

2022-08-10T19:17:50Z

TOC File

← Older revision		Revision as of 19:17, 10 August 2022
Line 52:		Line 52:
	This is the file that instructs WoW in some basics about your AddOn and what other files you want loaded. Here's a short example of one. If you pasted this code into a 'MyAddOn.toc' file it would work as a beginning toc file:		This is the file that instructs WoW in some basics about your AddOn and what other files you want loaded. Here's a short example of one. If you pasted this code into a 'MyAddOn.toc' file it would work as a beginning toc file:

	## Interface: {{API LatestInterface}}		<pre>
	## Title : My AddOn		## Interface: {{API LatestInterface}}
	## Notes: This AddOn does nothing but display a frame with a button		## Title: My AddOn
	## Author: My Name		## Notes: This AddOn does nothing but display a frame with a button
	MyAddOn.xml		## Author: My Name
	MyAddOn.lua		MyAddOn.xml
			MyAddOn.lua
			</pre>

	You can read more about what you need or can put in a TOC over at [[The TOC Format]].		You can read more about what you need or can put in a TOC over at [[The TOC Format]].

Bear: /* XML Files */

2022-08-10T19:17:22Z

XML Files

← Older revision		Revision as of 19:17, 10 August 2022
Line 80:		Line 80:

	<pre>		<pre>
	<Script file="MyAddon.lua"/>		<Script file="MyAddon.lua"/>
	<Frame name="MyAddon">		<Frame name="MyAddon">
	<Scripts>		<Scripts>
	<OnLoad>		<OnLoad>
	MyAddon_OnLoad();		MyAddon_OnLoad();
	</OnLoad>		</OnLoad>
	</Scripts>		</Scripts>
	</Frame>		</Frame>
	</pre>		</pre>

Bear: /* Lua Files */

2022-08-10T19:17:08Z

Lua Files

← Older revision		Revision as of 19:17, 10 August 2022
Line 65:		Line 65:

	<pre>		<pre>
	function MyAddOn_OnLoad()		function MyAddOn_OnLoad()
	SlashCmdList["MyAddOn"] = MyAddOn_SlashCommand;		SlashCmdList["MyAddOn"] = MyAddOn_SlashCommand;
	SLASH_MYADDON1= "/myaddon";		SLASH_MYADDON1= "/myaddon";
	this:RegisterEvent("VARIABLES_LOADED")		this:RegisterEvent("VARIABLES_LOADED")
	end		end
	~~</pre>~~

	~~<pre>~~		function MyAddOn_SlashCommand()
	function MyAddOn_SlashCommand()		print("Hello, WoW!")
	print("Hello, WoW!")		end
	end
	</pre>		</pre>

Bear: /* Lua Files */

2022-08-10T19:16:30Z

Lua Files

← Older revision		Revision as of 19:16, 10 August 2022
Line 64:		Line 64:
	[[Lua]] files contain functional pieces of code. You may choose to only have one of these or break up your code into multiple files for a specific purpose. Here's a short example of one:		[[Lua]] files contain functional pieces of code. You may choose to only have one of these or break up your code into multiple files for a specific purpose. Here's a short example of one:

			<pre>
	function MyAddOn_OnLoad()		function MyAddOn_OnLoad()
	SlashCmdList["MyAddOn"] = MyAddOn_SlashCommand;		SlashCmdList["MyAddOn"] = MyAddOn_SlashCommand;
Line 69:		Line 70:
	this:RegisterEvent("VARIABLES_LOADED")		this:RegisterEvent("VARIABLES_LOADED")
	end		end
			</pre>

			<pre>
	function MyAddOn_SlashCommand()		function MyAddOn_SlashCommand()
	print("Hello, WoW!")		print("Hello, WoW!")
	end		end
			</pre>

	=== XML Files ===		=== XML Files ===

← Older revision		Revision as of 03:57, 15 August 2023
Line 2:		Line 2:
	The following is a guide for getting started with building WoW AddOns. Creating your own AddOns can be a difficult process at first, but can be very satisfying and is a great way to learn programming in general.		The following is a guide for getting started with building WoW AddOns. Creating your own AddOns can be a difficult process at first, but can be very satisfying and is a great way to learn programming in general.

	If you are mostly interested in what files and structure comprise a WoW AddOn, you can skip to [[WoW AddOn]], and come back here or move on from there.		If you are mostly interested in what files and structure comprise a WoW AddOn, you can skip to [[WoW:AddOn\|WoW AddOn]], and come back here or move on from there.

	== What should I make ==		== What should I make ==
Line 18:		Line 18:
	Research the programming environment:		Research the programming environment:
	* [[Lua]] - This is the programming language used by WoW for UI AddOns.		* [[Lua]] - This is the programming language used by WoW for UI AddOns.
	* [[~~WoW~~ AddOn]] - These pages explain the basic structure of a WoW AddOn.		* [[AddOn]] - These pages explain the basic structure of a WoW AddOn.
	* [[World of Warcraft API]] - These are the functions and ways to talk to WoW with Lua.		* [[World of Warcraft API]] - These are the functions and ways to talk to WoW with Lua.
	* [[Curse Forge]] or [[WoW Interface (site)\|WoW Interface]] - Find a real but simple example of an existing AddOn. Most real AddOns, even the simple ones, however can be difficult to read for getting started, with many moving parts.		* [[Curse Forge]] or [[WoW Interface (site)\|WoW Interface]] - Find a real but simple example of an existing AddOn. Most real AddOns, even the simple ones, however can be difficult to read for getting started, with many moving parts.
	* [[Lua editors]] - A long list of code editors and other tools often used by other AddOn creators.		* [[Lua editors]] - A long list of code editors and other tools often used by other AddOn creators.

	Start with making a simple AddOn that has almost no moving parts, where you can see what all of the basic parts are and move forward from there. Use the reference material described above, especially [[WoW AddOn]], as that describes what really makes up an AddOn.		Start with making a simple AddOn that has almost no moving parts, where you can see what all of the basic parts are and move forward from there. Use the reference material described above, especially in [[AddOn\|WoW AddOn]], as that describes what really makes up an AddOn.

	After completing your first one you will then have enough skill to start to build the real AddOn you wanted to originally make.		After completing your first one you will then have enough skill to start to build the real AddOn you wanted to originally make.
Line 45:		Line 45:
	=== File Types ===		=== File Types ===
	There are three main types of files that you'll need to worry about with AddOn editing:		There are three main types of files that you'll need to worry about with AddOn editing:
	* [[TOC ~~File~~]] - This file is required for any WoW AddOn, and supplies WoW with information about your AddOn and its files.		* [[TOC file]] - This file is required for any WoW AddOn, and supplies WoW with information about your AddOn and its files.
	* ~~Lua Files~~ - This contains Lua code for your AddOn.		* [[LUA file]] - This contains Lua code for your AddOn.
	* XML ~~Files~~ - This holds the layout of UI windows, buttons, and similar for your AddOn.		* [[XML file]] - This holds the layout of UI windows, buttons, and similar for your AddOn.

	=== TOC File ===		=== TOC File ===
Line 149:		Line 149:
	{{elink\|site=FreeKode.org\|link=http://freekode.org/wow-first-addon/\|desc=World of Warcraft first addon\|bydate=May 3, 2015}}		{{elink\|site=FreeKode.org\|link=http://freekode.org/wow-first-addon/\|desc=World of Warcraft first addon\|bydate=May 3, 2015}}
	{{elink\|prefix=     \|site=GitHub\|link=https://github.com/freekode/TestAddon/\|desc=freekode/TestAddon}}		{{elink\|prefix=     \|site=GitHub\|link=https://github.com/freekode/TestAddon/\|desc=freekode/TestAddon}}
	[[Category:HOWTOs~~\|Get Started~~]]		[[Category:WoW HOWTOs]]