Addonstructure - Revision history

Celtic Minstrel: /* The Main File */ Slight clarification on the iportance of _main.cfg

2020-11-08T22:51:18Z

‎The Main File: Slight clarification on the iportance of _main.cfg

Celtic Minstrel: /* The Main File */ Hyphens also make a good space substitute

2020-11-08T22:50:19Z

‎The Main File: Hyphens also make a good space substitute

Celtic Minstrel: /* The Directory Structure */ The terrain subdirectory of images is not just a convention

2020-11-08T22:49:16Z

‎The Directory Structure: The terrain subdirectory of images is not just a convention

Octalot: /* The Directory Structure */ Full overhaul

2020-11-08T21:53:38Z

‎The Directory Structure: Full overhaul

Celtic Minstrel: /* The Main File */ Use syntax highlighting

2019-08-25T04:38:35Z

‎The Main File: Use syntax highlighting

Celtic Minstrel: /* The Main File */ [+units] is no longer required

2019-08-25T04:36:08Z

‎The Main File: [+units] is no longer required

Shadowm at 02:38, 12 August 2017

2017-08-12T02:38:16Z

Vanfans at 12:17, 13 March 2017

2017-03-13T12:17:27Z

Vanfans at 12:16, 13 March 2017

2017-03-13T12:16:05Z

Vultraz: /* The Main File */

2014-03-16T17:45:24Z

‎The Main File

@@ Line 14: / Line 14: @@
 <b>Important:</b> Remember to use underscores or hyphens in all directory and file names instead of spaces. Failure to do so will result in your content not working properly.
-*Create a file called <b>_main.cfg</b> inside the A_Simple_Addon folder.
+*Create a file called <b>_main.cfg</b> inside the A_Simple_Addon folder. Without this file, the game will not even recognize that your add-on exists.
 The _main.cfg file will instruct the game on how to load your content. Here is shown a very simple example of the file.

@@ Line 12: / Line 12: @@
 *Create the empty directory <b><i>userdata</i>/data/add-ons/A_Simple_Addon</b>.
-<b>Important:</b> Remember to use underscores in all directory and file names instead of spaces. Failure to do so will result in your content not working properly.
+<b>Important:</b> Remember to use underscores or hyphens in all directory and file names instead of spaces. Failure to do so will result in your content not working properly.
 *Create a file called <b>_main.cfg</b> inside the A_Simple_Addon folder.

