BuildingScenarios
Wesnoth scenarios are the individual levels within the game. Or they can be advanced multiplayer maps, with extra characters and items and such. Each scenario contains two files. First is the map itself, this is described in BuildingMaps. The second is the config file. This configuration file is used to describe everything about the scenario. Both of the files are ascii and can be edited in any standard text editor (vi, notepad, etc.) If you decide to use a wordprocessor, please make sure you remember to Save As text (preferably with a .cfg extension).
This document is split into several sections, starting with a basic tutorial and moving into more complex techniques. From the information contained within this document you should have all the knowledge to create Wesnoth scenarios.
Remember that you can use all of the standard scenario files for reference. Sometimes an example is what you really need anyways. Between the campaigns included with the distribution, probably a lot of the game engine features have been used.
If you still don't understand something or can't get it to work, you can ask for assistance in the WML Workshop.
The Wesnoth Markup Language
Scenarios are written in the Wesnoth Markup Language, a custom language written specially to work with the game. It sports a relatively simple tag/key-based syntax. A complete guide to the WML syntax can be found on the SyntaxWML page.
Quick Tag Index
Below follows an index of tags WML supports, with descriptions on their usage and individual tag keys.
- ScenarioWML the top level tags [scenario], [multiplayer], [test], and [tutorial]
- IntroWML how to describe the intro screen
- TimeWML how to describe a day
- SideWML how to describe a side
- EventWML how to describe an event
- MapGeneratorWML the random map generator
- UtilWML a set of preprocessors you can use
Sample Code
A nice collection of simple beginner code to look at is documented on the Samples page
Scenarios and the Map Editor
As of Wesnoth 1.12, the Map Editor has become more fully featured, and includes options to define more basic scenario-related content for your scenario, such as name, unit placement, graphical items, time of day schedules, etc, without having to manually write the code yourself. However, the editor cannot create more complex WML. Those interesting snippets still have to be written by hand. These functions are most useful for creating a simple scenario from a map, or streamlining your workflow in creating a more complicated scenario.
NOTE: Scenario-specific content will not be saved unless you select the File -> Save Scenario option. Otherwise, you will simply get a map file.
See Also
- ReferenceWML - WML master reference
- AlphabeticalWML - a tag index
- BuildingScenariosIndex - in-depth key and tag index
