EditingWesnoth
Template:EditingWesnoth/Translations
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.
Contents
The game data directory
The data directory will be wherever you installed the game, alongside there subdirectories: music, sounds, images. There are several others, but these are the important ones. You don't need to pay attention to them right now.
Inside the data folder you will find a folder called core. This folder contains another set of music, sounds, images (as well as others) folders. These contain all the resources shipped with the game for use in mainline and UMC campaigns. These are the ones you'll usually look for resources in when designing your content.
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 director.
The major directories you need to know about are wesnoth/data, wesnoth/data/core/units, wesnoth/data/campaigns, wesnoth/data/multiplayer, wesnoth/images and wesnoth/data/core/images
Become familiar with what is in wesnoth/data/campaigns and wesnoth/data/multiplayer/scenarios. These have the officially distributed campaigns and multiplayer maps. If you ever want to examine or edit one of the scenario configuration files, this is where you would go.
Two very important directories are ./data/core/units/ and ./images. You have the ability to drop new units or images in these directories and have the game recognize them. When specifying an image for something, you do so relative to ./images.
How to get there
Windows
- X:\Program Files\Battle for Wesnoth <version>\data, where X: corresponds to the drive where Windows is installed (normally C:).
- On 64-bit computers, it will be in X:\Program Files (x86)\Battle for Wesnoth <version>\data.
- 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
- SourceForge.net bundle or XCode builds: Control+click on the application icon. Select "Show Package Contents." Select "Contents", then "Resources".
- Custom builds: /usr/local/share/wesnoth
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
- BfW 1.8 and later, if you did not choose "Store userdata in the install location" when installing the game and you launch the game using the start menu shortcut:
- Windows 2000/XP:
My Documents\My Games\Wesnoth<version> - Windows Vista/7/8:
Documents\My Games\Wesnoth<version>
- Windows 2000/XP:
- If any of the above does not apply:
- The
userdatasubdirectory of the install location (usuallyC:\Program Files\Battle for Wesnoth <version>\userdata). - 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>
- The
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
- SourceForge.net bundle: ~/Library/Application Support/Wesnoth_1.x/ (1.8 and later), or ~/Library/Preferences/Wesnoth (older versions). As of OS X 10.7, this location is hidden by default. Push "alt" (⌥) and use "Go" to access the Library then find ~/Library/Application Support/Wesnoth_1.x/
- Custom builds: same as Linux - see below for details.
Linux
- Wesnoth 1.10: ~/.local/share/wesnoth/1.10
- Wesnoth 1.9: ~/.local/share/wesnoth/1.9
- Wesnoth 1.8: ~/.wesnoth1.8
- Older versions: ~/.wesnoth
In a terminal, the command wesnoth --config-path shows the user data directory.
BSD
- Same place as Linux.