EditingWesnoth

In order to create custom content for Wesnoth, you need to know where the game's resources are and where to put your own. This page will explain how to find both the data (core game resources) and userdata (custom content) directories, as well as an explanation as to working with each one.

Game paths

The simplest way to find your game and userdata directories is to go to Preferences → General → Paths (shown on the right). From here you can copy respective the paths to your clipboard or open them in your platform's file manager. If you want more detailed explanations on the specific locations for your specific system, you can read the How to get there sections below.

The game data directory

Wherever you installed the game, you will find these folders, among others: data, music, sounds, images. The rest are unimportant unless you're a developer looking to tweak stuff about the game itself. Besides data, they contain resources used by the game, not by campaigns.

Inside the data folder you will find , among others, these folders: campaigns, multiplayer, core. These contain the mainline campaigns, the multiplayer maps and scenarios, and all the resources used in add-ons. You may examine the contents of the former for reference on how the campaigns and maps included in mainline are coded. In core, you will find another set of music, sounds, images directories. Look in here to find resources for creating your UMC content.

NOTE: These folders are NOT the place to put your own resources when creating an add-on. You should keep them in your add-on's folder the userdata directory, as detailed below.

In this wiki, the terms "game data", wesnoth/data, or ./data refer to the wesnoth/data directory. The terms "core folder" or core refer to the wesnoth/data/core directory.

How to get there

Windows

• On 32-bit computers: X:\Program Files\Battle for Wesnoth <version>\data
• On 64-bit computers: X:\Program Files (x86)\Battle for Wesnoth <version>\data

Note: X refers to the drive Windows is installed on, usually C. The path may be different if you originally chose to install the game in a different location. In such case, look for the data folder in the folder where you installed the game.

Mac OS X

• Control+click on the application icon. Select "Show Package Contents", then navigate to "Contents" → "Resources".

Linux

• Custom builds: /usr/local/share/wesnoth
• Debian/Ubuntu packages, or emerge (Gentoo): /usr/share/games/wesnoth
• Red Hat Linux-based distributions in general (openSUSE, Fedora): '/usr/share/wesnoth
• Mandriva: /usr/share/games/wesnoth
• Slackware Linux: /usr/local/share/wesnoth

In a terminal, the command wesnoth --path shows the game data directory.

BSD

• OpenBSD package: /usr/local/share/wesnoth

The command wesnoth --path also works.

The user data directory

The user data directory in particular is the most important to a content creator. Inside are your preferences file, custom maps, saved games, the WML cache and data files corresponding to user-created content. In this wiki, "user data" and userdata/ refer to this directory.

The user data directory can do a lot of things. The game looks here for several things:

• userdata/data/add-ons - add-ons you have installed via the built-in add-on manager or are designing yourself
• userdata/editor/maps - multiplayer standalone maps (map data only)

The add-ons directory is particularly useful. In order to work with custom scenarios or campaigns, you will need to have your own add-on set up here. Several pages on this wiki will assume you have done so and refer to relative paths in such.

The following files and directories are mandatory for a simple add-on (assuming your add-on is called MyCampaign):

• userdata/data/add-ons/MyCampaign/ - your campaign's directory
• userdata/data/add-ons/MyCampaign/_main.cfg - a text file containing your instructions for the game about how to load the campaign
• userdata/data/add-ons/MyCampaign/scenarios
• userdata/data/add-ons/MyCampaign/maps

The following are optional, and are used if you create your own custom units, images, etc:

• userdata/data/add-ons/MyCampaign/units
• userdata/data/add-ons/MyCampaign/images
• userdata/data/add-ons/MyCampaign/music
• userdata/data/add-ons/MyCampaign/sounds
• userdata/data/add-ons/MyCampaign/macros

How to get there

Windows

• If you did not choose "Store userdata in the install location" when installing the game:
  • Windows 2000/XP: My Documents\My Games\Wesnoth<version>
  • Windows Vista/7/8: Documents\My Games\Wesnoth<version>
• If you did choose "Store userdata in the install location" when installing the game:
  • The userdata subdirectory of the install location (usually C:\Program Files\Battle for Wesnoth <version>\userdata (Program Files (x86) on 64 bit computers)).

• • Note (Windows Vista/7): Writes to this directory may be silently redirected to the "Virtual Store", typically C:\Users\<yourname>\AppData\Local\VirtualStore\Program Files\Battle for Wesnoth <version>

Note: If you don't remember where you installed the game, right click on the game's shortcut, open properties, and click on the "Find target" button.

Note: To find the Virtual Store using Windows Explorer, you need to make hidden files visible. This can be done from Explorer's "Folder Options" menu option -> "View" tab -> "Show hidden files, folders, and drives". Alternatively, the hidden directory can be accessed by typing "shell:local appdata" in Explorer's address bar.

Mac OS X

• ~/Library/Application Support/Wesnoth_<version>/. As of OS X 10.7, the Library folder is hidden by default. Push "alt" and use "Go" to access the it.

Linux

• ~/.local/share/wesnoth/<version>

In a terminal, the command wesnoth --config-path shows the user data directory.

BSD

• Same place as Linux.

See Also

• Create