The Battle for Wesnoth Wiki - User contributions [en]

GetText

2007-08-15T23:39:22Z

HaJo:

== GNU gettext in Wesnoth ==
* [[GettextForWesnothDevelopers]]
* [[GettextForTranslators]]

* Homepage: http://www.gnu.org/software/gettext
* Manual: http://www.gnu.org/software/gettext/manual/gettext.html

GetText

2007-08-15T23:38:56Z

HaJo: gettext-homepage

== GNU gettext in Wesnoth ==
* [[GettextForWesnothDevelopers]]
* [[GettextForTranslators]]

Homepage: http://www.gnu.org/software/gettext
Manual: http://www.gnu.org/software/gettext/manual/gettext.html

CodingStandards

2007-08-15T13:12:59Z

HaJo:

Wesnoth uses modern/advanced C++ that is portable to Visual C++ 6 and GNU G++ 3.0+

== Formatting ==

Indent with a tab character (width 4 characters), but align with spaces so tab width can change.

You may use long lines. (Could we change this to max 80 columns per line? --TuukkaH)

=== How to on Emacs? ===

M-x set-variable tab-width 4
M-x set-variable c-basic-offset 4

How to set alignment to use spaces?

== Naming ==

=== End Non-Public Members of Classes with an Underscore ===

All non-public data members of classes should have their names terminated with an underscore, to show that they are a
class member. This makes for more readable code, once one is familiar with the convention.

== Idioms ==

=== Use References when a value may not be NULL ===

If a value passed to a function can never be NULL, use a reference instead of a pointer. I.e.

void myfunction(Object& obj);

rather than

void myfunction(Object* obj);

This more clearly shows the user of the function that obj may never be NULL,
without them having to consult documentation or the implementation of the function.

=== Use Const ===

The 'const' feature of C++ allows interfaces to more clearly specify how they treat objects.
Always use const when you are not going to modify an object.

I.e.

void myfunction(const Object& obj);

demonstrates to the caller of myfunction() that obj will not be modified.
If myfunction may modify obj, then use

void myfunction(Object& obj);

likewise, if a variable is not changed after initialization, make it const.

=== Write Exception-Safe Code ===

Wesnoth code should be exception-safe, even if you do not use exceptions directly.
That is, you should be able to assume that an exception is thrown almost anywhere
from within the code, with well-defined results (i.e. no resource leaks).

Code that uses a pattern like,

{
SDL_Surface* image = IMG_Load("image.bmp");
...some code, which uses 'image'...
SDL_FreeSurface(image);
}

is bad, because the code may throw an exception, and 'image' will never be freed.
Instead, use wrapper objects which free the object in their destructor.

For SDL_Surface objects, use the <tt>surface</tt> class.
So you could rewrite the above code,

{
surface image(IMG_Load("image.bmp"));
...some code, which uses 'image'...
} ''the image is automatically freed here when 'image' is destroyed

Instead of allocating memory directly using new[] or malloc(),
use language-provided containers, such as vector.

=== Do not use sprintf ===

Sprintf does not check whether or not it is writing past the end of the space allocated.
This is a security problem if someone other than the person running the game
can cause sprintf to write very long strings.
In Wesnoth this untrusted data could come potentially from other players
in a multiplayer game or from downloaded campaigns.
Instead you should use snprintf with the second argument being sizeof of the buffer
that will hold the result.

== Standard C++ to avoid ==

=== Respect for loop scoping of different platforms ===

In the code,

for(int i = 0; i != 100; ++i) {...}

the variable 'i' is scoped within the for loop according to ISO/ANSI C++ and GNU G++.
However it is scoped within the surrounding scope according to Visual C++ 6.

This means that the code,

for(int i = 0; i != 100; ++i) {}
for(int i = 0; i != 100; ++i) {}

is illegal on VC++6, because i is defined twice,
although it is legal according to the standard, and GNU G++.

On VC++6, the legal way to write it would be,

for(int i = 0; i != 100; ++i) {}
for(i = 0; i != 100; ++i) {}

But this is illegal according to the standard, because 'i' is not defined in the second loop.
The correct way to write this code to conform to the standard and work on all platforms
is to simply abandon declaring variables in the initialization statement of a for loop
when the variable must be reused in the same scope,

int i;
for(i = 0; i != 100; ++i) {}
for(i = 0; i != 100; ++i) {}

=== Do not use wstring ===

The standard C++ wstring class, defined as a basic_string< wchar_t >,
does not exist in some platforms supported by Wesnoth.
Use wide_string, defined in language.hpp, instead.
wide_string is actually defined as a vector< wchar_t >

== C legacy to be avoided ==

=== Use the function templates minimum and maximum ===

Standard C++ offers the function templates min and max to find the minimum and maximum
of two values on which operator
<
is defined.
Unfortunately, many hoops must be leapt through to get this working on VC++.
So, we do not use standard min and max.
Instead, we use minimum and maximum, defined in utils.hpp.

Usage is fairly natural:

int i = minimum(x,y);

Note that in the above example, if x is an unsigned integer, and y is a signed integer,
VC++ will have problems.
You must explicitly specify the version of minimum being called in such cases:

int i = minimum<int>(x,y);

=== Use util::array instead of C-style Arrays ===

C-style arrays are very efficient, but their interface is ugly.
Use util::array defined in array.hpp.
It is a wrapper for an array which has a C++ container-style interface.
If you need to, extend it to make it fit your needs.

=== Do not use C-style casts ===

The following code,