@@ Line 72: / Line 72: @@
 *<b><i>userdata</i>/data/add-ons/A_Simple_Addon/images/attacks</b> Icons for each attack, see [[UnitTypeWML#Attacks]]'s documentation for '''icon'''
 While Lua can be embedded in WML files, the following directory is supported for loading them via Lua's <b>wesnoth.require "<i>module_name</i>"</b>.
@@ Line 96: / Line 97: @@
 *<b><i>userdata</i>/data/add-ons/A_Simple_Addon/images/portraits</b> for '''[unit_type]profile='''
 *<b><i>userdata</i>/data/add-ons/A_Simple_Addon/images/story</b> backgrounds for '''[story]''' screens
 *<b><i>userdata</i>/data/add-ons/A_Simple_Addon/images/units</b> for '''[unit_type]image=''', etc

@@ Line 57: / Line 57: @@
 *<b><i>userdata</i>/data/add-ons/A_Simple_Addon/maps</b>
 All map files used in scenarios go in <b>maps</b> (see [[BuildingMaps]]. All configuration (‘.cfg’) files for scenarios go in <b>scenarios</b> (see [[BuildingScenarios]]).
-If you have additional custom content such as images or units, create the respective following:
+If you have additional custom content such as images, sounds or music, it's necessary to create additional directories. Even for other custom content, creating directories to organise it is recommended.
 *<b><i>userdata</i>/data/add-ons/A_Simple_Addon/images</b>
 *<b><i>userdata</i>/data/add-ons/A_Simple_Addon/music</b>
 *<b><i>userdata</i>/data/add-ons/A_Simple_Addon/sounds</b>
-<b>Important:</b> You may name the directories containing code (such as <b>scenarios</b> and <b>macros</b>) anything you like, but the three binary content directories (<b>images</b>, <b>music</b>, and <b>sounds</b>) <b>must</b> be named as such and be relative to your [binary_path]. This is because when trying to resolve an image path, Wesnoth will look under images/, and likewise for sounds and music, in [binary_path].
+Some subdirectories of <b>images</b> are also supported by the engine:
 If you set up a textdomain, create a <b>translations</b> directory, even if it remains empty. Failure to do so generates a warning in stderr. This path <b>must</b> be the same as specified in the [textdomain] tag.
 *<b><i>userdata</i>/data/add-ons/A_Simple_Addon/translations</b>
 ==See also==

@@ Line 18: / Line 18: @@
 The _main.cfg file will instruct the game on how to load your content. Here is shown a very simple example of the file.
- #textdomain wesnoth-A_Simple_Addon
+<syntaxhighlight lang=wml>
- [textdomain]
+#textdomain wesnoth-A_Simple_Addon
-     name="wesnoth-A_Simple_Addon"
+[textdomain]
-     path="data/add-ons/A_Simple_Addon/translations"
+    name="wesnoth-A_Simple_Addon"
- [/textdomain]
+    path="data/add-ons/A_Simple_Addon/translations"
 [/textdomain]
- #ifdef MULTIPLAYER
- [binary_path]
+#ifdef MULTIPLAYER
-     path=data/add-ons/A_Simple_Addon
+[binary_path]
- [/binary_path]
+    path=data/add-ons/A_Simple_Addon
 [/binary_path]
- {~add-ons/A_Simple_Addon/scenarios}
- #endif
+{~add-ons/A_Simple_Addon/scenarios}
 The [textdomain] WML tag specifies where the game should look for translations to the strings in the add-on. The textdomain should be the add-on's directory name prefixed with <b>"wesnoth-"</b>, to ensure that it does not conflict with other textdomains that might be specified on a given system and is compatible with [[WesCamp]].
@@ Line 40: / Line 42: @@
 <b>Note:</b> Only <b>code</b> must be included from this file. You <b>do not</b> need to include binary content (such as sounds, images, or music). Those may be referred to simply by path relative to the one specified in [binary_path]. Also, including the <b>units</b> directory cannot be done by a simple path inclusion; it also must be wrapped in a <b>[units][/units]</b> tag pair, as such:
- [units]
+<syntaxhighlight lang=wml>
-     {~add-ons/A_Simple_Addon/units}
+[units]
- [/units]
+    {~add-ons/A_Simple_Addon/units}
 == The Directory Structure ==

@@ Line 38: / Line 38: @@
 All tags save for [campaign] and [textdomain] <b>must</b> be enclosed in an <b>#ifdef</b> preprocessor conditional - including those substituted through inclusion (see [[PreprocessorRef]] for more information). This is to make sure your content only loads at the correct time and does not conflict with other add-ons. In the example above, the scenarios will be loaded when you enter multiplayer mode. In a campaign, you can set up a specific flag to allow your content to only load when that campaign is played.
-<b>Note:</b> Only <b>code</b> must be included from this file. You <b>do not</b> need to include binary content (such as sounds, images, or music). Those may be referred to simply by path relative to the one specified in [binary_path]. Also, including the <b>units</b> directory cannot be done by a simple path inclusion; it also must be wrapped in a <b>[+units][/units]</b> (the <b>+</b> is very important!) tag pair, as such:
+<b>Note:</b> Only <b>code</b> must be included from this file. You <b>do not</b> need to include binary content (such as sounds, images, or music). Those may be referred to simply by path relative to the one specified in [binary_path]. Also, including the <b>units</b> directory cannot be done by a simple path inclusion; it also must be wrapped in a <b>[units][/units]</b> tag pair, as such:
-  [+units]
+  [units]
       {~add-ons/A_Simple_Addon/units}
   [/units]

← Older revision		Revision as of 02:38, 12 August 2017
Line 1:		Line 1:
		+	{{Translations}}
	{{Create}}		{{Create}}
−
−	~~{\| {{Prettytable}}~~
−	\|-
−	~~!\|Other languages:~~
−	~~[[AddonStructure\|English]]~~
−	~~[[AddonStructure/zh\|简体中文]]~~
−	\|}

	In order to create custom content for Wesnoth, you need to set up a folder in <i>userdata</i>/data/add-ons/. If you have not found your userdata directory yet, read [[EditingWesnoth]] and come back here. This page will explain the basic directory structure of an add-on and where stuff goes.		In order to create custom content for Wesnoth, you need to set up a folder in <i>userdata</i>/data/add-ons/. If you have not found your userdata directory yet, read [[EditingWesnoth]] and come back here. This page will explain the basic directory structure of an add-on and where stuff goes.

@@ Line 4: / Line 4: @@
 |-
 !|Other languages:
-[[Create|English]]
+[[AddonStructure|English]]
-[[Create/zh-Hans|简体中文]]
+[[AddonStructure/zh|简体中文]]
 |}

← Older revision		Revision as of 12:16, 13 March 2017
Line 1:		Line 1:
	{{Create}}		{{Create}}
		+
		+	{\| {{Prettytable}}
		+	\|-
		+	!\|Other languages:
		+	[[Create\|English]]
		+	[[Create/zh-Hans\|简体中文]]
		+	\|}

	In order to create custom content for Wesnoth, you need to set up a folder in <i>userdata</i>/data/add-ons/. If you have not found your userdata directory yet, read [[EditingWesnoth]] and come back here. This page will explain the basic directory structure of an add-on and where stuff goes.		In order to create custom content for Wesnoth, you need to set up a folder in <i>userdata</i>/data/add-ons/. If you have not found your userdata directory yet, read [[EditingWesnoth]] and come back here. This page will explain the basic directory structure of an add-on and where stuff goes.