SideWML

2009-02-15T11:32:51Z

Lord Ork: /* the [side] tag */ Note: the ai ignores fog and shroud

{{WML Tags}}
== the [side] tag ==

The [side] tag is used to describe a side in a particular scenario.

The following keys are recognized:

* '''side''': a digit. The leader of this side is placed on the tile represented by this digit (see [[BuildingMaps]]). When defining sides, they must be defined in order since the side number is checked against the number of sides seen so far.

* '''controller''': how moves for this side should be inputted.
** '''ai''': the Wesnoth AI makes this side's moves. This is the default setting.
** '''human''': a player controls this side's moves.
** '''null''': the side doesn't get a turn to move and doesn't have a leader generated from the contents of the [side] tag. (It still can get units from [unit] tags in the [side] tag.)

* '''no_leader''': if "no" (default), then keys describing a unit which will begin on the side's keep will be the remainder of the '''[side]''' tag, See [[SingleUnitWML]]. Note that if the keys '''x''', '''y''' are included, the leader will begin there regardless of keep location. If this side has a recall list from a previous level, then the recall list will be searched for a leader (using '''canrecruit=yes''') and if one is found it will be used instead of the one described in the '''[side]''' tag. Typical keys used for defining the leader unit are '''type''' (mandatory), '''description''', '''id''' {{DevFeature}}, '''user_description''', '''name''' {{DevFeature}} and '''unrenamable=yes''', see [[UnitWML]].

* '''recruit''': a list of unit types. At the beginning of the scenario, the side gains recruitment of these units.

* '''gold''': the starting gold for this side. Default 100. (If gold is carried over from a previous scenario, this value is the minimum starting gold.)

* '''income''': the base income for this side, default 0. This is added to ''base_income'', '''[game_config]''' to determine the side's base income. (see [[GameConfigWML]]).

* '''fog''': if 'yes', this side cannot see any tiles it is not within vision of, except at the start. Please note that the AI currently ignores the fog.

* '''shroud''': if 'yes', this side cannot see any tiles it has not moved within sight of. Please note that the AI currently ignores the shroud.

* '''shroud_data''': describes the area which this team has de-shrouded. An example:
|
|00011111000
This would leave the first column on the map unaltered and would change the second column for 11 tiles. A '0' means: shrouded, '1' means unshrouded. You can either call an external file using {@filename} (see [[PreprocessorRef]]) or place the data in quotes. For making an external file see [[BuildingScenariosShroudData]].

* '''persistent''': whether the side exists in any other scenarios. If '1'(yes), then ''save_id''(see below) becomes active for this side. Default '0'(no); when '''controller=human''', this is always '1'.

* '''save_id''': default ''description'' if available, 'Unknown' otherwise. The ID of the side with respect to the previous and next scenarios. Used to carry over the side's recall list (including the side's leader), recruitment list, and starting gold from scenario to scenario. Also used for the side's displayed name in the victory gold-calculation dialog. See [[SideSwitchingWML]].

* '''team_name''': a non translatable string representing the team's description. Sides with the same team_name are allied. Default ''side''.

* '''user_team_name''': a translatable string representing the team's description. This has no effect on alliances. Default ''team_name''.

* '''colour''': May be either a numeric color index or a color name (e.g. 'blue', 'purple', 'orange', etc.). The numeric form is deprecated. The default list of numbers and corresponding colours can be found in data/core/team_colors.cfg.

* '''flag''': a custom flag animation to use instead of the default one to mark captured villages. An automatic side-coloring is applied.
** Example animation that has three frames and loops every 750ms: ''flag=misc/myflag-1.png:250,misc/myflag-2.png:250,misc/myflag-3.png:250''

* '''flag_icon''': a custom flag icon to indicate the side playing in the statusbar (a size of 24x16 is recommended). An automatic side-coloring is applied.

* '''village_gold''': the amount of gold given to this side per village it controls per turn. Default specified in ''village_income'', '''[game_config]''' ([[GameConfigWML]]). '''Note:''' If you need village gold to be 0. Set the variable to -1.

* '''share_maps''': whether sides allied with this side see all terrains that this side sees, if they are on shroud.

* '''share_view''': whether sides allied with this side see the units that this side sees, if they are on FoW (fog).

* '''disallow_observers''': prevents observers from seeing this side turn. (default: no)

* '''[ai]''' if '''controller=ai''', gives parameters to the AI. See [[AiWML]].

* '''[village]''' describes a village the side begins in control of.
** ''x'', ''y'' the location of the village. If the pair of coordinates is not a village or is duplicated in another [village] tag, behaviour is undefined. Recent game engine or wmllint should warn about these.

* '''[unit]''' describes a unit which begins on the side. See [[SingleUnitWML]]. If the side has a recall list and the unit is not given a location, it will start on the recall list. Note that the ''side'' attribute under '''[unit]''' will be ignored, as the side will come from the ''side'' attribute of '''[side]'''.

The following keys are multiplayer only:

* '''allow_player''': if false then this side will not be allowed to be modified and will be hidden during game creation.

* '''team_lock''': if true then this side's team is not allowed to be modified.

* '''colour_lock''': if true then this side's color is not allowed to be modified.

* '''gold_lock''': if true then this side's gold is not allowed to be modified.

* '''income_lock''': if true then this side's income is not allowed to be modified.

* '''faction''': this lock this side to this faction.

* '''faction_from_recruit''' {{DevFeature}}: if true then this side will be locked to the faction that matches the recruits better. (this was enabled by default in 1.4)

== See Also ==
* [[EraWML]]
* [[ScenarioWML]]
* [[ReferenceWML]]

[[Category: WML Reference]]

Create

2009-02-11T17:42:52Z

Lord Ork: /* Miscellaneous */ Fixed FAQ link

{| style="float:right"
|
__TOC__
|}

Interested in creating your own scenarios and campaigns? One of Wesnoth's best features is its extensibility. Players can create new maps, units, races, scenarios, art, music, and even entire campaigns. Access to the "guts" of the game is both simple and difficult; if you have an ASCII text editor you have everything you need to build your own world. However, learning the Wesnoth Markup Language (WML) takes some effort. This section will guide you through the process of creating and distributing your own content.

It should also be noted that '''we need a lot of help creating artwork for the core of the game.''' The current projects we are working on are [http://www.wesnoth.org/forum/viewtopic.php?t=2014&start=0&postdays=0&postorder=asc&highlight= listed here]. We'll happily help you out, if you take a swing at them.

== Read this first! ==
Before you modify or add anything, it is important to understand how the game stores and organizes its data. This article will explain the game's directory structure and introduce the ''userdata'' directory.
* [[EditingWesnoth]]

== What can I create, and how? ==

<div class="thumb tright"><div>
[http://www.wesnoth.org/images/sshots/wesnoth-1.4-4.jpg http://www.wesnoth.org/images/sshots/wesnoth-1.4-4-175.jpg]
<div class="thumbcaption">Battle for Wesnoth map editor</div></div>
</div>

* [[BuildingMaps|Maps]] - the layout of terrain tiles
* [[BuildingScenarios|Scenarios]] - a scenario makes things happen on a map, making it playable
* [[BuildingCampaigns|Campaigns]] - how to put it all together into a campaign
* [[BuildingMultiplayer|Multiplayer Maps and Scenarios]] - a specialized look at maps and scenarios
* [[MultiplayerCampaigns|Multiplayer Campaigns]] - making a campaign accessible in multiplayer

* [[BuildingUnits|Units]]
* [[BuildingFactions|Multiplayer factions and eras]]

* '''[[Create Art|Art]]''' - complete with '''tutorials!'''
* [[Create Music|Music]]
* [[WesnothTranslations|Translations]] - work on translating Wesnoth

* [[Distributing content]] - all about the campaign server
* [[Authoring tools]] - tools for helping you write campaign WML
* [[Maintenance tools]] - tools for helping you sanity-check and maintain campaigns.

== What have others done? ==

There are a multitude of multiplayer maps and discussion of the campaigns on the [http://www.wesnoth.org/forum Wesnoth forum]
* [http://www.wesnoth.org/forum/viewforum.php?f=15 Multiplayer development forum]
* [http://www.wesnoth.org/forum/viewforum.php?f=8 Scenario and campaign development forum]
* [[Faction|Complete faction list]]

If you want to be creative without having to invent an entire new campaign,
see this thread on [http://www.wesnoth.org/forum/viewtopic.php?t=17171 abandoned campaigns]. You should be able to pick one of these up and complete it with much less effort than doing an all-new one.

== The world of Wesnoth ==
Not all campaigns take place in Wesnoth, but many do. There is definitely a certain flavor to campaigns that are intended to take place somewhere in the world of Wesnoth. Stake out a time period or a map locale and tell a story.
* [[History of Wesnoth|The history of Wesnoth]]
* [[Geography of Wesnoth|The geography of Wesnoth]]
* [[Races|The races of creatures in Wesnoth]]
* [[Religion|Religion in Wesnoth]]
* [[Poetry of Wesnoth|Wesnothian poetry]]
* [[Fan fiction]]

== Miscellaneous ==
* [[ExternalUtilities| External Utilities]] - some extra tools for easier creating stuff
* [[ReferenceWML|WML Reference]] - a quicklink
* [[FAQ#Maps.2C_Scenarios_and_Campaigns|FAQ]] - if you have a question, post it
* Campaign server [http://wolff.to/campaigns/list.html web interface] - An alternate way to download user campaigns

<div style="border:1px solid #5599FF; margin-top: 10px; margin-bottom: 5px; padding: 5px;">
- [[Create|English]] - [[Créer vf|Français]] -
</div>

[[Category:Create|*]]

The Battle for Wesnoth Wiki - User contributions [en]

SideWML

Create