if(i->second.side() == (size_t)player_number_) {

is considered bad practice in C++ since a C-style cast is overpowered -- if types change around it could end up casting away constness, or performing an implementation-defined data reinterpretation (basically a C-style cast is a compiler generated combination of static_cast, reinterpret_cast, and const_cast).

Good programming style is to use the least powerful tool available that does what you want.
For example,

if(i->second.side() == static_cast<size_t>(player_number_)) {

Alternatively, a constructor call may be used for non-builtin types.

Note: there may be some obscure cases where a C-style cast is desirable,
such as converting a pointer to an integer type of unspecified size.

== Documentation ==

=== Document "config" preconditions and postconditions ===

In the Wesnoth code you will commonly encounter a data container known as the "config",
which contains heirarchical string data (such as WML contents or game settings).
The tagged "children" of the config and their string "attributes" are arranged
in an ordered and mapped format internally using STL.

Because config data is utilized in so many ways and places, it can be difficult to track across the scope of the entire program. You should document all public functions that take/return a config, specifying config content expectations (and updating any related entries in the [[ReferenceWML]] wiki pages).
In particular, if your function requires a config parameter, specify where/how the config should be created. This will be a great help to any future coders who need to call or modify your function.

=== Doxygen ===
See [[Doxygen]] for tips on how to comment the code,
so that doxygen can nicely document it.

== See also ==
* [[HackingWesnoth]]

[[Category:Programmers]]
[[Category:Committers]]

CodingStandards

2007-08-15T13:09:05Z

HaJo: Doxygen

Wesnoth uses modern/advanced C++ that is portable to Visual C++ 6 and GNU G++ 3.0+

== Formatting ==

Indent with a tab character (width 4 characters), but align with spaces so tab width can change.

You may use long lines. (Could we change this to max 80 columns per line? --TuukkaH)

=== How to on Emacs? ===

M-x set-variable tab-width 4
M-x set-variable c-basic-offset 4

How to set alignment to use spaces?

== Naming ==

=== End Non-Public Members of Classes with an Underscore ===

All non-public data members of classes should have their names terminated with an underscore, to show that they are a
class member. This makes for more readable code, once one is familiar with the convention.

== Idioms ==

=== Use References when a value may not be NULL ===

If a value passed to a function can never be NULL, use a reference instead of a pointer. I.e.

void myfunction(Object& obj);

rather than

void myfunction(Object* obj);

This more clearly shows the user of the function that obj may never be NULL, without them having to consult
documentation or the implementation of the function.

=== Use Const ===

The 'const' feature of C++ allows interfaces to more clearly specify how they treat objects. Always use const when you
are not going to modify an object.

I.e.

void myfunction(const Object& obj);

demonstrates to the caller of myfunction() that obj will not be modified. If myfunction may modify obj, then use

void myfunction(Object& obj);

likewise, if a variable is not changed after initialization, make it const.

=== Write Exception-Safe Code ===

Wesnoth code should be exception-safe, even if you do not use exceptions directly. That is, you should be able to assume that an exception is thrown almost anywhere from within the code, with well-defined results (i.e. no resource leaks).

Code that uses a pattern like,

{
SDL_Surface* image = IMG_Load("image.bmp");
...some code, which uses 'image'...
SDL_FreeSurface(image);
}

is bad, because the code may throw an exception, and 'image' will never be freed. Instead, use wrapper objects which free the object in their destructor.

For SDL_Surface objects, use the <tt>surface</tt> class. So you could rewrite the above code,

{
surface image(IMG_Load("image.bmp"));
...some code, which uses 'image'...
} ''the image is automatically freed here when 'image' is destroyed

Instead of allocating memory directly using new[] or malloc(), use language-provided containers, such as vector.

=== Do not use sprintf ===

Sprintf does not check whether or not it is writing past the end of the space allocated. This is a security problem if someone other than the person running the game can cause sprintf to write very long strings. In Wesnoth this untrusted data could come potentially from other players in a multiplayer game or from downloaded campaigns. Instead you should use snprintf with the second argument being sizeof of the buffer that will hold the result.

== Standard C++ to avoid ==

=== Respect for loop scoping of different platforms ===

In the code,

for(int i = 0; i != 100; ++i) {...}

the variable 'i' is scoped within the for loop according to ISO/ANSI C++ and GNU G++. However it is scoped within the
surrounding scope according to Visual C++ 6.

This means that the code,

for(int i = 0; i != 100; ++i) {}
for(int i = 0; i != 100; ++i) {}

is illegal on VC++6, because i is defined twice, although it is legal according to the standard, and GNU G++.

On VC++6, the legal way to write it would be,

for(int i = 0; i != 100; ++i) {}
for(i = 0; i != 100; ++i) {}

But this is illegal according to the standard, because 'i' is not defined in the second loop. The correct way to write
this code to conform to the standard and work on all platforms is to simply abandon declaring variables in the
initialization statement of a for loop when the variable must be reused in the same scope,

int i;
for(i = 0; i != 100; ++i) {}
for(i = 0; i != 100; ++i) {}

=== Do not use wstring ===

The standard C++ wstring class, defined as a basic_string< wchar_t >, does not exist in some platforms supported
by
Wesnoth. Use wide_string, defined in language.hpp, instead. wide_string is actually defined as a vector< wchar_t >

== C legacy to be avoided ==

=== Use the function templates minimum and maximum ===

Standard C++ offers the function templates min and max to find the minimum and maximum of two values on which operator
<
is defined. Unfortunately, many hoops must be leapt through to get this working on VC++. So, we do not use standard
min
and max. Instead, we use minimum and maximum, defined in utils.hpp.

Usage is fairly natural:

int i = minimum(x,y);

Note that in the above example, if x is an unsigned integer, and y is a signed integer, VC++ will have problems. You
must explicitly specify the version of minimum being called in such cases:

int i = minimum<int>(x,y);

=== Use util::array instead of C-style Arrays ===

C-style arrays are very efficient, but their interface is ugly. Use util::array defined in array.hpp. It is a wrapper
for an array which has a C++ container-style interface. If you need to, extend it to make it fit your needs.

=== Do not use C-style casts ===

The following code,

if(i->second.side() == (size_t)player_number_) {

is considered bad practice in C++ since a C-style cast is overpowered -- if types change around it could end up casting away constness, or performing an implementation-defined data reinterpretation (basically a C-style cast is a compiler generated combination of static_cast, reinterpret_cast, and const_cast).

Good programming style is to use the least powerful tool available that does what you want. For example,

if(i->second.side() == static_cast<size_t>(player_number_)) {

Alternatively, a constructor call may be used for non-builtin types.

Note: there may be some obscure cases where a C-style cast is desirable, such as converting a pointer to an integer type of unspecified size.

== Documentation ==

=== Document "config" preconditions and postconditions ===

In the Wesnoth code you will commonly encounter a data container known as the "config," which contains heirarchical string data (such as WML contents or game settings). The tagged "children" of the config and their string "attributes" are arranged in an ordered and mapped format internally using STL.

Because config data is utilized in so many ways and places, it can be difficult to track across the scope of the entire program. You should document all public functions that take/return a config, specifying config content expectations (and updating any related entries in the [[ReferenceWML]] wiki pages). In particular, if your function requires a config parameter, specify where/how the config should be created. This will be a great help to any future coders who need to call or modify your function.

=== Doxygen ===
See [[Doxygen]] for tips on how to comment the code,
so that doxygen can make nicely document it.

== See also ==

* [[HackingWesnoth]]

[[Category:Programmers]]
[[Category:Committers]]

DeveloperResources

2007-08-15T13:06:21Z

HaJo:

== General ==
* Forum - http://forum.wesnoth.org
* Wiki :
** http://www.wesnoth.org/wiki/Main_Page
** [[GettingStarted]]
** [[FrequentlyProposedIdeas]] - summary of past often-repeated forum discussions
** [[WesnothAcronyms]]

== Game - Play ==
* units - http://units.wesnoth.org/
* unit list - http://zapicm.freeshell.org/stable/
* movement types & resistance - http://zapicm.freeshell.org/stable/data/

== Game - Create content ==
* [[BuildingScenarios]] and related useful forum discussions:
** [http://www.wesnoth.org/forum/viewtopic.php?t=4188 Beginning Campaign Development]
** [http://www.wesnoth.org/forum/viewtopic.php?t=4301 A Balancing Act]
* [[ReferenceWML]]

== Communication, Feedback ==
* Gna! links
** Gna! - bugs and feature requests - http://bugs.wesnoth.org/
** Gna! - patches - http://patches.wesnoth.org/

* Mailing lists:
** wesnoth-dev - https://mail.gna.org/listinfo/wesnoth-dev/
** wesnoth-commits - https://mail.gna.org/listinfo/wesnoth-commits/

* IRC: [irc://irc.wesnoth.org/#wesnoth-dev freenode/#wesnoth-dev] (alias to irc.freenode.net)
** IRC logs - http://irclog.wesnoth.org/

== Code, Development ==
* changelog - http://changelog.wesnoth.org/
* Up-to-date commit messages : http://cia.vc/stats/project/wesnoth
* Documentation generator [[Doxygen]]
** generated code documentation - http://devdocs.wesnoth.org
* gettext status - http://gettext.wesnoth.org/

* [[CompilingWesnoth]] - how to compile Battle for Wesnoth (it's not hard)
* Standard Template Library - http://www.sgi.com/tech/stl/
* [[DebugMode]] and [[CommandMode]] - in game debugging commands
* [[WesnothSVN]] - SVN instructions
* Gna! - websvn - http://websvn.wesnoth.org/ Web-Access to svn
* [[ExternalUtilities]] (Wercator, CampGen, wmllint, etc.)
* [[HackingWesnoth]]
* [[CodingStandards]]
* [[Developers]]

DeveloperResources

2007-08-15T13:05:08Z

HaJo:

== General ==
* Forum - http://forum.wesnoth.org
* Wiki :
** http://www.wesnoth.org/wiki/Main_Page
** [[GettingStarted]]
** [[FrequentlyProposedIdeas]] - summary of past often-repeated forum discussions
** [[WesnothAcronyms]]

== Game - Play ==
* units - http://units.wesnoth.org/
* unit list - http://zapicm.freeshell.org/stable/
* movement types & resistance - http://zapicm.freeshell.org/stable/data/

== Game - Create content ==
* [[BuildingScenarios]] and related useful forum discussions:
** [http://www.wesnoth.org/forum/viewtopic.php?t=4188 Beginning Campaign Development]
** [http://www.wesnoth.org/forum/viewtopic.php?t=4301 A Balancing Act]
* [[ReferenceWML]]

== Communication, Feedback ==
* Gna! links
** Gna! - bugs and feature requests - http://bugs.wesnoth.org/
** Gna! - patches - http://patches.wesnoth.org/

* Mailing lists:
** wesnoth-dev - https://mail.gna.org/listinfo/wesnoth-dev/
** wesnoth-commits - https://mail.gna.org/listinfo/wesnoth-commits/

* IRC: [irc://irc.wesnoth.org/#wesnoth-dev freenode/#wesnoth-dev] (alias to irc.freenode.net)
** IRC logs - http://irclog.wesnoth.org/

== Code, Development ==
* changelog - http://changelog.wesnoth.org/
* Up-to-date commit messages : http://cia.vc/stats/project/wesnoth
* Code documentation, created with
* documentation system [[Doxygen]]
** generated code documentation - http://devdocs.wesnoth.org
* gettext status - http://gettext.wesnoth.org/

* [[CompilingWesnoth]] - how to compile Battle for Wesnoth (it's not hard)
* Standard Template Library - http://www.sgi.com/tech/stl/
* [[DebugMode]] and [[CommandMode]] - in game debugging commands
* [[WesnothSVN]] - SVN instructions
* Gna! - websvn - http://websvn.wesnoth.org/ Web-Access to svn
* [[ExternalUtilities]] (Wercator, CampGen, wmllint, etc.)
* [[HackingWesnoth]]
* [[CodingStandards]]
* [[Developers]]

DeveloperResources

2007-08-15T13:04:04Z

HaJo:

== General ==
* Forum - http://forum.wesnoth.org
* Wiki :
** http://www.wesnoth.org/wiki/Main_Page
** [[GettingStarted]]
** [[FrequentlyProposedIdeas]] - summary of past often-repeated forum discussions
** [[WesnothAcronyms]]

== Game - Play ==
* units - http://units.wesnoth.org/
* unit list - http://zapicm.freeshell.org/stable/
* movement types & resistance - http://zapicm.freeshell.org/stable/data/
* [[ReferenceWML]]

== Game - Create content ==
* [[BuildingScenarios]] and related useful forum discussions:
** [http://www.wesnoth.org/forum/viewtopic.php?t=4188 Beginning Campaign Development]
** [http://www.wesnoth.org/forum/viewtopic.php?t=4301 A Balancing Act]

== Communication, Feedback ==
* Gna! links
** Gna! - bugs and feature requests - http://bugs.wesnoth.org/
** Gna! - patches - http://patches.wesnoth.org/

* Mailing lists:
** wesnoth-dev - https://mail.gna.org/listinfo/wesnoth-dev/
** wesnoth-commits - https://mail.gna.org/listinfo/wesnoth-commits/

* IRC: [irc://irc.wesnoth.org/#wesnoth-dev freenode/#wesnoth-dev] (alias to irc.freenode.net)
** IRC logs - http://irclog.wesnoth.org/

== Code, Development ==
* changelog - http://changelog.wesnoth.org/
* Up-to-date commit messages : http://cia.vc/stats/project/wesnoth
* Code documentation, created with
* documentation system [[Doxygen]]
** generated code documentation - http://devdocs.wesnoth.org
* gettext status - http://gettext.wesnoth.org/

* [[CompilingWesnoth]] - how to compile Battle for Wesnoth (it's not hard)
* Standard Template Library - http://www.sgi.com/tech/stl/
* [[DebugMode]] and [[CommandMode]] - in game debugging commands
* [[WesnothSVN]] - SVN instructions
* Gna! - websvn - http://websvn.wesnoth.org/ Web-Access to svn
* [[ExternalUtilities]] (Wercator, CampGen, wmllint, etc.)
* [[HackingWesnoth]]
* [[CodingStandards]]
* [[Developers]]

DeveloperResources

2007-08-15T13:02:25Z

HaJo:

== General ==
* Forum - http://forum.wesnoth.org
* Wiki :
** http://www.wesnoth.org/wiki/Main_Page
** [[GettingStarted]]
** [[FrequentlyProposedIdeas]] - summary of past often-repeated forum discussions
** [[WesnothAcronyms]]

== Game - Play ==
* units - http://units.wesnoth.org/
* unit list - http://zapicm.freeshell.org/stable/
* movement types & resistance - http://zapicm.freeshell.org/stable/data/

== Game - Create content ==
* [[BuildingScenarios]] and related useful forum discussions:
** [http://www.wesnoth.org/forum/viewtopic.php?t=4188 Beginning Campaign Development]
** [http://www.wesnoth.org/forum/viewtopic.php?t=4301 A Balancing Act]

== Communication, Feedback ==
* Gna! links
** Gna! - bugs and feature requests - http://bugs.wesnoth.org/
** Gna! - patches - http://patches.wesnoth.org/

* Mailing lists:
** wesnoth-dev - https://mail.gna.org/listinfo/wesnoth-dev/
** wesnoth-commits - https://mail.gna.org/listinfo/wesnoth-commits/

* IRC: [irc://irc.wesnoth.org/#wesnoth-dev freenode/#wesnoth-dev] (alias to irc.freenode.net)
** IRC logs - http://irclog.wesnoth.org/

== Code, Development ==
* changelog - http://changelog.wesnoth.org/
* Up-to-date commit messages : http://cia.vc/stats/project/wesnoth
* Code documentation, created with
* documentation system [[Doxygen]]
** generated code documentation - http://devdocs.wesnoth.org
* gettext status - http://gettext.wesnoth.org/

* [[CompilingWesnoth]] - how to compile Battle for Wesnoth (it's not hard)
* Standard Template Library - http://www.sgi.com/tech/stl/
* [[DebugMode]] and [[CommandMode]] - in game debugging commands
* [[WesnothSVN]] - SVN instructions
* Gna! - websvn - http://websvn.wesnoth.org/ Web-Access to svn
* [[ExternalUtilities]] (Wercator, CampGen, wmllint, etc.)
* [[CodingStandards]]
* [[Developers]]

DeveloperResources

2007-08-15T13:00:31Z

HaJo:

== General ==
* Forum - http://forum.wesnoth.org
* Wiki :
** http://www.wesnoth.org/wiki/Main_Page
** [[GettingStarted]]
** [[FrequentlyProposedIdeas]] - summary of past often-repeated forum discussions
** [[WesnothAcronyms]]

== Game - Play ==
* units - http://units.wesnoth.org/
* unit list - http://zapicm.freeshell.org/stable/
* movement types & resistance - http://zapicm.freeshell.org/stable/data/

== Game - Create content ==
* [[BuildingScenarios]] and related useful forum discussions:
** [http://www.wesnoth.org/forum/viewtopic.php?t=4188 Beginning Campaign Development]
** [http://www.wesnoth.org/forum/viewtopic.php?t=4301 A Balancing Act]

== Code, Development ==
* changelog - http://changelog.wesnoth.org/
* Up-to-date commit messages : http://cia.vc/stats/project/wesnoth
* Code documentation, created with
* documentation system [[Doxygen]]
** generated code documentation - http://devdocs.wesnoth.org
* gettext status - http://gettext.wesnoth.org/

* [[CompilingWesnoth]] - how to compile Battle for Wesnoth (it's not hard)
* Standard Template Library - http://www.sgi.com/tech/stl/
* [[DebugMode]] and [[CommandMode]] - in game debugging commands
* [[WesnothSVN]] - SVN instructions
* Gna! - websvn - http://websvn.wesnoth.org/ Web-Access to svn
* [[ExternalUtilities]]
* [[CodingStandards]]
* [[Developers]]

== Communication, Feedback ==
* Gna! links
** Gna! - bugs and feature requests - http://bugs.wesnoth.org/
** Gna! - patches - http://patches.wesnoth.org/

* Mailing lists:
** wesnoth-dev - https://mail.gna.org/listinfo/wesnoth-dev/
** wesnoth-commits - https://mail.gna.org/listinfo/wesnoth-commits/

* IRC: [irc://irc.wesnoth.org/#wesnoth-dev freenode/#wesnoth-dev] (alias to irc.freenode.net)
** IRC logs - http://irclog.wesnoth.org/

DeveloperResources

2007-08-15T12:38:23Z

HaJo:

== General ==
* Forum - http://forum.wesnoth.org
* Wiki :
** http://www.wesnoth.org/wiki/Main_Page
** [[GettingStarted]]
** [[FrequentlyProposedIdeas]] - summary of past often-repeated forum discussions
** [[WesnothAcronyms]]

== Game - Play ==
* units - http://units.wesnoth.org/
* unit list - http://zapicm.freeshell.org/stable/
* movement types & resistance - http://zapicm.freeshell.org/stable/data/

== Game - Create content ==
* [[BuildingScenarios]] and related useful forum discussions:
** [http://www.wesnoth.org/forum/viewtopic.php?t=4188 Beginning Campaign Development]
** [http://www.wesnoth.org/forum/viewtopic.php?t=4301 A Balancing Act]

== Code, Development ==
* changelog - http://changelog.wesnoth.org/
* Up-to-date commit messages : http://cia.vc/stats/project/wesnoth
* Code documentation, created with [[Doxygen]] - http://devdocs.wesnoth.org/
* gettext status - http://gettext.wesnoth.org/

* [[CompilingWesnoth]] - how to compile Battle for Wesnoth (it's not hard)
* Standard Template Library - http://www.sgi.com/tech/stl/
* [[DebugMode]] and [[CommandMode]] - in game debugging commands
* [[WesnothSVN]] - SVN instructions
* [[ExternalUtilities]]
* [[Developers]]
* Gna! - websvn - http://websvn.wesnoth.org/

== Communication, Feedback ==
* Gna! links
** Gna! - bugs and feature requests - http://bugs.wesnoth.org/
** Gna! - patches - http://patches.wesnoth.org/

* Mailing lists:
** wesnoth-dev - https://mail.gna.org/listinfo/wesnoth-dev/
** wesnoth-commits - https://mail.gna.org/listinfo/wesnoth-commits/

* IRC: [irc://irc.wesnoth.org/#wesnoth-dev freenode/#wesnoth-dev] (alias to irc.freenode.net)
** IRC logs - http://irclog.wesnoth.org/

DeveloperResources

2007-08-15T12:36:56Z

HaJo:

== General ==
* Forum - http://forum.wesnoth.org/
* Wiki :
** http://www.wesnoth.org/wiki/Main_Page
** http://www.wesnoth.org/wiki/GettingStarted
* [[FrequentlyProposedIdeas]] - summary of past often-repeated forum discussions
* [[WesnothAcronyms]]

== Game - Playing ==
* units - http://units.wesnoth.org/
* unit list - http://zapicm.freeshell.org/stable/
* movement types & resistance - http://zapicm.freeshell.org/stable/data/

== Game - Creating ==
* [[BuildingScenarios]] and related useful forum discussions:
** [http://www.wesnoth.org/forum/viewtopic.php?t=4188 Beginning Campaign Development]
** [http://www.wesnoth.org/forum/viewtopic.php?t=4301 A Balancing Act]

== Code, Developement ==
* changelog - http://changelog.wesnoth.org/
* Up-to-date commit messages : http://cia.vc/stats/project/wesnoth
* Code documentation, created with [[Doxygen]] - http://devdocs.wesnoth.org/
* gettext status - http://gettext.wesnoth.org/

* [[CompilingWesnoth]] - how to compile Battle for Wesnoth (it's not hard)
* Standard Template Library - http://www.sgi.com/tech/stl/
* [[DebugMode]] and [[CommandMode]] - in game debugging commands
* [[WesnothSVN]] - SVN instructions
* [[ExternalUtilities]]
* [[Developers]]
* Gna! - websvn - http://websvn.wesnoth.org/

== Communication, Feedback ==
* Gna! links
** Gna! - bugs and feature requests - http://bugs.wesnoth.org/
** Gna! - patches - http://patches.wesnoth.org/

* Mailing lists:
** wesnoth-dev - https://mail.gna.org/listinfo/wesnoth-dev/
** wesnoth-commits - https://mail.gna.org/listinfo/wesnoth-commits/

* IRC: [irc://irc.wesnoth.org/#wesnoth-dev freenode/#wesnoth-dev] (alias to irc.freenode.net)
** IRC logs - http://irclog.wesnoth.org/

DeveloperResources

2007-08-15T12:34:16Z

HaJo:

== General ==
* Forum - http://forum.wesnoth.org/
* Wiki - http://www.wesnoth.org/wiki/Main_Page
* [[FrequentlyProposedIdeas]] - summary of past often-repeated forum discussions
* [[WesnothAcronyms]]

== Game - Playing ==
* units - http://units.wesnoth.org/
* unit list - http://zapicm.freeshell.org/stable/
* movement types & resistance - http://zapicm.freeshell.org/stable/data/

== Game - Creating ==
* [[BuildingScenarios]] and related useful forum discussions:
** [http://www.wesnoth.org/forum/viewtopic.php?t=4188 Beginning Campaign Development]
** [http://www.wesnoth.org/forum/viewtopic.php?t=4301 A Balancing Act]

== Code, Developement ==
* changelog - http://changelog.wesnoth.org/
* Up-to-date commit messages : http://cia.vc/stats/project/wesnoth
* Code documentation, created with [[Doxygen]] - http://devdocs.wesnoth.org/
* gettext status - http://gettext.wesnoth.org/

* [[CompilingWesnoth]] - how to compile Battle for Wesnoth (it's not hard)
* Standard Template Library - http://www.sgi.com/tech/stl/
* [[DebugMode]] and [[CommandMode]] - in game debugging commands
* [[WesnothSVN]] - SVN instructions
* [[ExternalUtilities]]
* [[Developers]]
* Gna! - websvn - http://websvn.wesnoth.org/

== Communication, Feedback ==
* Gna! links
** Gna! - bugs and feature requests - http://bugs.wesnoth.org/
** Gna! - patches - http://patches.wesnoth.org/

* Mailing lists:
** wesnoth-dev - https://mail.gna.org/listinfo/wesnoth-dev/
** wesnoth-commits - https://mail.gna.org/listinfo/wesnoth-commits/

* IRC: [irc://irc.wesnoth.org/#wesnoth-dev freenode/#wesnoth-dev] (alias to irc.freenode.net)
** IRC logs - http://irclog.wesnoth.org/

DeveloperResources

2007-08-15T12:32:18Z

HaJo:

== General ==
* forum - http://forum.wesnoth.org/
* [[FrequentlyProposedIdeas]] - summary of past often-repeated forum discussions
* [[WesnothAcronyms]]

== Game - Playing ==
* units - http://units.wesnoth.org/
* unit list - http://zapicm.freeshell.org/stable/
* movement types & resistance - http://zapicm.freeshell.org/stable/data/

== Game - Creating ==
* [[BuildingScenarios]] and related useful forum discussions:
** [http://www.wesnoth.org/forum/viewtopic.php?t=4188 Beginning Campaign Development]
** [http://www.wesnoth.org/forum/viewtopic.php?t=4301 A Balancing Act]

== Code, Developement ==
* changelog - http://changelog.wesnoth.org/
* Up-to-date commit messages : http://cia.vc/stats/project/wesnoth
* Code documentation, created with [[Doxygen]] - http://devdocs.wesnoth.org/
* gettext status - http://gettext.wesnoth.org/

* [[CompilingWesnoth]] - how to compile Battle for Wesnoth (it's not hard)
* Standard Template Library - http://www.sgi.com/tech/stl/
* [[DebugMode]] and [[CommandMode]] - in game debugging commands
* [[WesnothSVN]] - SVN instructions
* [[ExternalUtilities]]
* [[Developers]]
* Gna! - websvn - http://websvn.wesnoth.org/

== Communication, Feedback ==
* Gna! links
** Gna! - bugs and feature requests - http://bugs.wesnoth.org/
** Gna! - patches - http://patches.wesnoth.org/

* Mailing lists:
** wesnoth-dev - https://mail.gna.org/listinfo/wesnoth-dev/
** wesnoth-commits - https://mail.gna.org/listinfo/wesnoth-commits/

* IRC: [irc://irc.wesnoth.org/#wesnoth-dev freenode/#wesnoth-dev] (alias to irc.freenode.net)
** IRC logs - http://irclog.wesnoth.org/

DeveloperResources

2007-08-15T12:30:37Z

HaJo: Subtitles, WesnothAcronyms

== General ==
* forum - http://forum.wesnoth.org/
* [[FrequentlyProposedIdeas]] - summary of past often-repeated forum discussions
* [[WesnothAcronyms]]

== Game - Playing ==
* units - http://units.wesnoth.org/
* unit list - http://zapicm.freeshell.org/stable/
* movement types & resistance - http://zapicm.freeshell.org/stable/data/

== Game - Creating ==
* [[BuildingScenarios]] and related useful forum discussions:
[http://www.wesnoth.org/forum/viewtopic.php?t=4188 Beginning Campaign Development], [http://www.wesnoth.org/forum/viewtopic.php?t=4301 A Balancing Act]

== Code, Developement ==
* changelog - http://changelog.wesnoth.org/
* Up-to-date commit messages : http://cia.vc/stats/project/wesnoth
* Code documentation, created with [[Doxygen]] - http://devdocs.wesnoth.org/
* gettext status - http://gettext.wesnoth.org/

* [[CompilingWesnoth]] - how to compile Battle for Wesnoth (it's not hard)
* Standard Template Library - http://www.sgi.com/tech/stl/
* [[ExternalUtilities]]
* [[DebugMode]] and [[CommandMode]] - in game debugging commands
* [[WesnothSVN]] - SVN instructions
* Gna! - websvn - http://websvn.wesnoth.org/
* [[Developers]]

== Communication, Feedback ==
* Gna! links
** Gna! - bugs and feature requests - http://bugs.wesnoth.org/
** Gna! - patches - http://patches.wesnoth.org/

* Mailing lists:
** wesnoth-dev - https://mail.gna.org/listinfo/wesnoth-dev/
** wesnoth-commits - https://mail.gna.org/listinfo/wesnoth-commits/

* IRC: [irc://irc.wesnoth.org/#wesnoth-dev freenode/#wesnoth-dev] (alias to irc.freenode.net)
** IRC logs - http://irclog.wesnoth.org/

DeveloperResources

2007-08-15T10:09:24Z

HaJo: Doxygen, CIA

* code documentation, created with [[Doxygen]] - http://devdocs.wesnoth.org/
* units - http://units.wesnoth.org/
* unit list - http://zapicm.freeshell.org/stable/
* movement types & resistance - http://zapicm.freeshell.org/stable/data/
* gettext status - http://gettext.wesnoth.org/
* changelog - http://changelog.wesnoth.org/
* forum - http://forum.wesnoth.org/
* [[FrequentlyProposedIdeas]] - summary of past often-repeated forum discussions
* [[BuildingScenarios]] and related useful forum discussions: [http://www.wesnoth.org/forum/viewtopic.php?t=4188 Beginning Campaign Development], [http://www.wesnoth.org/forum/viewtopic.php?t=4301 A Balancing Act]
* Standard Template Library - http://www.sgi.com/tech/stl/
* [[ExternalUtilities]]
* [[DebugMode]] and [[CommandMode]] - in game debugging commands
* [[WesnothSVN]] - SVN instructions
* [[CompilingWesnoth]] - how to compile Battle for Wesnoth (it's not hard)

* Gna! links
** bugs and feature requests - http://bugs.wesnoth.org/
** patches - http://patches.wesnoth.org/
** websvn - http://websvn.wesnoth.org/

* Up-to-date commit messages : http://cia.vc/stats/project/wesnoth

* Mailing lists:
** wesnoth-dev - https://mail.gna.org/listinfo/wesnoth-dev/
** wesnoth-commits - https://mail.gna.org/listinfo/wesnoth-commits/

* IRC: [irc://irc.wesnoth.org/#wesnoth-dev freenode/#wesnoth-dev] (alias to irc.freenode.net)
** IRC logs - http://irclog.wesnoth.org/

* [[Developers]]

EasyCoding

2007-04-16T13:38:26Z

HaJo: /* Debug Mode */

== Foreword ==
This page is here to document easy to do coding tasks. It is not here to double the feature request database, and should only be filled by people that know the code well enough to juge the difficulty of a given task.

If you are such a person, you should feel free to edit this page.

If you're not, you should post a feature request and discuss your idea on the forum or IRC. A coder with better knowledge of the code might give you the green light to add your feature here.

Anybody should feel free to add "clues" to any tasks, that is entry points, traps to avoid, person to contact to discuss and so on.

If you plan to work on a feature, write your name at the bottom of the feature, with the date. Note that if you are too long at working on a feature I'll "free" it back (that is if you're not working on it. If you have problems implementing it, just tell us....)

--[[User:Boucman|Boucman]] 20:48, 3 October 2006 (CEST)

== Animation related features ==
=== Victory animation ===
'''an animation to be played by the surviving unit during the death animation of the other unit'''

this should be fairly easy to do, just duplicate all death animation code, and modify the unit_die function to change the state of both units.

ask Boucman for extra help

* unit_display.cpp
* unit_type.cpp
* unit.cpp
* unit_animation.cpp;

Done! Submitting patch as soon as it can be tested. [[User:TheAT|TheAT]] 01:53, 17 October 2006 (CEST)

=== En Guard animation ===
'''An animation to replace the standing animation when the unit is next to an enemy'''

Slightly more tricky than the previous one, you should copy most of the standing code,
but beware that this should be invisible to external callers.
The call to get_stats should be looked at

Ask Boucman for extra help

* unit.cpp
* unit_type.cpp
* unit_animation.cpp

=== Special tags for Extra_anim ===
'''Special tags in the animate_unit event to call standard unit animations'''

One of the big limitation of the extra_animation tags is
that you need to modify the unit itself to have the extra anim.
Most anims can't be easily called that way.
It would be interesting to have special tags that would be recognised
to call the standard animations (attack, defense, etc...)

The tricky part is to handle correctly the "offset" parameter,
and add all the WML handling to "fill in" the information
we won't have available (non-existant filtering criterias)

This is more tricky than the two above,
and I would advise doing one of the other two first to understand how it works

Ask Boucman for extra help

* unit.cpp
* actions.cpp

=== Animate flags during a [delay] event ===
currently, the [event] tag calls SDL_delay() and blocks the game completely. It would be trivial to change it to a loop that would call event::pump() every 10ms to have all animations updated

the tricky part is to make sure the screen is somehow "locked" and that player can't play during that time (should be the case, simple checking is needed)

grep should give you the file to change

I am on this.Boucman please email me with more details when you have time [[User:Spx2|Spx2]] 12:31, 23 December 2006 (CEST)

Boucman please email me with an event that i can test this on

== WML related features ==
=== Side-specific messages ===
Side-specific [message]s ([http://gna.org/bugs/index.php?7427 FR #7427])
=== Side-specific results ===
Giving result=defeat or result=victory for specific sides. ([http://gna.org/bugs/index.php?4960 FR #4960])
=== Recall Event ===
WML event trigger for recalling (the current one triggers on both recalls and recruits) ([http://gna.org/bugs/index.php?3622 FR #3622]) (please read the comments of the report for a proper description of how this should work)
=== Enabling checking of damage dealt in WML ===
A WML variable should be set when triggering some combat-related events, allowing WML to know the amount of damage being dealt. ([http://gna.org/bugs/index.php?7673 FR #7673])
=== Support for leaderless multiplayergames ===
Add support for the WML tag victory_when_enemies_defeated in the scenario tag during multiplayergames. ([https://gna.org/bugs/index.php?8106 FR #8106])

== GUI related features ==
=== Theme Changes ===
* show number of owned villages/total villages (FR: #3135)
* allow custom themes to display values of WML variables ([http://gna.org/bugs/index.php?6209 FR #6209])
* hide the hourglass item from the statusbar when there is no timer

=== Widget Changes ===
* show side number, name and team association information in the status table
* make games sortable in the lobby (open slots, total number of players, era, XP modifier, gold per village, fog/shroud)
* input history (chat, commands, ..), seek Sapient for more info and tips

== Miscellaneous ==
=== More powerful village naming ===
'''Adding mountain names and other features to village names, having a second random name in village names'''

Currently the village naming engine has a very good structure that could allow
more powerfull names to be generated.
Understanding how it works should be quite easy, and a few usefull improvements could be added.

* Currently villages can use lake names and river names, this should be extended to other features like bridges, swamps, mountains etc...
* It would be nice to have a separate list of "first sylabus" and "last sylabus" for naming. That's not really needed in english, but some translations could use it
* Again, it is common to have villages with more than one "random" word in them. having a $name2 variable would be nice

=== Debug Mode ===
* New debug command functionality (setting status.variables, possibly terrain, WML value display)
* Make it possible to toggle shroud and fog (but take care that this is only possible in campaigns)

EasyCoding

2007-04-16T13:37:37Z

HaJo: /* More powerful village naming */ Typos

EasyCoding

2007-04-16T13:33:33Z

HaJo: /* Special tags for Extra_anim */

== Foreword ==
This page is here to document easy to do coding tasks. It is not here to double the feature request database, and should only be filled by people that know the code well enough to juge the difficulty of a given task.

If you are such a person, you should feel free to edit this page.

If you're not, you should post a feature request and discuss your idea on the forum or IRC. A coder with better knowledge of the code might give you the green light to add your feature here.

Anybody should feel free to add "clues" to any tasks, that is entry points, traps to avoid, person to contact to discuss and so on.

If you plan to work on a feature, write your name at the bottom of the feature, with the date. Note that if you are too long at working on a feature I'll "free" it back (that is if you're not working on it. If you have problems implementing it, just tell us....)

--[[User:Boucman|Boucman]] 20:48, 3 October 2006 (CEST)

== Animation related features ==
=== Victory animation ===
'''an animation to be played by the surviving unit during the death animation of the other unit'''

this should be fairly easy to do, just duplicate all death animation code, and modify the unit_die function to change the state of both units.

ask Boucman for extra help

* unit_display.cpp
* unit_type.cpp
* unit.cpp
* unit_animation.cpp;

Done! Submitting patch as soon as it can be tested. [[User:TheAT|TheAT]] 01:53, 17 October 2006 (CEST)

=== En Guard animation ===
'''An animation to replace the standing animation when the unit is next to an enemy'''

Slightly more tricky than the previous one, you should copy most of the standing code,
but beware that this should be invisible to external callers.
The call to get_stats should be looked at

Ask Boucman for extra help

* unit.cpp
* unit_type.cpp
* unit_animation.cpp

=== Special tags for Extra_anim ===
'''Special tags in the animate_unit event to call standard unit animations'''

One of the big limitation of the extra_animation tags is
that you need to modify the unit itself to have the extra anim.
Most anims can't be easily called that way.
It would be interesting to have special tags that would be recognised
to call the standard animations (attack, defense, etc...)

The tricky part is to handle correctly the "offset" parameter,
and add all the WML handling to "fill in" the information
we won't have available (non-existant filtering criterias)

This is more tricky than the two above,
and I would advise doing one of the other two first to understand how it works

Ask Boucman for extra help

* unit.cpp
* actions.cpp

=== Animate flags during a [delay] event ===
currently, the [event] tag calls SDL_delay() and blocks the game completely. It would be trivial to change it to a loop that would call event::pump() every 10ms to have all animations updated

the tricky part is to make sure the screen is somehow "locked" and that player can't play during that time (should be the case, simple checking is needed)

grep should give you the file to change

I am on this.Boucman please email me with more details when you have time [[User:Spx2|Spx2]] 12:31, 23 December 2006 (CEST)

Boucman please email me with an event that i can test this on

== WML related features ==
=== Side-specific messages ===
Side-specific [message]s ([http://gna.org/bugs/index.php?7427 FR #7427])
=== Side-specific results ===
Giving result=defeat or result=victory for specific sides. ([http://gna.org/bugs/index.php?4960 FR #4960])
=== Recall Event ===
WML event trigger for recalling (the current one triggers on both recalls and recruits) ([http://gna.org/bugs/index.php?3622 FR #3622]) (please read the comments of the report for a proper description of how this should work)
=== Enabling checking of damage dealt in WML ===
A WML variable should be set when triggering some combat-related events, allowing WML to know the amount of damage being dealt. ([http://gna.org/bugs/index.php?7673 FR #7673])
=== Support for leaderless multiplayergames ===
Add support for the WML tag victory_when_enemies_defeated in the scenario tag during multiplayergames. ([https://gna.org/bugs/index.php?8106 FR #8106])

== GUI related features ==
=== Theme Changes ===
* show number of owned villages/total villages (FR: #3135)
* allow custom themes to display values of WML variables ([http://gna.org/bugs/index.php?6209 FR #6209])
* hide the hourglass item from the statusbar when there is no timer

=== Widget Changes ===
* show side number, name and team association information in the status table
* make games sortable in the lobby (open slots, total number of players, era, XP modifier, gold per village, fog/shroud)
* input history (chat, commands, ..), seek Sapient for more info and tips

== Miscellaneous ==
=== More powerful village naming ===
'''adding mountain names and other features to village names, having a second random name in village names'''

currently the village naming engine has avery good structure that could allow more powerfull names to be generated. Understanding how it works should be quite easy, and a few usefull imprvements could be added

* currently villages can use lake names and river names, this should be extanded to other features like bridges, swamps, mountains etc...
* it would be nice to have a separate list of "first sylabus" and "last sylabus" for naming. That's not really needed in english, but some translations could use it
* again, it is common to have village with more than one "random" word in them. having a $name2 variable would be nice

=== Debug Mode ===
* New debug command functionality (setting status.variables, possibly terrain, WML value display)
* Make it possible to toggle shroud and fog (but take care that this is only possible ib campaigns)

EasyCoding

2007-04-16T13:30:48Z

HaJo: /* En Guard animation */

== Foreword ==
This page is here to document easy to do coding tasks. It is not here to double the feature request database, and should only be filled by people that know the code well enough to juge the difficulty of a given task.

If you are such a person, you should feel free to edit this page.

If you're not, you should post a feature request and discuss your idea on the forum or IRC. A coder with better knowledge of the code might give you the green light to add your feature here.

Anybody should feel free to add "clues" to any tasks, that is entry points, traps to avoid, person to contact to discuss and so on.

If you plan to work on a feature, write your name at the bottom of the feature, with the date. Note that if you are too long at working on a feature I'll "free" it back (that is if you're not working on it. If you have problems implementing it, just tell us....)

--[[User:Boucman|Boucman]] 20:48, 3 October 2006 (CEST)

== Animation related features ==
=== Victory animation ===
'''an animation to be played by the surviving unit during the death animation of the other unit'''

this should be fairly easy to do, just duplicate all death animation code, and modify the unit_die function to change the state of both units.

ask Boucman for extra help

* unit_display.cpp
* unit_type.cpp
* unit.cpp
* unit_animation.cpp;

Done! Submitting patch as soon as it can be tested. [[User:TheAT|TheAT]] 01:53, 17 October 2006 (CEST)

=== En Guard animation ===
'''An animation to replace the standing animation when the unit is next to an enemy'''

Slightly more tricky than the previous one, you should copy most of the standing code,
but beware that this should be invisible to external callers.
The call to get_stats should be looked at

Ask Boucman for extra help

* unit.cpp
* unit_type.cpp
* unit_animation.cpp

=== Special tags for Extra_anim ===
'''special tags in the animate_unit event to call standard unit animations'''

one of the big limitation of the extra_animation tags is that you need to modify the unit itself to have the extra anim. Most anims can't be easily called that way. It would be interesting to have special tags that would be recognised to call the standard animations (attack, defense, etc...)

the tricky part is to handle correctly the "offset" parameter, and add all the WML handling to "fill in" the information we won't have available (non-existant filtering criterias)

this is more tricky than the two above, and I would advise doing one of the other two first to understand how it work

ask Boucman for extra help

* unit.cpp
* actions.cpp

=== Animate flags during a [delay] event ===
currently, the [event] tag calls SDL_delay() and blocks the game completely. It would be trivial to change it to a loop that would call event::pump() every 10ms to have all animations updated

the tricky part is to make sure the screen is somehow "locked" and that player can't play during that time (should be the case, simple checking is needed)

grep should give you the file to change

I am on this.Boucman please email me with more details when you have time [[User:Spx2|Spx2]] 12:31, 23 December 2006 (CEST)

Boucman please email me with an event that i can test this on

== WML related features ==
=== Side-specific messages ===
Side-specific [message]s ([http://gna.org/bugs/index.php?7427 FR #7427])
=== Side-specific results ===
Giving result=defeat or result=victory for specific sides. ([http://gna.org/bugs/index.php?4960 FR #4960])
=== Recall Event ===
WML event trigger for recalling (the current one triggers on both recalls and recruits) ([http://gna.org/bugs/index.php?3622 FR #3622]) (please read the comments of the report for a proper description of how this should work)
=== Enabling checking of damage dealt in WML ===
A WML variable should be set when triggering some combat-related events, allowing WML to know the amount of damage being dealt. ([http://gna.org/bugs/index.php?7673 FR #7673])
=== Support for leaderless multiplayergames ===
Add support for the WML tag victory_when_enemies_defeated in the scenario tag during multiplayergames. ([https://gna.org/bugs/index.php?8106 FR #8106])

== GUI related features ==
=== Theme Changes ===
* show number of owned villages/total villages (FR: #3135)
* allow custom themes to display values of WML variables ([http://gna.org/bugs/index.php?6209 FR #6209])
* hide the hourglass item from the statusbar when there is no timer

=== Widget Changes ===
* show side number, name and team association information in the status table
* make games sortable in the lobby (open slots, total number of players, era, XP modifier, gold per village, fog/shroud)
* input history (chat, commands, ..), seek Sapient for more info and tips

== Miscellaneous ==
=== More powerful village naming ===
'''adding mountain names and other features to village names, having a second random name in village names'''

currently the village naming engine has avery good structure that could allow more powerfull names to be generated. Understanding how it works should be quite easy, and a few usefull imprvements could be added

* currently villages can use lake names and river names, this should be extanded to other features like bridges, swamps, mountains etc...
* it would be nice to have a separate list of "first sylabus" and "last sylabus" for naming. That's not really needed in english, but some translations could use it
* again, it is common to have village with more than one "random" word in them. having a $name2 variable would be nice

=== Debug Mode ===
* New debug command functionality (setting status.variables, possibly terrain, WML value display)
* Make it possible to toggle shroud and fog (but take care that this is only possible ib campaigns)

User:HaJo

2006-12-11T02:07:26Z

HaJo:

Hi!

BeginnerCampaigns

2005-11-23T18:05:12Z

HaJo: /* ''An Orcish Incursion'' */

== Scenarios / Campaigns for Beginners ==

First, beginners should take a tour thru the ''tutorial'' (a mini-campaign with two scenarios),
to see how wesnoth works.

After that, these campaigns are quite short:

=== ''An Orcish Incursion'' ===

By Josh Parsons. Vs. 1.0. Complete.

A 7 scenario mini-campaign with an emphasis on strategy, with hints for beginners.
Defend the Elven forests from marauding orcs.

See: [[OrcishIncursionCampaign]]

=== ''Two Brothers'' ===

By Circon. Currently maintained by Ivanovic and chrber. v0.8.6.

A campaign useful for beginners.

See: [[MiniCampaign]]

=== ''The South Guard'' ===

By aelius. v1.0.0.

This campaign tells the story of a relatively quiet part of the Wesnoth border.

A campaign useful for beginners.

See: [[SouthGuard]]

BeginnerCampaigns

2005-11-23T18:04:26Z

HaJo: Two Brothers, South Guard

== Scenarios / Campaigns for Beginners ==

First, beginners should take a tour thru the ''tutorial'' (a mini-campaign with two scenarios),
to see how wesnoth works.

After that, these campaigns are quite short:

=== ''An Orcish Incursion'' ===

By Josh Parsons. Vs. 1.0. Complete.

A 7 scenario mini-campaign with an emphasis on strategy, with hints for beginners.
Defend the Elven forests from marauding orcs.

=== ''Two Brothers'' ===

By Circon. Currently maintained by Ivanovic and chrber. v0.8.6.

A campaign useful for beginners.

See: [[MiniCampaign]]

=== ''The South Guard'' ===

By aelius. v1.0.0.

This campaign tells the story of a relatively quiet part of the Wesnoth border.

A campaign useful for beginners.

See: [[SouthGuard]]

BeginnerCampaigns

2005-11-23T17:48:19Z

HaJo:

== Scenarios / Campaigns for Beginners ==

First, beginners should take a tour thru the tutorial (a mini-campaign with two scenarios),
to see how wesnoth works.

Talk:GettingStarted

2005-11-23T17:42:54Z

HaJo: Scenarios --> Campaigns ?

The intended audience is people without previous war game knowledge.
They may only have a vague notion of what 'strategy' and 'tactics' are,
so don't assume much there. Rather than give specific 'click here,
type there' instructions, prefer to move the reader from how the game
should be played to describing Wesnoth's world and get them excited
enough to want to see for themselves.
Try to use simple words for a widely varying range of players,
of all ages, many of whom do not use English as a first language.

Definitions, like campaign and unit, should be given early on
because it makes the rest easier to write.
By immediately giving a mindset and overview, the reader can then use it
when discussing details about hit points and Fog of War.

Mentioning unit names is a bad idea, since the reader is likely
still trying to get the game running and specific units have no
meaning to them.
There is no real discussion on strategy.
The material needs reorganising.
The scenario sections should follow each other.
The word unit should be introduced very early, but without detail.
A unit section can describe units more fully.
The words troops and army aren't really suitable for Wesnoth,
unit seems all that's needed.
Some material is duplicated and should be cleaned up.

I'm not sure what is the best approach when dealing with villages and
recruiting. Villages affect many aspects, but are part of the world.
Perhaps it might be better to have a Gold system section instead.

-- Blackbeard

I think the pages MainlineScenarios, UserScenarios, and BeginnerScenarios
should be called MainlineCampaigns, UserCampaigns, and BeginnerCampaigns.

-- HaJo

GettingStarted

2005-11-23T17:37:33Z

HaJo: BeginnerScenarios

The Battle For Wesnoth (BFW) is a turn based, third person, fantasy war game.
Use your strategic and tactical skills to beat computer opponents.
Engage in campaigns that take you from scenario to scenario on to
final victory. Each campaign is a story told through scenarios.
Each scenario has an objective you must achieve before facing the next.
The game is played on a map divided into hexagons, called hexes.

== Save and Load ==
At the start of each scenario, you have the option to save it.
If you are defeated, you may load it and try again. Once you have succeeded,
you will again be asked to save the next scenario and play that.
If you have to stop playing during a scenario, you can save your turn
and load it again later. Just remember, a good BFW player never needs to
save '''during''' a scenario. However, most beginners tend to do so rather
often. ;)

== Recruit and Recall ==
At the start of each scenario, your commander is placed in a castle on a
special hex called a keep. From here, you can recruit or recall
your troops. Each recruit is placed on an empty castle square. Once you
have filled the castle, you cannot recruit any more until units move off.
Your opponent's commander is similarly placed on its castle keep and able
to recruit troops. When you right-click on an empty castle hex, a context
menu will come up that includes "recruit". Use the menu that comes up to
recruit more units. You must wait until your next turn to move recruits
off your castle.

At the end of each successful scenario, all your remaining troops are
automatically saved for you. At the start of the next scenario you may
recall them in a similar way to recruiting. Recalled troops are often more
experienced than recruits and usually a better choice.

You may only recruit and recall when your commander is on the castle's keep
hex. Since most castles have a keep, you can move your commander to any
castle's keep to recruit and recall.


== Factions and Races ==

The world of Wesnoth contains several races that have joined forces
into different factions. Here, Elf and Dwarf fight side by side against Orc
and Human. In most campaigns, you will mostly control units from one
faction, but often you will have a recruit list with units mixed in from
other factions, and will not have some units from a faction available.
Basically, your recruit list is determined by the plot of the campaign,
not by a predetermined ruleset.

Sometimes factions make alliances with others, so you may face more
than one faction in a scenario.



== Life and Death - Experience ==

As your troops gain battle experience, they will learn more skills and
become stronger. They will also die in battle, so you'll need to
recruit and recall more when that happens. But choose wisely, for each has
strengths and weaknesses a cunning opponent will quickly exploit.




== Army Units ==

All game types use the same soldiers, called units. Each unit is identified
by Race, Level, and Class. Each unit has strengths and weaknesses,
based on their Resistance, current Terrain, and Level.
Full details are in the [[UnitTables]] and [[MoveTypeTables]].

== Method of Game Play ==

You can play The Battle For Wesnoth as a campaign, a single scenario,
multiplayer, or hotseat.

; Campaign : A sequence of scenarios that allow you to develop your army by recalling surviving units from previous scenarios.
; Scenario : A single Life and Death battle where you pit your forces against one or more computer players.
; Multiplayer : A scenario played over a network with human and computer players.
; Hotseat : A scenario played by several people using one computer. When a player takes their turn at the computer, they're in the ''hotseat''.

You can also combine hotseat and remote play. The person setting up the game should set up one position for each remote computer and set up extra positions as 'local player' with the setups desired by the players that will be playing those positions.
Once the game starts, the person who set up the game can use the :control side playername command to give control of positions to players using remote computers. Side is numeric turn order.
Playername is the name used to connect to the game server for the machine the player will be using.



== Finding Your Way Around Wesnoth ==

You can use both the keyboard and mouse to navigate around Wesnoth.
Some controls respond to mouse only and others to keyboard.
Wesnoth supports several languages, so please select your preferred language before playing.
You may change the language at any time.

Some buttons contain features beyond getting started, such as Hotkeys and
Multiplay, which are explained in [[WesnothManual]], not here.

'''For the impatient, we recommend you first set your language, run the tutorial,
and then play a campaign.'''

When Wesnoth starts it displays an initial background and a list of buttons
called the Main Menu. The buttons only work with a mouse. The following
sections describe the Main Menu.

Quit

Click this button to close Wesnoth.

Language

Click this button, select your language, and click Ok to use it, or Cancel to
continue with the current language. The first time Wesnoth starts, it defaults
to English, but once you change it, it will start in that language.

Tutorial

The tutorial is a real, but basic, game (called a scenario) where Delfador
teaches Konrad how to play. Winning or losing is not important, here, but
learning what to do is. Click the Tutorial button to play as Konrad and
remember what Delfador tells him.

Campaign

Wesnoth was designed to play campaigns only. Click this button for a list of campaigns.
Select your campaign and Ok to start or Cancel to quit.

See also:
* [[MainlineScenarios]]
* [[UserScenarios]]
* [[BeginnerScenarios]]

Each campaign has a difficulty level: easy, medium (normal), and hard.
We recommend medium as this level is interesting, but not difficult.
You may not change the difficulty during the campaign.
Once you have selected the difficulty, you will start with the first scenario.

To learn more on Campaigns, see 'Playing a Campaign' and 'Load'.

Preferences

Click here to change default settings. You will be shown a dialouge with the
following options:

1- Music Volume (slider)
Drag the slider to the left, to make the music softer, and to the right to
make it louder.

2- sfx volume (slider)
Drag the slider to the left, to make the sound effects softer, and to the
right to make them louder.

3- Scroll speed (slider)
Drag the slider to the left, to make the map scroll slower, and to the right
to make it scroll faster.

4- Full Screen (check box)
Check this box to expand Wesnoth to fill the whole screen, or uncheck it, to
return to a window.

5- Turn Dialog (check box)
Check this box to show you a prompt dialogue whenever its your turn to move,
or uncheck it, to disable the turn dialogue.

6- Accelerated Speed (check box)
Check this box to double move speed, or uncheck it, for normal move speed.

7- Turn Bell (check box)
Check this box to sound a Bell on your turn, or uncheck it, to turn it off.

8- Show Grid (check box)
Check this box to outline each map hex, or uncheck it, to turn it off.

9- Show Team Colours (check box)
Check this box, to show each unit's team colour, or uncheck it, to turn it
off.

10- Video Mode (button)
Click this button to change the screen size. Choose from a list of available
sizes. Caution: Wesnoth may display badly, or not at all, if you make a
poor choice.

11- Hotkeys (button)
Click this button to change hotkeys. Caution: You may lose keyboard control
over one or more functions, if you disable hotkeys. To learn more, see
'Keyboard Control'.

12- Close Window (button)
Click this button to return to the Main Menu. All changes will be kept.

About

Click this button for a list of major Wesnoth contributors. You may find most
of them at irc.freenode.org:6667 on #wesnoth. Or visit http://www.wesnoth.org
for news, forums, and Wiki updates. The project is hosted on
http://savannah.gnu.org/projects/wesnoth , where you can download the latest production or
developer release, review and report problems (bugs).

Load

Click this button to load a previously saved game. You will be shown a
dialogue listing saved games. Select the game and click Ok to load and
continue, or Cancel to return to the Main Menu.

If you select a replay game, you can check the Replay check box.
The loaded game will make all the moves from the beginning while you watch.

Multiplayer

Click this button to play network games. A dialogue will appear for you to
create or connect to a game server. To learn more, see 'Network Games'.

Game Navigation

After loading a game or campaign, Wesnoth divides its screen into several
sections, listed here and described below (items marked with a * are undocumented).

1- Menu (button)
2- Your total Gold (display)
3- Your total villages (display)
4- Your total units (display)
5- Your total upkeep (display)
6- Your total Income (display)
7- Current hex type (info)
8- Current hex position (info)
9- Full map, scaled (select) *
10- Day cycle (graphic)
11- Last selected Unit profile (info) *
12- Turn counter (info) *
13- End Turn (button) *
14- Map (active) *

The map covers most of the window and is the most complex, so we discribe it
last. The other areas are useful when using the map, so we explain them now.

Menu button: Displays a popup, lists the following options:

1- Scenario Objectives: Lists the victory and defeat conditions.
2- Unit List: Lists your active units, including their map position.
3- Recruit: Lists units your commander can recruit from a keep.
4- Recall (Campaign only): Lists units your commander can recall from a keep.
5- Status Table: Summary list of visible player units, villages, income etc.
6- End Turn: On your turn, select it to end your turn.
7- Save Game: Write the current game position to disk.
8- Preferences: see Main Menu:preferences, for details.
9- Quit Game: Close the game, without saving, and return to the Main menu.

Your Total Gold, villages, units, upkeep, and income (info)
Quick way to check how your army is doing. A negative income means you'll
lose Gold, a positive means you gain Gold.
Upkeep is the Gold you pay your units.
Villages shows how many you own, each village will give you Gold.

Current hex
Shows the terrain type and position of the hex pointed to by the mouse.
If a unit is on the hex, its terrain Resistence is shown after the position.
The position is in column, row order.

Day Cycle
This is the picture underneath the mini-map to the right. Putting your mouse
over it will bring up a helpful tooltip. Note that Wesnoth has a 6-turn day
and that different alignments have bonuses depending on the time of day.





== Time to Play ==

=== Campaign ===

Campaigns take a very long time to complete, ranging from weeks to months.
Typical campaigns have about 20 to 30 scenarios. The main advantage with
campaigns is developing your army. As you complete each scenario, the
remaing units at the end are saved for you to use in the next scenario.
If you choose not to use a unit at all during a scenario it is carried over
to the next, so you don't lose units you don't use.

The campaign is the primary form in which Wesnoth is intended to be played,
and is probably the most enjoyable.

=== Scenarios ===

A single scenario takes about 30 minutes to 2 hours to complete.
This is the fastest way to play, but your units are not saved and you cannot use
campaign units. Depending on the scenario, you may play with an artificial
player or against several.

=== Hotseat ===

Hotseat games will take about the same time to play as games played remotely.
The time will be greatly affected by the size of the map.

=== Multiplayer ===

Multiplayer games can take anything from 1 hour to 10 hours, depending on
how many players there are. The average time is between 3 to 7 hours.
Games can be saved and loaded as many times as you like.
So, it's possible for some games to last 1 or 2 weeks, even though
the play time is only a few hours. Currently, you cannot carry over
units in multiplayer from one scenario to the next, so building up
your army's strength is possible only within the scenario.

== Battleworld Training ==

If you are new to Wesnoth, but have experience playing turn-based hex combat games,
here is a way to find out how the terrain and units interact:

# Go to Multiplayer, and play the AI on Battleworld.
# Choose "Rebels". Give yourself two or three times as much gold as you give the AI. Set the leveling percentage to 16%. Set "gold per village" to 5x.
# Experiment with different time periods (which will give you different units) and fighting against different opponents.
# When you consistently overrun the AI, move the gold and exp settings back to normal. This will prepare you for the campaigns and multiplayer against other humans.

=== Getting the Most Fun Out of the Game ===

Remember, the idea of a game is to have fun! Here are some recommendations
from the development team on how to get the most fun out of the game:

* Consider playing the campaign on 'Medium' difficulty level, especially if you have prior experience with strategy games. We feel you'll find it much more rewarding.
* Don't sweat it too much when you lose some units. The campaign was designed to accomodate the player losing some units along the way.
* Don't abuse saved games. Long ago, Wesnoth only allowed saving the game at the end of a scenario. Mid-scenario saving was added as a convenience to use if you had to continue the game another day, or to protect against crashes. We do not recommend loading mid-scenario saved games over and over because your White Mage keeps getting killed. Learn to protect your White Mage instead, and balance risks! That is part of the strategy.
* If you must load a saved game, we recommend going back to the start of the scenario, so that you choose a new strategy that works, rather than simply finding random numbers that favor you.
* But remember, the aim is to have fun! You may have different tastes to the developers, so do what you enjoy most! If you enjoy loading the saved game every time you make a mistake, looking for the 'perfect' game where you never lose a unit, by all means, go right ahead!

== At the start of a scenario ==
* First, read the scenario objectives. Sometimes you do not have to kill enemy leaders instead it is enough that you survive number of turns, or pick up a particular object
* Look at the map: the terrain, the position of your leader and the other leader.
* Then, begin to recruit units. Cheap units are useful to soak up the first wave of an enemy's attack; advanced units can then be brought in as support. Fast units can be used as scouts, for exploring the map and to quickly conquer villages.

== During the scenario ==
* Try to capture and keep control of as many villages as possible to keep the gold coming in
* Keep units in packs so the enemy cannot attack from as many sides, and so you can outnumber each enemy unit. Put your units in a line so that the enemy cannot attack any one of your unit from more than two sides.
* Different units have different strengths and weaknesses depending on terrain and who they are attacking; right click on units and select "Describe unit" to learn more
* You can use lower level units as cannon fodder, to slow down enemy. e.g. you can use them to block enemy reaching your important units
* You can cause damage to enemies with advanced units and then finish them with lower level units - to give them more experience (and finally make them advance to next level)
* When you have a White Mage (advances from Mage) or Druid (advances from Shaman), put it in the middle of a circle of units to heal them as they move across the map
* Losing units is expected, even advanced units
* Time of day really matters:
** lawful units do more damage at day and less damage at night
** chaotic units do more damage at night and less damage at day
** remember to always check the time of day on the right side of the screen. Plan ahead - think about what it's going to be next turn as well as this turn.
* Some units are resistant or vulnerable to different kind of attacks. Mounted units are weak vs pierce attacks. Fire and holy destroy undeads. To see how much a unit resists an attack type, right click on the unit, select 'Unit Description', then select 'Resistance'. It will show you how resistant a unit is to different types of attacks.

=== Healing ===
* Villages heal units from normal damage and poison
* A village heals by a fixed amount regardless of unit level.
* A unit can only be healed up to 8HP per turn.
* A unit may take several turns to be fully healed.
* A village takes the first turn to cure a poisoned unit, no healing is done.
* Healers can heal other units the same way villages do.
* Each healer can heal up to six units each turn.
* Healers (Elvish Shaman, Elvish Druid, Elvish Shyde, White Mage, Mage of Light, Paladin) heal all wounded units around them, so you can keep units close to the battle without losing them.
* Some healers can cure poisoned units in the same way villages do.
* Healers will first heal their own units and then all friendly ones.
* Healers do not heal enemy units.
* Healers cannot heal themselves, but see next point.
* Use your healers in pairs, so they can heal each other if needed.
* Healers can heal the same unit and speed up healing.
* Trolls and Woses regenerate themselves when injured.
* Trolls and Woses cannot regenerate other units.
* Trolls and Woses cure themselves from poison as a village does.
* Trolls and Woses can be healed by healers and a village.

== Winning a scenario ==
* Advanced units are needed to quickly kill enemy commanders, and to avoid losing lots of units.
* The quicker you win a scenario, the more gold you get; you will get more gold from winning early than from all of the map's villages for the rest of the turns.
* Killing all enemy leaders usually gives instant victory.

== More general tips ==
* After slaughtering scenarios (where your ass gets seriously kicked) there are usually "breathing room" scenarios where you can rather easily gain some gold and experience (advanced units)
* Advanced units have higher upkeep than lower level units (1 gp per level), loyal units are an exception.

== See Also ==
* [[WesnothManual]]
* [[AdvancedTactics]]

{{Play}}

GettingStarted

2005-11-23T16:43:39Z

HaJo: /* At the start of a scenario */

The Battle For Wesnoth (BFW) is a turn based, third person,
fantasy war game.
Use your strategic and tactical skills to beat computer opponents.
Engage in campaigns that take you from scenario to scenario on to
final victory. Each campaign is a story told through scenarios. Each
scenario has an objective you must achieve before facing the next.
The game is played on a map divided into hexagons, called hexes.

== Save and Load ==
At the start of each scenario, you have the option to save it. If you
are defeated, you may load it and try again. Once you have succeeded, you
will again be asked to save the next scenario and play that. If you
have to stop playing during a scenario, you can save your turn
and load it again later. Just remember, a good BFW player never needs to
save '''during''' a scenario. However, most beginners tend to do so rather
often. ;)

== Recruit and Recall ==
At the start of each scenario, your commander is placed in a castle on a
special hex called a keep. From here, you can recruit or recall
your troops. Each recruit is placed on an empty castle square. Once you
have filled the castle, you cannot recruit any more until units move off.
Your opponent's commander is similarly placed on its castle keep and able
to recruit troops. When you right-click on an empty castle hex, a context
menu will come up that includes "recruit". Use the menu that comes up to
recruit more units. You must wait until your next turn to move recruits
off your castle.

At the end of each successful scenario, all your remaining troops are
automatically saved for you. At the start of the next scenario you may
recall them in a similar way to recruiting. Recalled troops are often more
experienced than recruits and usually a better choice.

You may only recruit and recall when your commander is on the castle's keep
hex. Since most castles have a keep, you can move your commander to any
castle's keep to recruit and recall.


== Factions and Races ==

The world of Wesnoth contains several races that have joined forces
into different factions. Here, Elf and Dwarf fight side by side against Orc
and Human. In most campaigns, you will mostly control units from one
faction, but often you will have a recruit list with units mixed in from
other factions, and will not have some units from a faction available.
Basically, your recruit list is determined by the plot of the campaign, not
by a predetermined ruleset.

Sometimes factions make alliances with others, so you may face more
than one faction in a scenario.



== Life and Death - Experience ==

As your troops gain battle experience, they will learn more skills and
become stronger. They will also die in battle, so you'll need to
recruit and recall more when that happens. But choose wisely, for each has
strengths and weaknesses a cunning opponent will quickly exploit.




== Army Units ==

All game types use the same soldiers, called units. Each unit is identified
by Race, Level, and Class. Each unit has strengths and weaknesses, based
on their Resistance, current Terrain, and Level. Full details are
in the [[UnitTables]] and [[MoveTypeTables]].

== Method of Game Play ==

You can play The Battle For Wesnoth as a campaign, a single scenario,
multiplayer, or hotseat.

; Campaign : A sequence of scenarios that allow you to develop your army by recalling surviving units from previous scenarios.
; Scenario : A single Life and Death battle where you pit your forces against one or more computer players.
; Multiplayer : A scenario played over a network with human and computer players.
; Hotseat : A scenario played by several people using one computer. When a player takes their turn at the computer, they're in the ''hotseat''.

You can also combine hotseat and remote play. The person setting up the game should set up one position for each remote computer and set up extra positions as 'local player' with the setups desired by the players that will be playing those positions. Once the game starts, the person who set up the game can use the :control side playername command to give control of positions to players using remote computers. Side is numeric turn order. Playername is the name used to connect to the game server for the machine the player will be using.



== Finding Your Way Around Wesnoth ==

You can use both the keyboard and mouse to navigate around Wesnoth. Some
controls respond to mouse only and others to keyboard. Wesnoth supports
several languages, so please select your preferred language before playing.
You may change the language at any time.

Some buttons contain features beyond getting started, such as Hotkeys and
Multiplay, which are explained in [[WesnothManual]], not here.

'''For the impatient, we recommend you first set your language, run the tutorial,
and then play a campaign.'''

When Wesnoth starts it displays an initial background and a list of buttons
called the Main Menu. The buttons only work with a mouse. The following
sections describe the Main Menu.

Quit

Click this button to close Wesnoth.

Language

Click this button, select your language, and click Ok to use it, or Cancel to
continue with the current language. The first time Wesnoth starts, it defaults
to English, but once you change it, it will start in that language.

Tutorial

The tutorial is a real, but basic, game (called a scenario) where Delfador
teaches Konrad how to play. Winning or losing is not important, here, but
learning what to do is. Click the Tutorial button to play as Konrad and
remember what Delfador tells him.

Campaign

Wesnoth was designed to play campaigns only. Click this button for a list of
campaigns. Select your campaign and Ok to start or Cancel to quit.

Each campaign has a difficulty level: easy, medium (normal), and hard. We
recommend medium as this level is interesting, but not difficult. You may
not change the difficulty during the campaign. Once you have selected the
difficulty, you will start with the first scenario.

To learn more on Campaigns, see 'Playing a Campaign' and 'Load'.

Preferences

Click here to change default settings. You will be shown a dialouge with the
following options:

1- Music Volume (slider)
Drag the slider to the left, to make the music softer, and to the right to
make it louder.

2- sfx volume (slider)
Drag the slider to the left, to make the sound effects softer, and to the
right to make them louder.

3- Scroll speed (slider)
Drag the slider to the left, to make the map scroll slower, and to the right
to make it scroll faster.

4- Full Screen (check box)
Check this box to expand Wesnoth to fill the whole screen, or uncheck it, to
return to a window.

5- Turn Dialog (check box)
Check this box to show you a prompt dialogue whenever its your turn to move,
or uncheck it, to disable the turn dialogue.

6- Accelerated Speed (check box)
Check this box to double move speed, or uncheck it, for normal move speed.

7- Turn Bell (check box)
Check this box to sound a Bell on your turn, or uncheck it, to turn it off.

8- Show Grid (check box)
Check this box to outline each map hex, or uncheck it, to turn it off.

9- Show Team Colours (check box)
Check this box, to show each unit's team colour, or uncheck it, to turn it
off.

10- Video Mode (button)
Click this button to change the screen size. Choose from a list of available
sizes. Caution: Wesnoth may display badly, or not at all, if you make a
poor choice.

11- Hotkeys (button)
Click this button to change hotkeys. Caution: You may lose keyboard control
over one or more functions, if you disable hotkeys. To learn more, see
'Keyboard Control'.

12- Close Window (button)
Click this button to return to the Main Menu. All changes will be kept.

About

Click this button for a list of major Wesnoth contributors. You may find most
of them at irc.freenode.org:6667 on #wesnoth. Or visit http://www.wesnoth.org
for news, forums, and Wiki updates. The project is hosted on
http://savannah.gnu.org/projects/wesnoth , where you can download the latest production or
developer release, review and report problems (bugs).

Load

Click this button to load a previously saved game. You will be shown a
dialogue listing saved games. Select the game and click Ok to load and
continue, or Cancel to return to the Main Menu.

If you select a replay game, you can check the Replay check box. The loaded
game will make all the moves from the beginning while you watch.

Multiplayer

Click this button to play network games. A dialogue will appear for you to
create or connect to a game server. To learn more, see 'Network Games'.

Game Navigation

After loading a game or campaign, Wesnoth divides its screen into several
sections, listed here and described below (items marked with a * are undocumented).

1- Menu (button)
2- Your total Gold (display)
3- Your total villages (display)
4- Your total units (display)
5- Your total upkeep (display)
6- Your total Income (display)
7- Current hex type (info)
8- Current hex position (info)
9- Full map, scaled (select) *
10- Day cycle (graphic)
11- Last selected Unit profile (info) *
12- Turn counter (info) *
13- End Turn (button) *
14- Map (active) *

The map covers most of the window and is the most complex, so we discribe it
last. The other areas are useful when using the map, so we explain them now.

Menu button: Displays a popup, lists the following options:

1- Scenario Objectives: Lists the victory and defeat conditions.
2- Unit List: Lists your active units, including their map position.
3- Recruit: Lists units your commander can recruit from a keep.
4- Recall (Campaign only): Lists units your commander can recall from a keep.
5- Status Table: Summary list of visible player units, villages, income etc.
6- End Turn: On your turn, select it to end your turn.
7- Save Game: Write the current game position to disk.
8- Preferences: see Main Menu:preferences, for details.
9- Quit Game: Close the game, without saving, and return to the Main menu.

Your Total Gold, villages, units, upkeep, and income (info)
Quick way to check how your army is doing. A negative income means you'll
lose Gold, a positive means you gain Gold. Upkeep is the Gold you pay
your units. Villages shows how many you own, each viilage will give you
Gold.

Current hex
Shows the terrain type and position of the hex pointed to by the mouse. If
a unit is on the hex, its terrain Resistence is shown after the position.
The position is in column, row order.

Day Cycle
This is the picture underneath the mini-map to the right. Putting your mouse
over it will bring up a helpful tooltip. Note that Wesnoth has a 6-turn day
and that differnt alignments have bonuses depending on the time of day.





== Time to Play ==

=== Campaign ===

Campaigns take a very long time to complete, ranging from weeks to months.
Typical campaigns have about 20 to 30 scenarios. The main advantage with
campaigns is developing your army. As you complete each scenario, the
remaing units at the end are saved for you to use in the next scenario. If
you choose not to use a unit at all during a scenario it is carried over to
the next, so you don't lose units you don't use.

The campaign is the primary form in which Wesnoth is intended to be played,
and is probably the most enjoyable.

=== Scenarios ===

A single scenario takes about 30 minutes to 2 hours to complete. This is
the fastest way to play, but your units are not saved and you cannot use
campaign units. Depending on the scenario, you may play with an artificial
player or against several.

=== Hotseat ===

Hotseat games will take about the same time to play as games played remotely. The time will
be greatly affected by the size of the map.

=== Multiplayer ===

Multiplayer games can take anything from 1 hour to 10 hours, depending on
how many players there are. The average time is between 3 to 7 hours.
Games can be saved and loaded as many times as you like. So, it's
possible for some games to last 1 or 2 weeks, even though the
play time is only a few hours. Currently, you cannot carry over
units in multiplayer from one scenario to the next, so building up
your army's strength is possible only within the scenario.

== Battleworld Training ==

If you are new to Wesnoth, but have experience playing turn-based hex combat games, here is a way to find out how the terrain and units interact:

# Go to Multiplayer, and play the AI on Battleworld.
# Choose "Rebels". Give yourself two or three times as much gold as you give the AI. Set the leveling percentage to 16%. Set "gold per village" to 5x.
# Experiment with different time periods (which will give you different units) and fighting against different opponents.
# When you consistently overrun the AI, move the gold and exp settings back to normal. This will prepare you for the campaigns and multiplayer against other humans.

=== Getting the Most Fun Out of the Game ===

Remember, the idea of a game is to have fun! Here are some recommendations
from the development team on how to get the most fun out of the game:

* Consider playing the campaign on 'Medium' difficulty level, especially if you have prior experience with strategy games. We feel you'll find it much more rewarding.
* Don't sweat it too much when you lose some units. The campaign was designed to accomodate the player losing some units along the way.
* Don't abuse saved games. Long ago, Wesnoth only allowed saving the game at the end of a scenario. Mid-scenario saving was added as a convenience to use if you had to continue the game another day, or to protect against crashes. We do not recommend loading mid-scenario saved games over and over because your White Mage keeps getting killed. Learn to protect your White Mage instead, and balance risks! That is part of the strategy.
* If you must load a saved game, we recommend going back to the start of the scenario, so that you choose a new strategy that works, rather than simply finding random numbers that favor you.
* But remember, the aim is to have fun! You may have different tastes to the developers, so do what you enjoy most! If you enjoy loading the saved game every time you make a mistake, looking for the 'perfect' game where you never lose a unit, by all means, go right ahead!

== At the start of a scenario ==
* First, read the scenario objectives. Sometimes you do not have to kill enemy leaders instead it is enough that you survive number of turns, or pick up a particular object
* Look at the map: the terrain, the position of your leader and the other leader.
* Then, begin to recruit units. Cheap units are useful to soak up the first wave of an enemy's attack; advanced units can then be brought in as support. Fast units can be used as scouts, for exploring the map and to quickly conquer villages.

== During the scenario ==
* Try to capture and keep control of as many villages as possible to keep the gold coming in
* Keep units in packs so the enemy cannot attack from as many sides, and so you can outnumber each enemy unit. Put your units in a line so that the enemy cannot attack any one of your unit from more than two sides.
* Different units have different strengths and weaknesses depending on terrain and who they are attacking; right click on units and select "Describe unit" to learn more
* You can use lower level units as cannon fodder, to slow down enemy. e.g. you can use them to block enemy reaching your important units
* You can cause damage to enemies with advanced units and then finish them with lower level units - to give them more experience (and finally make them advance to next level)
* When you have a White Mage (advances from Mage) or Druid (advances from Shaman), put it in the middle of a circle of units to heal them as they move across the map
* Losing units is expected, even advanced units
* Time of day really matters:
** lawful units do more damage at day and less damage at night
** chaotic units do more damage at night and less damage at day
** remember to always check the time of day on the right side of the screen. Plan ahead - think about what it's going to be next turn as well as this turn.
* Some units are resistant or vulnerable to different kind of attacks. Mounted units are weak vs pierce attacks. Fire and holy destroy undeads. To see how much a unit resists an attack type, right click on the unit, select 'Unit Description', then select 'Resistance'. It will show you how resistant a unit is to different types of attacks.

=== Healing ===
* Villages heal units from normal damage and poison
* A village heals by a fixed amount regardless of unit level.
* A unit can only be healed up to 8HP per turn.
* A unit may take several turns to be fully healed.
* A village takes the first turn to cure a poisoned unit, no healing is done.
* Healers can heal other units the same way villages do.
* Each healer can heal up to six units each turn.
* Healers (Elvish Shaman, Elvish Druid, Elvish Shyde, White Mage, Mage of Light, Paladin) heal all wounded units around them, so you can keep units close to the battle without losing them.
* Some healers can cure poisoned units in the same way villages do.
* Healers will first heal their own units and then all friendly ones.
* Healers do not heal enemy units.
* Healers cannot heal themselves, but see next point.
* Use your healers in pairs, so they can heal each other if needed.
* Healers can heal the same unit and speed up healing.
* Trolls and Woses regenerate themselves when injured.
* Trolls and Woses cannot regenerate other units.
* Trolls and Woses cure themselves from poison as a village does.
* Trolls and Woses can be healed by healers and a village.

== Winning a scenario ==
* Advanced units are needed to quickly kill enemy commanders, and to avoid losing lots of units.
* The quicker you win a scenario, the more gold you get; you will get more gold from winning early than from all of the map's villages for the rest of the turns.
* Killing all enemy leaders usually gives instant victory.

== More general tips ==
* After slaughtering scenarios (where your ass gets seriously kicked) there are usually "breathing room" scenarios where you can rather easily gain some gold and experience (advanced units)
* Advanced units have higher upkeep than lower level units (1 gp per level), loyal units are an exception.

== See Also ==
* [[WesnothManual]]
* [[AdvancedTactics]]

{{Play}}

GettingStarted

2005-11-23T16:42:54Z

HaJo: /* At the start of a scenario */

The Battle For Wesnoth (BFW) is a turn based, third person,
fantasy war game.
Use your strategic and tactical skills to beat computer opponents.
Engage in campaigns that take you from scenario to scenario on to
final victory. Each campaign is a story told through scenarios. Each
scenario has an objective you must achieve before facing the next.
The game is played on a map divided into hexagons, called hexes.

== Save and Load ==
At the start of each scenario, you have the option to save it. If you
are defeated, you may load it and try again. Once you have succeeded, you
will again be asked to save the next scenario and play that. If you
have to stop playing during a scenario, you can save your turn
and load it again later. Just remember, a good BFW player never needs to
save '''during''' a scenario. However, most beginners tend to do so rather
often. ;)

== Recruit and Recall ==
At the start of each scenario, your commander is placed in a castle on a
special hex called a keep. From here, you can recruit or recall
your troops. Each recruit is placed on an empty castle square. Once you
have filled the castle, you cannot recruit any more until units move off.
Your opponent's commander is similarly placed on its castle keep and able
to recruit troops. When you right-click on an empty castle hex, a context
menu will come up that includes "recruit". Use the menu that comes up to
recruit more units. You must wait until your next turn to move recruits
off your castle.

At the end of each successful scenario, all your remaining troops are
automatically saved for you. At the start of the next scenario you may
recall them in a similar way to recruiting. Recalled troops are often more
experienced than recruits and usually a better choice.

You may only recruit and recall when your commander is on the castle's keep
hex. Since most castles have a keep, you can move your commander to any
castle's keep to recruit and recall.


== Factions and Races ==

The world of Wesnoth contains several races that have joined forces
into different factions. Here, Elf and Dwarf fight side by side against Orc
and Human. In most campaigns, you will mostly control units from one
faction, but often you will have a recruit list with units mixed in from
other factions, and will not have some units from a faction available.
Basically, your recruit list is determined by the plot of the campaign, not
by a predetermined ruleset.

Sometimes factions make alliances with others, so you may face more
than one faction in a scenario.



== Life and Death - Experience ==

As your troops gain battle experience, they will learn more skills and
become stronger. They will also die in battle, so you'll need to
recruit and recall more when that happens. But choose wisely, for each has
strengths and weaknesses a cunning opponent will quickly exploit.




== Army Units ==

All game types use the same soldiers, called units. Each unit is identified
by Race, Level, and Class. Each unit has strengths and weaknesses, based
on their Resistance, current Terrain, and Level. Full details are
in the [[UnitTables]] and [[MoveTypeTables]].

== Method of Game Play ==

You can play The Battle For Wesnoth as a campaign, a single scenario,
multiplayer, or hotseat.

; Campaign : A sequence of scenarios that allow you to develop your army by recalling surviving units from previous scenarios.
; Scenario : A single Life and Death battle where you pit your forces against one or more computer players.
; Multiplayer : A scenario played over a network with human and computer players.
; Hotseat : A scenario played by several people using one computer. When a player takes their turn at the computer, they're in the ''hotseat''.

You can also combine hotseat and remote play. The person setting up the game should set up one position for each remote computer and set up extra positions as 'local player' with the setups desired by the players that will be playing those positions. Once the game starts, the person who set up the game can use the :control side playername command to give control of positions to players using remote computers. Side is numeric turn order. Playername is the name used to connect to the game server for the machine the player will be using.



== Finding Your Way Around Wesnoth ==

You can use both the keyboard and mouse to navigate around Wesnoth. Some
controls respond to mouse only and others to keyboard. Wesnoth supports
several languages, so please select your preferred language before playing.
You may change the language at any time.

Some buttons contain features beyond getting started, such as Hotkeys and
Multiplay, which are explained in [[WesnothManual]], not here.

'''For the impatient, we recommend you first set your language, run the tutorial,
and then play a campaign.'''

When Wesnoth starts it displays an initial background and a list of buttons
called the Main Menu. The buttons only work with a mouse. The following
sections describe the Main Menu.

Quit

Click this button to close Wesnoth.

Language

Click this button, select your language, and click Ok to use it, or Cancel to
continue with the current language. The first time Wesnoth starts, it defaults
to English, but once you change it, it will start in that language.

Tutorial

The tutorial is a real, but basic, game (called a scenario) where Delfador
teaches Konrad how to play. Winning or losing is not important, here, but
learning what to do is. Click the Tutorial button to play as Konrad and
remember what Delfador tells him.

Campaign

Wesnoth was designed to play campaigns only. Click this button for a list of
campaigns. Select your campaign and Ok to start or Cancel to quit.

Each campaign has a difficulty level: easy, medium (normal), and hard. We
recommend medium as this level is interesting, but not difficult. You may
not change the difficulty during the campaign. Once you have selected the
difficulty, you will start with the first scenario.

To learn more on Campaigns, see 'Playing a Campaign' and 'Load'.

Preferences

Click here to change default settings. You will be shown a dialouge with the
following options:

1- Music Volume (slider)
Drag the slider to the left, to make the music softer, and to the right to
make it louder.

2- sfx volume (slider)
Drag the slider to the left, to make the sound effects softer, and to the
right to make them louder.

3- Scroll speed (slider)
Drag the slider to the left, to make the map scroll slower, and to the right
to make it scroll faster.

4- Full Screen (check box)
Check this box to expand Wesnoth to fill the whole screen, or uncheck it, to
return to a window.

5- Turn Dialog (check box)
Check this box to show you a prompt dialogue whenever its your turn to move,
or uncheck it, to disable the turn dialogue.

6- Accelerated Speed (check box)
Check this box to double move speed, or uncheck it, for normal move speed.

7- Turn Bell (check box)
Check this box to sound a Bell on your turn, or uncheck it, to turn it off.

8- Show Grid (check box)
Check this box to outline each map hex, or uncheck it, to turn it off.

9- Show Team Colours (check box)
Check this box, to show each unit's team colour, or uncheck it, to turn it
off.

10- Video Mode (button)
Click this button to change the screen size. Choose from a list of available
sizes. Caution: Wesnoth may display badly, or not at all, if you make a
poor choice.

11- Hotkeys (button)
Click this button to change hotkeys. Caution: You may lose keyboard control
over one or more functions, if you disable hotkeys. To learn more, see
'Keyboard Control'.

12- Close Window (button)
Click this button to return to the Main Menu. All changes will be kept.

About

Click this button for a list of major Wesnoth contributors. You may find most
of them at irc.freenode.org:6667 on #wesnoth. Or visit http://www.wesnoth.org
for news, forums, and Wiki updates. The project is hosted on
http://savannah.gnu.org/projects/wesnoth , where you can download the latest production or
developer release, review and report problems (bugs).

Load

Click this button to load a previously saved game. You will be shown a
dialogue listing saved games. Select the game and click Ok to load and
continue, or Cancel to return to the Main Menu.

If you select a replay game, you can check the Replay check box. The loaded
game will make all the moves from the beginning while you watch.

Multiplayer

Click this button to play network games. A dialogue will appear for you to
create or connect to a game server. To learn more, see 'Network Games'.

Game Navigation

After loading a game or campaign, Wesnoth divides its screen into several
sections, listed here and described below (items marked with a * are undocumented).

1- Menu (button)
2- Your total Gold (display)
3- Your total villages (display)
4- Your total units (display)
5- Your total upkeep (display)
6- Your total Income (display)
7- Current hex type (info)
8- Current hex position (info)
9- Full map, scaled (select) *
10- Day cycle (graphic)
11- Last selected Unit profile (info) *
12- Turn counter (info) *
13- End Turn (button) *
14- Map (active) *

The map covers most of the window and is the most complex, so we discribe it
last. The other areas are useful when using the map, so we explain them now.

Menu button: Displays a popup, lists the following options:

1- Scenario Objectives: Lists the victory and defeat conditions.
2- Unit List: Lists your active units, including their map position.
3- Recruit: Lists units your commander can recruit from a keep.
4- Recall (Campaign only): Lists units your commander can recall from a keep.
5- Status Table: Summary list of visible player units, villages, income etc.
6- End Turn: On your turn, select it to end your turn.
7- Save Game: Write the current game position to disk.
8- Preferences: see Main Menu:preferences, for details.
9- Quit Game: Close the game, without saving, and return to the Main menu.

Your Total Gold, villages, units, upkeep, and income (info)
Quick way to check how your army is doing. A negative income means you'll
lose Gold, a positive means you gain Gold. Upkeep is the Gold you pay
your units. Villages shows how many you own, each viilage will give you
Gold.

Current hex
Shows the terrain type and position of the hex pointed to by the mouse. If
a unit is on the hex, its terrain Resistence is shown after the position.
The position is in column, row order.

Day Cycle
This is the picture underneath the mini-map to the right. Putting your mouse
over it will bring up a helpful tooltip. Note that Wesnoth has a 6-turn day
and that differnt alignments have bonuses depending on the time of day.





== Time to Play ==

=== Campaign ===

Campaigns take a very long time to complete, ranging from weeks to months.
Typical campaigns have about 20 to 30 scenarios. The main advantage with
campaigns is developing your army. As you complete each scenario, the
remaing units at the end are saved for you to use in the next scenario. If
you choose not to use a unit at all during a scenario it is carried over to
the next, so you don't lose units you don't use.

The campaign is the primary form in which Wesnoth is intended to be played,
and is probably the most enjoyable.

=== Scenarios ===

A single scenario takes about 30 minutes to 2 hours to complete. This is
the fastest way to play, but your units are not saved and you cannot use
campaign units. Depending on the scenario, you may play with an artificial
player or against several.

=== Hotseat ===

Hotseat games will take about the same time to play as games played remotely. The time will
be greatly affected by the size of the map.

=== Multiplayer ===

Multiplayer games can take anything from 1 hour to 10 hours, depending on
how many players there are. The average time is between 3 to 7 hours.
Games can be saved and loaded as many times as you like. So, it's
possible for some games to last 1 or 2 weeks, even though the
play time is only a few hours. Currently, you cannot carry over
units in multiplayer from one scenario to the next, so building up
your army's strength is possible only within the scenario.

== Battleworld Training ==

If you are new to Wesnoth, but have experience playing turn-based hex combat games, here is a way to find out how the terrain and units interact:

# Go to Multiplayer, and play the AI on Battleworld.
# Choose "Rebels". Give yourself two or three times as much gold as you give the AI. Set the leveling percentage to 16%. Set "gold per village" to 5x.
# Experiment with different time periods (which will give you different units) and fighting against different opponents.
# When you consistently overrun the AI, move the gold and exp settings back to normal. This will prepare you for the campaigns and multiplayer against other humans.

=== Getting the Most Fun Out of the Game ===

Remember, the idea of a game is to have fun! Here are some recommendations
from the development team on how to get the most fun out of the game:

* Consider playing the campaign on 'Medium' difficulty level, especially if you have prior experience with strategy games. We feel you'll find it much more rewarding.
* Don't sweat it too much when you lose some units. The campaign was designed to accomodate the player losing some units along the way.
* Don't abuse saved games. Long ago, Wesnoth only allowed saving the game at the end of a scenario. Mid-scenario saving was added as a convenience to use if you had to continue the game another day, or to protect against crashes. We do not recommend loading mid-scenario saved games over and over because your White Mage keeps getting killed. Learn to protect your White Mage instead, and balance risks! That is part of the strategy.
* If you must load a saved game, we recommend going back to the start of the scenario, so that you choose a new strategy that works, rather than simply finding random numbers that favor you.
* But remember, the aim is to have fun! You may have different tastes to the developers, so do what you enjoy most! If you enjoy loading the saved game every time you make a mistake, looking for the 'perfect' game where you never lose a unit, by all means, go right ahead!

== At the start of a scenario ==
* First, read the scenario objectives. Sometimes you do not have to kill enemy leaders instead it is enough that you survive number of turns, or pick up a particular object
* Look at the map: the terrain, the position of your leader and the other leader.
* Then, begin to recruit units. Cheap units are useful to soak up the first wave of an enemy's attack; advanced units can then be brought in as support. Fast units can be used as scouts, for exploring the map and for conquering villages.

== During the scenario ==
* Try to capture and keep control of as many villages as possible to keep the gold coming in
* Keep units in packs so the enemy cannot attack from as many sides, and so you can outnumber each enemy unit. Put your units in a line so that the enemy cannot attack any one of your unit from more than two sides.
* Different units have different strengths and weaknesses depending on terrain and who they are attacking; right click on units and select "Describe unit" to learn more
* You can use lower level units as cannon fodder, to slow down enemy. e.g. you can use them to block enemy reaching your important units
* You can cause damage to enemies with advanced units and then finish them with lower level units - to give them more experience (and finally make them advance to next level)
* When you have a White Mage (advances from Mage) or Druid (advances from Shaman), put it in the middle of a circle of units to heal them as they move across the map
* Losing units is expected, even advanced units
* Time of day really matters:
** lawful units do more damage at day and less damage at night
** chaotic units do more damage at night and less damage at day
** remember to always check the time of day on the right side of the screen. Plan ahead - think about what it's going to be next turn as well as this turn.
* Some units are resistant or vulnerable to different kind of attacks. Mounted units are weak vs pierce attacks. Fire and holy destroy undeads. To see how much a unit resists an attack type, right click on the unit, select 'Unit Description', then select 'Resistance'. It will show you how resistant a unit is to different types of attacks.

=== Healing ===
* Villages heal units from normal damage and poison
* A village heals by a fixed amount regardless of unit level.
* A unit can only be healed up to 8HP per turn.
* A unit may take several turns to be fully healed.
* A village takes the first turn to cure a poisoned unit, no healing is done.
* Healers can heal other units the same way villages do.
* Each healer can heal up to six units each turn.
* Healers (Elvish Shaman, Elvish Druid, Elvish Shyde, White Mage, Mage of Light, Paladin) heal all wounded units around them, so you can keep units close to the battle without losing them.
* Some healers can cure poisoned units in the same way villages do.
* Healers will first heal their own units and then all friendly ones.
* Healers do not heal enemy units.
* Healers cannot heal themselves, but see next point.
* Use your healers in pairs, so they can heal each other if needed.
* Healers can heal the same unit and speed up healing.
* Trolls and Woses regenerate themselves when injured.
* Trolls and Woses cannot regenerate other units.
* Trolls and Woses cure themselves from poison as a village does.
* Trolls and Woses can be healed by healers and a village.

== Winning a scenario ==
* Advanced units are needed to quickly kill enemy commanders, and to avoid losing lots of units.
* The quicker you win a scenario, the more gold you get; you will get more gold from winning early than from all of the map's villages for the rest of the turns.
* Killing all enemy leaders usually gives instant victory.

== More general tips ==
* After slaughtering scenarios (where your ass gets seriously kicked) there are usually "breathing room" scenarios where you can rather easily gain some gold and experience (advanced units)
* Advanced units have higher upkeep than lower level units (1 gp per level), loyal units are an exception.

== See Also ==
* [[WesnothManual]]
* [[AdvancedTactics]]

{{Play}}

GameConfigWML

2005-09-24T18:19:14Z

HaJo: /* The [game_config] tag */ Typos

This page has several unknown informations; they are represented by '???'.
Feel free to replace them with actual data.

== The [game_config] tag ==

This tag is a top level WML tag which can only be used once because
it defines basic settings that are used everywhere in the game.
In official versions of Wesnoth it is in ''game.cfg''; values used there are labeled 'standard'.

The following keys are recognised
* ''base_income'' (standard 2) how much your leader earns without any villages
* ''heal_amount'' (standard 4) how much the 'heal' ability (see [[AbilitiesWML]]) heals per unit
* ''healer_heals_per_turn'' (standard 8) how much a healer can heal per turn (total).
Healing is distributed clockwise, starting north of the healer,
until ''healer_heals_per_turn'' hitpoints have been regenerated.
* ''cure_amount'' (standard 8) how much the 'cure' ability heals per unit
* ''curer_heals_per_turn'' (standard 18) how much a curer can heal per turn (total)
* ''rest_heal_amount'' (standard 2) how much HP a unit gains each turn it rests
* ''recall_cost'' (standard 20) how much it costs to recall a unit; this cost is independent of level.
* ''kill_experience'' (standard 8)
killing a unit with ''level=X'' will give ''X//*//kill_experience'' experience to the killing unit.
However, if a unit has ''level=0//, it will still give half of ''X'' experience.

* ''icon'' (standard 'wesnoth-icon.png') the game icon file
* ''title'' (standard 'misc/title.png') the title screen image
* ''logo'' (standard 'misc/logo.png') the wesnoth logo which will be put over the title image
* ''title_music'' (standard 'main_menu.ogg') the music to play at the title screen

* ''logo_x'' (standard 525) the x position of the logo on the title screen
* ''logo_y'' (standard 70) the y position of the logo on the title screen
* ''buttons_x'' (standard 760) the x position of the buttons on the title screen
* ''buttons_y'' (standard 330) the y position of the buttons on the title screen
* ''buttons_padding'' (standard 20) space between buttons, and border in main menu
* ''tip_x'' (standard 100) ???
* ''tip_y'' (standard 500) ???
* ''tip_width'' (standard 495) ???
* ''tip_padding'' (standard 20) ???

* ''map_image'' (standard 'maps/wesnoth.png') the background image for the "About" screen
* ''sidebar_image'' (standard 'misc/rightside.png') border of window when displaying unit statistics
* ''sidebar_image_bottom'' (standard 'misc/rightside-bottom.png') border of image when displaying unit statistics
* ''moved_energy_image'' (standard 'misc/bar-energy-moved.png')
the diamond image to add on top of the hp bar for player's moved units; see 'Orbs', [[WesnothManual]]
* ''unmoved_energy_image'' (standard 'misc/bar-energy-unmoved.png')
like ''moved_energy_image'', but for player's unmoved units
* ''partmoved_energy_image'' (standard 'misc/bar-energy-partmoved.png')
like ''moved_energy_image'', but for player's partially moved units
* ''enemy_energy_image'' (standard 'misc/bar-energy-enemy.png')
like ''moved_energy_image'', but for enemy units
* ''ally_energy_image'' (standard 'misc/bar-energy-ally.png')
like ''moved_energy_image'', but for allied units
* ''flag_image'' (standard 'terrain/flag-team%d-1.png:150,terrain/flag-team%d-2.png:150')
the image for a flag.
The symbol '%d' is used as a shortcut for an integer which depends on the color of the flag;
for example, a red flag is shown by the alternating images 'terrain/flag-team1-1.png' and 'terrain/flag-team1-2.png'.
(What does ':150' do???)

* ''cross_image'' (standard 'misc/cross.png') the cross image displayed on the map at start of scenarios; see [[IntroWML]]
* ''dot_image'' (standard 'misc/dot.png') the dot image used to draw a path on the map before scenarios

* ''footprint_left_nw//,//footprint_left_n//,//footprint_right_nw//,//footprint_right_n''
images used to display the path that a unit would take to the tile the cursor is on.
The first image of each key is used for tiles which would take only 1 movement point for the selected unit to move onto;
the second for ones which would take more.
The 'n' and 'nw' designations distinguish between tiles which are moved from orthogonally and diagonally in the same way as described in '''[missile_frame]''', [[AttackWML]].
The 'left' and 'right' designations are used alternately throughout the path;
however, the standard values are the same for 'left' and 'right'.

* ''missile_n_image'' (standard 'projectiles/missile-n.png') orthogonal missile image to use if none is specified;
see ''image'', '''[missile_frame]''', [[AttackWML]]
* ''missile_ne_image'' (standard 'projectiles/missile-ne.png') diagonal missile image to use if none is specified;
see ''image_diagonal'', '''[missile_frame]''', [[AttackWML]]
* ''terrain_mask_image'' (standard 'terrain/alphamask.png') ???
* ''observer_image'' (standard 'misc/eye.png') the image to use for observer ???
* ''download_campaign_image'' (standard no image) the icon for the "Download more Campaigns" campaign menu option.

== See Also ==

* [[ReferenceWML]]

ThemeWML

2005-09-17T20:53:11Z

HaJo: /* the toplevel [theme] tag */

== the toplevel [theme] tag ==

Themes are used both for the wesnoth game and the wesnoth editor.
Themes allow flexible configuration of how everything is laid out on-screen.

The only key in [theme] is ''name''. This is the name of the theme.

The only tag in [theme] is '''[resolution]''', but each theme can have multiple [resolution] tags.
The [resolution] tags are scanned until the first one which is of the same or lower resolution than is currently being used is found, and this is used as our theme.
This allows us to define themes to work differently on different resolutions,
and will allow us to support both high and low resolutions elegantly.

The following keys and tags are recognized for [resolution]:

* ''width//,//height'' dimensions in pixels

All subtags of [resolution] use the following keys:
* ''rect'' defines the rectangle to display on. Parts of a ''rect=a,b,c,d'' clause may be:
** number : absolute positions
** ''='' : same value as the same field in reference rect (alignment with reference)
** +number or -number : for a and b, add this value to reference's c and d respectively (spacing from reference)
; for c and d, add this value to self's a and b (specify by width and height)
** =+number or =-number : add this value to same field in reference rect (eg. consider reference as a container box)
* ''xanchor//,//yanchor'' control the behavior of how this rectangle changes as the resolution changes.
** 'left' its distance from the left side of the screen always remain the same, while changes in the resolution will change its size by the same amount (top for the y axis).
** 'right' its size always remain the same, as well as its distance to the right side of the screen (bottom for the y axis).
** 'fixed' its co-ordinates in that axis remain constant
** 'proportional' its co-ordinates multiplied by the ratio of the resolution being used to the canonical resolution.

== [main_map] ==

defines where the main game display (i.e. all the hexagons and units) is displayed.

== [mini_map] ==

determines where the mini map is displayed

== [panel] ==

displays an image as a panel on-screen.
* ''image'' the image used for the panel

== [label] ==

displays a text label on screen.
* ''prefix'' a string that will be printed before the text in all language
* ''text'' a text string id to be displayed
* ''postfix'' a string that will be printed after the text in all language
* ''icon'' an image that will be displayed instead of the text if it is available
* ''font_size'' the size of font to use for the label

== [menu] ==

* ''title'' the id of the string to write on the button
* ''title_literal'' a string that will be displayed "as is" in all language after the title
* ''image'' the image to use if available
* ''is_context_menu'' if set to true this menu will not be placed, but displayed on a right click
* ''items'' comma separated list of actions to put in the menu. if there is only one action, it will be executed
immediately and no menu will be displayed
** 'cycle' move to next movable unit
** 'endunitturn' consume this unit's move and cycle to the next one
** 'leader' senter on the leader
** 'undo' undo last action
** 'redo' redo undone action
** 'zoomin' zoom the map in
** 'zoomout' zoom the map out
** 'zoomdefault' return to default zoom
** 'fullscreen' switch fulscreen mode
** 'accelerated' switch turbo mode
** 'resistance' show resistance table of current unit
** 'terraintable' show terrain table of current unit
** 'describeunit' show unit description
** 'renameunit' change unit name
** 'save' save the game
** 'recruit' recruit a unit
** 'repeatrecruit' repeat last recruitement
** 'recall' recall a unit from previous scenarion
** 'endturn' end current turn
** 'togglegrid' toggle grid display
** 'statustable' show status table
** 'mute' mute all sounds
** 'speak' send message to other players
** 'createunit' debug create a unit on the map
** 'preferences' open preference dialog
** 'objectives' show objective window
** 'unitlist' list units
** 'statistics' show game statistics
** 'quit' quit the game
** 'labelterrain' label current location
** 'showenemymoves' show grids reachable by the enemy
** 'bestenemymoves' show grids reachable by the enemy with no zone of control
** 'editnewmap' editor only start a new map
** 'editloadmap' editor only loads an existing map
** 'editsavemap' editor only saves the current map
** 'editsaveas' editor only saves the current map, let you choose a filename
** 'editsetstartpos' editor only set a starting position for a team
** 'editfloodfill' editor only flood the map with a terrain
** 'toggleshroud' toggle the "moving removes shroud" behaviour
** 'updateshroud' removes all possible shroud

== [status] ==

This tag describes the Status Table.
This tag contains many other tags, which determine where other game statistics, such as the current turn, and a description of selected units go.
For instance, the [time_of_day] tag will determine where the time of day image goes.
Each subtag of [status] can contain the following attributes

** ''font_size'' the size of font to use for the status
** ''rect'' the rectangle as for the main_map attribute
** ''xanchor'' the x-wise anchoring as for the main_map attribute
** ''yanchor'' the y-wise anchoring as for the main_map attribute
** ''prefix'' the string to display before the actual status, this is the string id for internationalisation
** ''prefix_literal'' a string to put after the prefix, but before the label for all languages.
** ''postfix_literal'' a string to put after the status
** ''postfix'' the string to display after the postfix_literal, this is the string id for internationalisation

the following tags are recognized for [status]:
* '''[unit_description]''' the user description of the current unit
* '''[unit_type]''' the type of the current unit
* '''[unit_level]''' the level of the current unit
* '''[unit_traits]''' the traits of the current unit
* '''[unit_status]''' the status of the current unit
* '''[unit_alignment]''' the alignment of the current unit
* '''[unit_abilities]''' the abilities of the current unit
* '''[unit_hp]''' the HP of the current unit
* '''[unit_xp]''' the XP of the current unit
* '''[unit_moves]''' the moves remaining for the current unit
* '''[unit_weapons]''' the attacks of the current unit
* '''[unit_image]''' the icon for the current unit
* '''[unit_profile]'''
* '''[time_of_day]''' the time of day on the current location
* '''[turn]''' the turn number and turn remaining
* '''[gold]''' the gold remaining
* '''[villages]''' the number of villages owned
* '''[num_units]''' the number of units owned
* '''[upkeep]''' the money needed to keep your units every turn
* '''[expenses]''' the money lost each turn when you don't have enough income
* '''[income]''' the income per turn (can be positive)
* '''[terrain]''' the text description of the current terrain
* '''[position]''' the current terrain's position
* '''[side_playing]''' the current playing side
* '''[observers]''' the current observers

== See Also ==

* [[ThemeSystem]]
* [[ReferenceWML]]

ThemeWML

2005-09-17T20:51:35Z

HaJo: /* the toplevel [theme] tag */

== the toplevel [theme] tag ==

Themes are used both for the wesnoth game and the wesnoth editor.
Themes allow flexible configuration of how everything is laid out on-screen.

The only key in [theme] is ''name''. This is the name of the theme.

The only tag in [theme] is '''[resolution]''', but each theme can have multiple [resolution] tags.
The [resolution] tags are scanned until the first one which is of the same or lower resolution than is currently being used is found, and this is used as our theme.
This allows us to define themes to work differently on different resolutions,
and will allow us to support both high and low resolutions elegantly.

The following keys and tags are recognized for [resolution]:

* ''width//,//height'' dimensions in pixels

All subtags of [resolution] use the following keys:
* ''rect'' defines the rectangle to display on. Parts of a ''rect=a,b,c,d'' clause may be:
** number : absolute positions
** ''='' : same value as the same field in reference rect (alignement with reference)
** +number or -number : for a and b, add this value to reference's c and d respectively (spacing from reference)
; for c and d, add this value to self's a and b (specify by width and height)
** =+number or =-number : add this value to same field in reference rect (eg. consider reference as a container box)
* ''xanchor//,//yanchor'' control the behavior of how this rectangle changes as the resolution changes.
** 'left' its distance from the left side of the screen always remain the same, while changes in the resolution will change its size by the same amount (top for the y axis).
** 'right' its size always remain the same, as well as its distance to the right side of the screen (bottom for the y axis).
** 'fixed' its co-ordinates in that axis remain constant
** 'proportional' its co-ordinates multiplied by the ratio of the resolution being used to the canonical resolution.

== [main_map] ==

defines where the main game display (i.e. all the hexagons and units) is displayed.

== [mini_map] ==

determines where the mini map is displayed

== [panel] ==

displays an image as a panel on-screen.
* ''image'' the image used for the panel

== [label] ==

displays a text label on screen.
* ''prefix'' a string that will be printed before the text in all language
* ''text'' a text string id to be displayed
* ''postfix'' a string that will be printed after the text in all language
* ''icon'' an image that will be displayed instead of the text if it is available
* ''font_size'' the size of font to use for the label

== [menu] ==

* ''title'' the id of the string to write on the button
* ''title_literal'' a string that will be displayed "as is" in all language after the title
* ''image'' the image to use if available
* ''is_context_menu'' if set to true this menu will not be placed, but displayed on a right click
* ''items'' comma separated list of actions to put in the menu. if there is only one action, it will be executed
immediately and no menu will be displayed
** 'cycle' move to next movable unit
** 'endunitturn' consume this unit's move and cycle to the next one
** 'leader' senter on the leader
** 'undo' undo last action
** 'redo' redo undone action
** 'zoomin' zoom the map in
** 'zoomout' zoom the map out
** 'zoomdefault' return to default zoom
** 'fullscreen' switch fulscreen mode
** 'accelerated' switch turbo mode
** 'resistance' show resistance table of current unit
** 'terraintable' show terrain table of current unit
** 'describeunit' show unit description
** 'renameunit' change unit name
** 'save' save the game
** 'recruit' recruit a unit
** 'repeatrecruit' repeat last recruitement
** 'recall' recall a unit from previous scenarion
** 'endturn' end current turn
** 'togglegrid' toggle grid display
** 'statustable' show status table
** 'mute' mute all sounds
** 'speak' send message to other players
** 'createunit' debug create a unit on the map
** 'preferences' open preference dialog
** 'objectives' show objective window
** 'unitlist' list units
** 'statistics' show game statistics
** 'quit' quit the game
** 'labelterrain' label current location
** 'showenemymoves' show grids reachable by the enemy
** 'bestenemymoves' show grids reachable by the enemy with no zone of control
** 'editnewmap' editor only start a new map
** 'editloadmap' editor only loads an existing map
** 'editsavemap' editor only saves the current map
** 'editsaveas' editor only saves the current map, let you choose a filename
** 'editsetstartpos' editor only set a starting position for a team
** 'editfloodfill' editor only flood the map with a terrain
** 'toggleshroud' toggle the "moving removes shroud" behaviour
** 'updateshroud' removes all possible shroud

== [status] ==

This tag describes the Status Table.
This tag contains many other tags, which determine where other game statistics, such as the current turn, and a description of selected units go.
For instance, the [time_of_day] tag will determine where the time of day image goes.
Each subtag of [status] can contain the following attributes

** ''font_size'' the size of font to use for the status
** ''rect'' the rectangle as for the main_map attribute
** ''xanchor'' the x-wise anchoring as for the main_map attribute
** ''yanchor'' the y-wise anchoring as for the main_map attribute
** ''prefix'' the string to display before the actual status, this is the string id for internationalisation
** ''prefix_literal'' a string to put after the prefix, but before the label for all languages.
** ''postfix_literal'' a string to put after the status
** ''postfix'' the string to display after the postfix_literal, this is the string id for internationalisation

the following tags are recognized for [status]:
* '''[unit_description]''' the user description of the current unit
* '''[unit_type]''' the type of the current unit
* '''[unit_level]''' the level of the current unit
* '''[unit_traits]''' the traits of the current unit
* '''[unit_status]''' the status of the current unit
* '''[unit_alignment]''' the alignment of the current unit
* '''[unit_abilities]''' the abilities of the current unit
* '''[unit_hp]''' the HP of the current unit
* '''[unit_xp]''' the XP of the current unit
* '''[unit_moves]''' the moves remaining for the current unit
* '''[unit_weapons]''' the attacks of the current unit
* '''[unit_image]''' the icon for the current unit
* '''[unit_profile]'''
* '''[time_of_day]''' the time of day on the current location
* '''[turn]''' the turn number and turn remaining
* '''[gold]''' the gold remaining
* '''[villages]''' the number of villages owned
* '''[num_units]''' the number of units owned
* '''[upkeep]''' the money needed to keep your units every turn
* '''[expenses]''' the money lost each turn when you don't have enough income
* '''[income]''' the income per turn (can be positive)
* '''[terrain]''' the text description of the current terrain
* '''[position]''' the current terrain's position
* '''[side_playing]''' the current playing side
* '''[observers]''' the current observers

== See Also ==

* [[ThemeSystem]]
* [[ReferenceWML]]

ThemeSystem

2005-09-17T20:44:56Z

HaJo: /* menu */

- themes are used both for the wesnoth game and the wesnoth editor
- themes are stored in data/themes, one theme per file.
- themes allow flexible configuration of how everything is laid out on-screen
- format of a theme is:

Code:
[theme]
name=<name>
[resolution]
width=<x>
height=<y>
....'content tags'....
[/resolution]
...more resolution tags...
[/theme]

* the [resolution] tags are scanned until the first one which is of the same or lower resolution than is currently being used is found, and this is used as our theme. This allows us to define themes to work differently on different resolutions, and will allow us to support both high and low resolutions elegantly.
* the 'content tags' define where everything goes on-screen. The most common content tag is the 'main_map' tag, it has the following format:

Code:
[main_map]
rect=x1,y1,x2,y2
xanchor=left|right|fixed|proportional
yanchor=top|bottom|fixed|proportional
[/main_map]

The purpose of the 'main_map' tag is to define where the main game display (i.e. all the hexagons and units) is displayed. The rect field defines the rectangle the map is displayed on. The rectangle is given for a 1024x768 display -- the game's "canonical" resolution.

xanchor and yanchor control the behavior of how this rectangle changes as the resolution changes.

* A rectangle anchored to the left will have its distance from the left side of the screen always remain the same, while changes in the resolution will change its size by the same amount (top for the y axis).
* A rectangle anchored to the right will have its size always remain the same, as well as its distance to the right side of the screen (bottom for the y axis).
* A rectangle that is fixed will have its co-ordinates in that axis remain constant
* A rectangle that is proportional will have its co-ordinates multiplied by the ratio of the resolution being used to the canonical resolution.

== mini_map ==
determines where the mini map is displayed

== main_map ==
determines where the main map is displayed

== label ==
displays a text label on screen.
* '''prefix''' a string that will be printed before the text in all languages
* '''text''' a text string id to be displayed
* '''postfix''' a string that will be printed after the text in all languages
* '''icon''' an image that will be displayed instead of the text if it is available
* '''font_size''' the size of the font to use for the label

== panel ==
displays an image as a panel on-screen.
* '''image''' the image used for the panel

== menu ==
displays a button which, when pressed, will reveal a menu or do an action.
* '''title''' the id of the string to write on the button
* '''title_literal''' a string that will be displayed "as is" in all languages after the title
* '''image''' the image to use if available
* '''is_context_menu''' if set to true, this menu will not be placed, but displayed on a right click
* '''items''' comma separated list of actions to put in the menu. If there is only one action, it will be executed immediately and no menu will be displayed

The possible buttons are:
* __cycle__ move to next movable unit
* __endunitturn__ consume this unit's move and cycle to the next one
* __leader__ center map on the leader
* __undo__ undo last action
* __redo__ redo undone action
* __zoomin__ zoom into the map
* __zoomout__ zoom out of the map
* __zoomdefault__ return to default zoom
* __fullscreen__ switch fullscreen mode
* __accelerated__ switch turbo mode
* __resistance__ show resistance table of current unit
* __terraintable__ show terrain table of current unit
* __describeunit__ show unit description
* __renameunit__ change unit name
* __save__ save the game
* __recruit__ recruit a unit
* __repeatrecruit__ repeat last recruitement
* __recall__ recall a unit from a previous scenario
* __endturn__ end current turn
* __togglegrid__ toggle grid display
* __statustable__ show status table
* __mute__ mute all sounds
* __speak__ send message to other players
* __createunit__ ''debug'' create a unit on the map
* __preferences__ open preference dialog
* __objectives__ show objective window
* __unitlist__ list units
* __statistics__ show game statistics
* __quit__ quit the game
* __labelterrain__ label current location
* __showenemymoves__ show grids reachable by the enemy
* __bestenemymoves__ show grids reachable by the enemy with no zone of control
* __editnewmap__ ''editor only'' start a new map
* __editloadmap__ ''editor only'' loads an existing map
* __editsavemap__ ''editor only'' saves the current map
* __editsaveas__ ''editor only'' saves the current map, let you choose a filename
* __editsetstartpos__ ''editor only'' set a starting position for a team
* __editfloodfill__ ''editor only'' flood the map with a terrain
* __toggleshroud__ toggle the "moving removes shroud" behaviour
* __updateshroud__ removes all possible shroud

== status ==
this tag contains many other tags, which determine where other game statistics, such as the current turn, and a description of selected units go. For instance, the time_of_day tag will determine where the time of day image goes. each subtag can contain the following attributes
* '''font_size''' the size of font to use for the status
* '''rect''' the rectangle as for the main_map attribute
* '''xanchor''' the x-wise anchoring as for the main_map attribute
* '''yanchor''' the y-wise anchoring as for the main_map attribute
* '''prefix''' the string to display before the actual status, this is the string id for internationalisation
* '''prefix_literal''' a string to put after the prefix, but before the label for all languages.
* '''postfix_literal''' a string to put after the status
* '''postfix''' the string to display after the postfix_literal, this is the string id for internationalisation

the following stati are recognised:
* __unit_description__ the description of the current unit
* __unit_type__ the type of the current unit
* __unit_level__ the level of the current unit
* __unit_traits__ the traits of the current unit
* __unit_status__ the status of the current unit
* __unit_alignment__ the alignment of the current unit
* __unit_abilities__ the abilities of the current unit
* __unit_hp__ the HP of the current unit
* __unit_xp__ the XP of the current unit
* __unit_moves__ the moves remaining for the current unit
* __unit_weapons__ the attacks of the current unit
* __unit_image__ the icon for the current unit
* __unit_profile__
* __time_of_day__ the time of day on the current location
* __turn__ the turn number and turn remaining
* __gold__ the gold remaining
* __villages__ the number of villages owned
* __num_units__ the number of units owned
* __upkeep__ the money needed to keep your units every turn
* __expenses__ the money lost each turn when you don't have enough income
* __income__ the income per turn (can be positive)
* __terrain__ the text description of the current terrain
* __position__ the current terrain's position
* __side_playing__ the current playing side
* __observers__ the current observers

== See Also ==

* [[ThemeWML]]

__NOTOC__

ThemeSystem

2005-09-17T20:39:58Z

HaJo: /* label */

- themes are used both for the wesnoth game and the wesnoth editor
- themes are stored in data/themes, one theme per file.
- themes allow flexible configuration of how everything is laid out on-screen
- format of a theme is:

Code:
[theme]
name=<name>
[resolution]
width=<x>
height=<y>
....'content tags'....
[/resolution]
...more resolution tags...
[/theme]

* the [resolution] tags are scanned until the first one which is of the same or lower resolution than is currently being used is found, and this is used as our theme. This allows us to define themes to work differently on different resolutions, and will allow us to support both high and low resolutions elegantly.
* the 'content tags' define where everything goes on-screen. The most common content tag is the 'main_map' tag, it has the following format:

Code:
[main_map]
rect=x1,y1,x2,y2
xanchor=left|right|fixed|proportional
yanchor=top|bottom|fixed|proportional
[/main_map]

The purpose of the 'main_map' tag is to define where the main game display (i.e. all the hexagons and units) is displayed. The rect field defines the rectangle the map is displayed on. The rectangle is given for a 1024x768 display -- the game's "canonical" resolution.

xanchor and yanchor control the behavior of how this rectangle changes as the resolution changes.

* A rectangle anchored to the left will have its distance from the left side of the screen always remain the same, while changes in the resolution will change its size by the same amount (top for the y axis).
* A rectangle anchored to the right will have its size always remain the same, as well as its distance to the right side of the screen (bottom for the y axis).
* A rectangle that is fixed will have its co-ordinates in that axis remain constant
* A rectangle that is proportional will have its co-ordinates multiplied by the ratio of the resolution being used to the canonical resolution.

== mini_map ==
determines where the mini map is displayed

== main_map ==
determines where the main map is displayed

== label ==
displays a text label on screen.
* '''prefix''' a string that will be printed before the text in all languages
* '''text''' a text string id to be displayed
* '''postfix''' a string that will be printed after the text in all languages
* '''icon''' an image that will be displayed instead of the text if it is available
* '''font_size''' the size of the font to use for the label

== panel ==
displays an image as a panel on-screen.
* '''image''' the image used for the panel

== menu ==
displays a button which, when pressed will reveal a menu or do a an action.
* '''title''' the id of the string to write on the button
* '''title_literal''' a string that will be displayed "as is" in all language after the title
* '''image''' the image to use if available
* '''is_context_menu''' if set to true this menu will not be placed, but displayed on a right click
* '''items''' comma separated list of actions to put in the menu. if there is only one action, it will be executed immediately and no menu will be displayed

the possible buttons are:
* __cycle__ move to next movable unit
* __endunitturn__ consume this unit's move and cycle to the next one
* __leader__ senter on the leader
* __undo__ undo last action
* __redo__ redo undone action
* __zoomin__ zoom the map in
* __zoomout__ zoom the map out
* __zoomdefault__ return to default zoom
* __fullscreen__ switch fulscreen mode
* __accelerated__ switch turbo mode
* __resistance__ show resistance table of current unit
* __terraintable__ show terrain table of current unit
* __describeunit__ show unit description
* __renameunit__ change unit name
* __save__ save the game
* __recruit__ recruit a unit
* __repeatrecruit__ repeat last recruitement
* __recall__ recall a unit from previous scenarion
* __endturn__ end current turn
* __togglegrid__ toggle grid display
* __statustable__ show status table
* __mute__ mute all sounds
* __speak__ send message to other players
* __createunit__ ''debug'' create a unit on the map
* __preferences__ open preference dialog
* __objectives__ show objective window
* __unitlist__ list units
* __statistics__ show game statistics
* __quit__ quit the game
* __labelterrain__ label current location
* __showenemymoves__ show grids reachable by the enemy
* __bestenemymoves__ show grids reachable by the enemy with no zone of control
* __editnewmap__ ''editor only'' start a new map
* __editloadmap__ ''editor only'' loads an existing map
* __editsavemap__ ''editor only'' saves the current map
* __editsaveas__ ''editor only'' saves the current map, let you choose a filename
* __editsetstartpos__ ''editor only'' set a starting position for a team
* __editfloodfill__ ''editor only'' flood the map with a terrain
* __toggleshroud__ toggle the "moving removes shroud" behaviour
* __updateshroud__ removes all possible shroud

== status ==
this tag contains many other tags, which determine where other game statistics, such as the current turn, and a description of selected units go. For instance, the time_of_day tag will determine where the time of day image goes. each subtag can contain the following attributes
* '''font_size''' the size of font to use for the status
* '''rect''' the rectangle as for the main_map attribute
* '''xanchor''' the x-wise anchoring as for the main_map attribute
* '''yanchor''' the y-wise anchoring as for the main_map attribute
* '''prefix''' the string to display before the actual status, this is the string id for internationalisation
* '''prefix_literal''' a string to put after the prefix, but before the label for all languages.
* '''postfix_literal''' a string to put after the status
* '''postfix''' the string to display after the postfix_literal, this is the string id for internationalisation

the following stati are recognised:
* __unit_description__ the description of the current unit
* __unit_type__ the type of the current unit
* __unit_level__ the level of the current unit
* __unit_traits__ the traits of the current unit
* __unit_status__ the status of the current unit
* __unit_alignment__ the alignment of the current unit
* __unit_abilities__ the abilities of the current unit
* __unit_hp__ the HP of the current unit
* __unit_xp__ the XP of the current unit
* __unit_moves__ the moves remaining for the current unit
* __unit_weapons__ the attacks of the current unit
* __unit_image__ the icon for the current unit
* __unit_profile__
* __time_of_day__ the time of day on the current location
* __turn__ the turn number and turn remaining
* __gold__ the gold remaining
* __villages__ the number of villages owned
* __num_units__ the number of units owned
* __upkeep__ the money needed to keep your units every turn
* __expenses__ the money lost each turn when you don't have enough income
* __income__ the income per turn (can be positive)
* __terrain__ the text description of the current terrain
* __position__ the current terrain's position
* __side_playing__ the current playing side
* __observers__ the current observers

== See Also ==

* [[ThemeWML]]

__NOTOC__

Races

2005-08-30T14:47:40Z

HaJo: /* Drakes */ Typo

== The Six Main Races ==

=== Humans ===

Humans first appeared in Wesnoth from a land far across the ocean to the West, the Green Isle. They do not possess much magic, though they can learn it, and can learn many more types of it than most others. They have no extra special abilities or aptitudes except their versatility and drive. Although often at odds with all races, they can occasionally form alliances with the less aggressive races such as elves and dwarves, and the less scrupulous among them do not shrink back from hiring orcish mercenaries, either. They have no natural enemies, although the majority of humans, like
most people of all races, have an instinctive dislike of the undead. Men are shorter than the elves, but taller still than dwarves or orcs.

Many different groups of humans exist, but the majority of humans live in the country of Wesnoth. These are protected by the soldiers of the Wesnothian Army, the most organized military force in the known world. Its warriors come from the main provinces, where all men are conscripted at an early age, or from the eastern plains, where the art of horseriding and archery are taught from birth.
* Units:Bowman
* Units:Cavalryman
* Units:Fencer
* Units:HeavyInfantryman
* Units:Horseman
* Units:Mage
* Units:Spearman

Bands of outlaw humans roam the wild areas of the Great Continent, stealing from unprotected villages. Most would run in fear if faced by a true army, but the more skilled of them would not be afraid to walk right into an opponent's camp, assassinate their leader, and run away.
* Units:Footpad
* Units:Poacher
* Units:Thief
* Units:Bandit
* Units:GryphonRider

Although the art of necromancy is outlawed in Wesnoth, some mages choose to practice it, starting them on the road to Lichdom.
* Units:DarkAdept

=== Elves ===

Elves are the elder race. They are skilled with the bow and arrow - almost all of them carry one - and are also good with the sword. They do not use many weapons but these, although they are in command of powerful magic, and do use it when needed. Physically, Elves are quite tall, and seem even taller due to their slimness. They are peaceful beings, but will fight against any who enter their homeland unasked. They live mostly in the forests of the Southwest, although some choose to live in the harsh Northlands.
* Units:ElvishArcher
* Units:ElvishFighter
* Units:ElvishScout
* Units:ElvishShaman

=== Orcs ===

Orcs are a race of fierce, brown-skinned human-like creatures found across the wild places of the world. They came from across the sea, following the humans of the Green Isle. They are violent, quick-tempered, and belligerent, and hold an ancient hatred for the race of elves. Although orcs are disorganized and prone to infighting, warbands under a strong leader can cut bloody inroads into the boundaries where civilization meets wilderness. Most live in the Northland, away from the settled land of Wesnoth, whose people they are more often than not at war with. They are a greedy race, and
often can be found fighting under the banner of a lich-lord or human, hoping to gain riches from those they defeat.
* Units:OrcishArcher
* Units:OrcishAssassin
* Units:OrcishGrunt

Goblins are a different breed than the orcs, smaller and weaker, but quicker. However, since they are the same species, they are considered by most the same race.
* Units:WolfRider
* Units:GoblinSpearman

=== Dwarves ===

Dwarves were living on the Great Continent before Haldric arrived, but they were also immigrants, like him, coming from the East across the mountains. Dwarves are the height of human children, but are stronger than even fully grown men.
They are a solitary folk, cautious and slow to anger, but once their anger is roused they are terrible fighters.
Wielding many weapons with equal skill, dwarves are effective against many different races. They see in pitch darkness due to their constant work underground, and their heavy armor protects them against almost any physical attack, although magic can harm them effectively. The most skilled smiths of any in the realm, they are often hired by foreign kings to craft magical items, and the weapons and jewelry they make have been the cause of numerous wars.
* Units:DwarvishFighter
* Units:DwarvishGuardsman
* Units:DwarvishThunderer
* Units:DwarvishUlfserker

=== Undead ===

As their race's name means, these are lost souls caught between this realm and next. Themselves deprived of life, they wish to likewise deprive all others of it. They are created by Necromancers, practitioners of dark magic, and are controlled by them when raised. After the necromancer controlling them dies, they remain in this world, and continue fighting for a purpose noone, perhaps not even themselves, know. Most of them are strong against physical attacks, but are weak against fire and holy assaults. Since they do not require bodily warmth to survive, cold is very ineffectual
against them.
* Units:Ghost
* Units:Ghoul
* Units:Skeleton
* Units:SkeletonArcher
* Units:VampireBat
* Units:WalkingCorpse

=== Drakes ===

Drakes are the sons of dragons, almost the last legacy of those mighty beasts.
Most of the race can fly and spit fire.
When the fire in their body is extinguished so is their life.
Because of this they are weak against cold, but they are good against most other attacks.
However, due to their soft underbellies, "sharp, pointy weapons" have always been their weakness, a characteristic most consider very dragonlike. They are heavy and move slowly, but once they reach their enemy they are devastating.
Their homeland was an island named Morogor, located between Wesnoth and the Green Isle, but it slowly sank into the sea, and now many of them are nomads, flying over the sea looking for a place to settle undisturbed.
* Units:DrakeBurner
* Units:DrakeClasher
* Units:DrakeFighter
* Units:DrakeGlider

== Other Races ==

There are other races than these six main ones. They often align with the larger races, but these alliances are usually not permanent.

=== Lizards ===
These are the smaller, more crafty allies of the Drakes. They often live in swamps or other damp places.
* Units:SaurianSkirmisher
* Units:SaurianTribalist

=== Merfolk ===
The Merfolk live in the shallow parts of the ocean, wary of the monsters that lurk in the deep. Ordinarily they form alliances with no one, but in Asheviere's time they allied with the elves in order to defeat their captors. Mermen are powerful and quick in any watery environment, but struggle greatly to move on land.

* Units:MermaidInitiate
* Units:MermanFighter
* Units:MermanHunter

=== Nagas ===
The long time enemies of the Merfolk, and in Asheviere's time allied with orcs to finally defeat their opponents.
They usually join forces with anyone willing to help them defeat the mermen.
* Units:NagaFighter

=== Ogres ===
The Ogres are wild beasts that live in the Northlands, but the Wesnothian army occasionally captures them and trains them for battle. They are extremely brutish and stupid, but possess enough intelligence to wield a weapon.
* Units:YoungOgre

=== Trolls ===
The Trolls are slightly more intelligent than Ogres, and ally with the Orcs whenever their shared homeland is in danger. However, most of the time they avoid each other.
* Units:TrollWhelp

=== Monsters ===

There are many monsters that roam about the land, not obeying anyone's orders. Occasionally, but not often, those who see them survive to tell the tale, and it is only from them that the people of Wesnoth know of their existence.
* Units:Cockatrice
* Units:Cuttlefish
* Units:FireDragon
* Units:GiantScorpion
* Units:GiantSpider
* Units:Gryphon
* Units:Mudcrawler
* Units:SeaSerpent
* Units:Yeti