The Mana World - User contributions [en]

Development:Joining the project

2013-06-07T14:59:15Z

Jenalya: Replace "Contact Jenalya" with "ask in irc and forums"

So you want to help this project, but you have little or no idea how to get into it? The Mana World development team is not a closed circle like many other projects. You don't need to apply to anyone or ask for "being taken into the team". You don't have to ask for permission to work on something or wait for someone to assign a task to you. A team member is basically anyone who volunteers to do something for the game. For further information and assistance, you can ask for help in [http://wiki.themanaworld.org/index.php/Irc#Does_TMW_have_an_IRC_channel.3F IRC] or on the [http://forums.themanaworld.org/ forums]. You'll be more effective if you know [[Dev:Working With Git|how to use Git]].

==Technical aspects==
The technical aspects of development of TMW include tweaking our custom server (tmwAthena). The server is done in C++ and scripts are done in the tmwAthena scripting language. Notably tmwAthena is an SVN snapshot from [http://eathena.ws/ eAthena] (a [http://en.wikipedia.org/wiki/Ragnarok_Online Ragnarok Online] game server emulator software) in early 2004. We've extensively hacked it and cleaned it over the years (it was at the moment of taking the snapshot in transition from the basis of an old hacky [http://en.wikipedia.org/wiki/MUD MUD] server to the current eAthena codebase). The technical aspects of the TMW project also include packaging data updates for the client.

===Clients===

====ManaPlus====
Official client. [http://manaplus.evolonline.org/ Site and downloads], [http://bugs.evolonline.org bug tracker].

====Mana====
Original client. [http://manasource.org/ Site], [http://manasource.org/downloads downloads], [http://bugs.manasource.org bug tracker].

==Content==
Content means: new monsters, new equipment, new maps, new NPCs, new quests, new anything into the game.

Content does not mean: GFX, SFX.

Before anything can get into the game, it should be designed. After that it should be implemented server-sided. Then GFX and potentially also SFX can be requested for it and it can go into the game once they're done. Currently visioning ideas is a collective process anyone can take part in and the people doing scripting are cherry-picking whatever ideas they want to get into the game. Scripting stuff is also a free for all process. Once there is a good idea to expand the world, in general new maps can be requested. Reading the forums thoroughly and asking publicly usually gets you answers rather well.

[http://forums.themanaworld.org/viewforum.php?f=13 Content development forum]

==Graphics==
Graphics development could currently (June 2013) use a few pixel artists going about and retouching old mistakes in tilesets and sprite sets. Also if the content development crowd picks up and starts to provide concepts which would require new GFX work to be done, then there is going to be a demand for new equipment work, tilesets and sprite sets. Please remember to pay attention to our [[guidelines]].

Also do hunt for unfulfilled REQ topics on the forums if you're looking for something to do. Newbie pixel artists or people doing their first pixel art piece ever are also very welcome. The community can be pretty harsh at times, but there are also people around who actually do know what they're talking about. It is up to you to distinguish between these two.

[http://forums.themanaworld.org/viewforum.php?f=8 GFX development forum]

==SFX / Music==
The SFX and music development scheme for TMW is currently not really all that active. New sounds and music are always appreciated.

[http://forums.themanaworld.org/viewforum.php?f=21 Sound development forum]

Development:Projects and Teams

2013-05-29T06:57:11Z

Jenalya:

<div style="font-size:250%" class="center">'''Projects'''</div>

<div class="center">Here is a list of the current projects under development. You can see the list of developers [[Developers|here]].</div>

{| border="1" cellspacing="0" cellpadding="5"
! style="background:#efdead;" | Project
! style="background:#efdead;" | Team
! style="background:#efdead;" | Description
! style="background:#efdead;" | Monster Reservations
! style="background:#efdead;" | Item Reservations
! style="background:#efdead;" | Map Reservations
! style="background:#efdead;" | New NPCs
! style="background:#efdead;" | Status
|-
| '''Assassin Village [[Argaes]]'''
| [[User:V0id|V0id]]
| Assassin Village (Zartam area)
|
| Assassin Set
|
|
| Scenario writing. (on hold)
|-
| '''Team PvP'''
| [[User:V0id|V0id]]
| See [https://trello.com/card/pvp-wars/4efa1aa51bd5d9220b50e779/54 Trello card]
|
| May integrate the Assassin Set if Assassin Village is abandoned. To be discussed.
|
|
| Mapping.
|-
| '''New Desert Sonbral ([[Argaes]])'''
| [[User:Yubaba|Yubaba]]
| Creating Desert maps, area further from Tulimshar and new quests.
| Snake Lord, Desert Monsters
| Snake Skin Armour, Desert bow
|
| Desert/Egyptian NPCs
| Mapping and quest writing in progress, tileset art needed
|-
|-
| '''North/Central [[Argaes]]'''
| [[User:Jenalya|Jenalya]], [[User:Jaxad0127|Jaxad0127]]
| Northern/central Argaes, including Trade City, lake Mistrala, farming/finshing village, maps to the edge of the eastern plains.
| Farmmobs
| TBA
| 057 - 067
| Farm NPCs
| Mapping in progress, tileset art needed
|-
| '''Orum and Waric Continuation'''
| [[User:Jenalya|Jenalya]], [[User:Tux|tux9th]], mrgrey
| Continuation of the Orum and Waric quest.
| Evil Woodland monsters: 1104 DemonicMouboo, 1105 ViciousSquirrel, 1106 WickedMushroom, (?)1107 Blupar
| Summon flowers ID 892 - 896, Rose hat in different colors ID 897 - 902
| 055, 056
|
| Scripting in progress
|-
| '''Barbarian Village ([[Kaizei]]).'''
| [[User:Jenalya|Jenalya]], [[User:Tux|tux9th]]
| A village of barbarians yet to be named.
| TBA
| TBA
| 049, 050, 053, 054
| Barbarian NPCs
| tilesets missing
|-
| '''Lumber Camp ([[Argaes]])'''
| [[User:o11c|o11c]]
| Southern [[Argaes]] expansion. Quests include: Help the Lumberjacks/Save the Dell (a choice); the Naturalist's Studies; ?
|
|
| 035-039
|
| on hold, graphics missing?
|-
| '''[[Thermin]] ([[Kaizei]])'''
| [[User:Jenalya|Jenalya]], [[User:Alastrim|Alastrim]]
| [[Kaizei]] area town. Once a large town that mined the firerock stones beneath the town, it was devastated by a poison gas leak. During the crisis to survive, they collaborated on several new technologies to both defend the town from the rampaging Yeti surrounding the town and to find ways to get back to using the mine, despite the poison gas problem.
|
| GasMask, Monocle
|
| Gasmask steam punk NPC, clockwork armor NPC, barbarian NPCs, [http://forums.themanaworld.org/viewtopic.php?f=8&t=12839 generic pose NPCs]
| tilesets missing
|-
| '''[[Thermin]] ([[Kaizei]]) Poisonous Mine'''
| [[User:Alastrim|Alastrim]]
| Poison gas mine. A constant moving adventure with puzzles and traps to solve and disarm along the way. Suggestions: Barriers of some type, puzzle mini-games (input code words chosen at random, arrange items, push buttons in a certain order, kill a certain monster on the map), a poison map flag, the use of event monster scripting instead of _mobs.txt spawning.
| Ice Skull, Purple Slime, Acid Goblin, Longjohn, Serqet, Fire Lizard
| Firerock,
| TBA
|
| tilesets missing
|-
| '''Crypt'''
| Skipy,[[User:Yubaba|Yubaba]]
| Reaper boss quest
| Reaper, scythe, the lost, ball lightning, vampire bat
| Death's Hand, Reaper blade
|
|
| tileset incomplete, art developer inactive.
|-
| '''Ancient Amulets'''
| [[User:Alastrim|Alastrim]]
| Five quests leading to different Four-Leaf Amulets of different strengh.
| Shadow Elemental (1st Quest)
| Four-Leaf Amulets
| 024-3 to 024-8
| Explorer
| on hold, developer inactive
|-
| '''Kageville'''
| [[User:Kage|Kage]]
| TBA
|
|
| 040
|
| on hold, developer inactive
|-
| '''Hetchel the silk weaver [376] ([[Tulimshar]])'''
| [[User:bh28|bh28]],[[User:Jenalya|Jenalya]],Chef Chelios.
| Lora Tay says she can sew Silk Robes provided you give her some silk sheets.and that Hetchel in Tulimshar can weave them for you.
|
| Silk Sheet [891], dyed Silk Sheets [2250 to 2259]
| 021-1
| Hetchel (376)
| First part completed, 021-2 or 068-1: add weaver workshop or Noble quarter. REQ: Loom
|-
| '''Tulimshar expansion'''
| wushin
|
| Caboo
|
| 068-073
|
| Mapping in progress, scenario writing
|-
| '''South to the Beach'''
| tux9th
| small map which is connected via an underground tunnel to 002-3. underground maps of 043 will be a dungeon which will be a new leveling ground for players from 1 to 99, having to fight in teams.
|
|
| 043
|
| Mapping in progress
|-
|}

<div style="font-size:250%" class="center">'''Teams'''</div>

<div class="center">Here is a list of all the different developer teams. You can see the list of developers [[Developers|here]].</div>

{| border="1" cellspacing="0" cellpadding="5"
! style="background:#efdead;" | Name
! style="background:#efdead;" | Member(s)
! style="background:#efdead;" | Role
|-
| '''The Mana World - Athena Leader'''
| [[User:Jenalya|Jenalya]]
| Coordinates tmwA. Network and delegate tasks. Increase participation.
|-
| '''Content Lead'''
| [[User:Jenalya|Jenalya]]
| Coordinates tmwA General Content (non-sound, non-art).
|-
| '''Source Lead'''
| [[User:o11c|o11c]]
| Adjusts and coordinates Athena source code. Meets content team requests for source code adjustments to further content. Research and development of Athena source code and scripting conventions.
|-
| '''Sound Lead'''
| [[User:Yubaba|Yubaba]]
| Determines if sound on the forums is ready for the game. Encourages people to get involved in sound and encourage players to try their hand at sound. Attempts to meet the [REQ]s of content developers as well as creates any sound that may seem to add to the project, from monsters to maps to battle and beyond.
|-
| '''Pixel Artists'''
| Nami, [[User:Salmondine|Salmondine]]
| Determines if art is ready for the game. Helps categorize art topics. Encourage artists contribute to the game and encourage players to try their hand at art. Understand content priorities and attempt to steer art to meeting art deadlines.
|-
| '''Mapping Lead'''
|
| Reviews maps for the game. Check for proper use of black border, collision tiles, and application of tiles onto the correct layers they belong on. Fix mapping errors.
|-
|}

Development:Projects and Teams

2013-05-27T17:24:01Z

Jenalya:

<div style="font-size:250%" class="center">'''Projects'''</div>

<div class="center">Here is a list of the current projects under development. You can see the list of developers [[Developers|here]].</div>

{| border="1" cellspacing="0" cellpadding="5"
! style="background:#efdead;" | Project
! style="background:#efdead;" | Team
! style="background:#efdead;" | Description
! style="background:#efdead;" | Monster Reservations
! style="background:#efdead;" | Item Reservations
! style="background:#efdead;" | Map Reservations
! style="background:#efdead;" | New NPCs
! style="background:#efdead;" | Status
|-
| '''Assassin Village [[Argaes]]'''
| [[User:V0id|V0id]]
| Assassin Village (Zartam area)
|
| Assassin Set
|
|
| Scenario writing. (on hold)
|-
| '''Team PvP'''
| [[User:V0id|V0id]]
| See [https://trello.com/card/pvp-wars/4efa1aa51bd5d9220b50e779/54 Trello card]
|
| May integrate the Assassin Set if Assassin Village is abandoned. To be discussed.
|
|
| Mapping.
|-
| '''New Desert Sonbral ([[Argaes]])'''
| [[User:Yubaba|Yubaba]]
| Creating Desert maps, area further from Tulimshar and new quests.
| Snake Lord, Desert Monsters
| Snake Skin Armour, Desert bow
|
| Desert/Egyptian NPCs
| Mapping and quest writing in progress, tileset art needed
|-
|-
| '''North/Central [[Argaes]]'''
| [[User:Jenalya|Jenalya]], [[User:Jaxad0127|Jaxad0127]]
| Northern/central Argaes, including Trade City, lake Mistrala, farming/finshing village, maps to the edge of the eastern plains.
| Farmmobs
| TBA
| 057 - 067
| Farm NPCs
| Mapping in progress, tileset art needed
|-
| '''Orum and Waric Continuation'''
| [[User:Jenalya|Jenalya]], [[User:Tux|tux9th]], mrgrey
| Continuation of the Orum and Waric quest.
| Evil Woodland monsters: 1104 DemonicMouboo, 1105 ViciousSquirrel, 1106 WickedMushroom, (?)1107 Blupar
| Rose hat, magical flowers ID 892 - 897, different colors of the rose hat to be decided
| 055, 056
|
| Scripting in progress
|-
| '''Barbarian Village ([[Kaizei]]).'''
| [[User:Jenalya|Jenalya]], [[User:Tux|tux9th]]
| A village of barbarians yet to be named.
| TBA
| TBA
| 049, 050, 053, 054
| Barbarian NPCs
| tilesets missing
|-
| '''Lumber Camp ([[Argaes]])'''
| [[User:o11c|o11c]]
| Southern [[Argaes]] expansion. Quests include: Help the Lumberjacks/Save the Dell (a choice); the Naturalist's Studies; ?
|
|
| 035-039
|
| on hold, graphics missing?
|-
| '''[[Thermin]] ([[Kaizei]])'''
| [[User:Jenalya|Jenalya]], [[User:Alastrim|Alastrim]]
| [[Kaizei]] area town. Once a large town that mined the firerock stones beneath the town, it was devastated by a poison gas leak. During the crisis to survive, they collaborated on several new technologies to both defend the town from the rampaging Yeti surrounding the town and to find ways to get back to using the mine, despite the poison gas problem.
|
| GasMask, Monocle
|
| Gasmask steam punk NPC, clockwork armor NPC, barbarian NPCs, [http://forums.themanaworld.org/viewtopic.php?f=8&t=12839 generic pose NPCs]
| tilesets missing
|-
| '''[[Thermin]] ([[Kaizei]]) Poisonous Mine'''
| [[User:Alastrim|Alastrim]]
| Poison gas mine. A constant moving adventure with puzzles and traps to solve and disarm along the way. Suggestions: Barriers of some type, puzzle mini-games (input code words chosen at random, arrange items, push buttons in a certain order, kill a certain monster on the map), a poison map flag, the use of event monster scripting instead of _mobs.txt spawning.
| Ice Skull, Purple Slime, Acid Goblin, Longjohn, Serqet, Fire Lizard
| Firerock,
| TBA
|
| tilesets missing
|-
| '''Crypt'''
| Skipy,[[User:Yubaba|Yubaba]]
| Reaper boss quest
| Reaper, scythe, the lost, ball lightning, vampire bat
| Death's Hand, Reaper blade
|
|
| tileset incomplete, art developer inactive.
|-
| '''Ancient Amulets'''
| [[User:Alastrim|Alastrim]]
| Five quests leading to different Four-Leaf Amulets of different strengh.
| Shadow Elemental (1st Quest)
| Four-Leaf Amulets
| 024-3 to 024-8
| Explorer
| on hold, developer inactive
|-
| '''Kageville'''
| [[User:Kage|Kage]]
| TBA
|
|
| 040
|
| on hold, developer inactive
|-
| '''Hetchel the silk weaver [376] ([[Tulimshar]])'''
| [[User:bh28|bh28]],[[User:Jenalya|Jenalya]],Chef Chelios.
| Lora Tay says she can sew Silk Robes provided you give her some silk sheets.and that Hetchel in Tulimshar can weave them for you.
|
| Silk Sheet [891], dyed Silk Sheets [2250 to 2259]
| 021-1
| Hetchel (376)
| First part completed, 021-2 or 068-1: add weaver workshop or Noble quarter. REQ: Loom
|-
| '''Tulimshar expansion'''
| wushin
|
| Caboo
|
| 068-073
|
| Mapping in progress, scenario writing
|-
| '''South to the Beach'''
| tux9th
| small map which is connected via an underground tunnel to 002-3. underground maps of 043 will be a dungeon which will be a new leveling ground for players from 1 to 99, having to fight in teams.
|
|
| 043
|
| Mapping in progress
|-
|}

<div style="font-size:250%" class="center">'''Teams'''</div>

<div class="center">Here is a list of all the different developer teams. You can see the list of developers [[Developers|here]].</div>

{| border="1" cellspacing="0" cellpadding="5"
! style="background:#efdead;" | Name
! style="background:#efdead;" | Member(s)
! style="background:#efdead;" | Role
|-
| '''The Mana World - Athena Leader'''
| [[User:Jenalya|Jenalya]]
| Coordinates tmwA. Network and delegate tasks. Increase participation.
|-
| '''Content Lead'''
| [[User:Jenalya|Jenalya]]
| Coordinates tmwA General Content (non-sound, non-art).
|-
| '''Source Lead'''
| [[User:o11c|o11c]]
| Adjusts and coordinates Athena source code. Meets content team requests for source code adjustments to further content. Research and development of Athena source code and scripting conventions.
|-
| '''Sound Lead'''
| [[User:Yubaba|Yubaba]]
| Determines if sound on the forums is ready for the game. Encourages people to get involved in sound and encourage players to try their hand at sound. Attempts to meet the [REQ]s of content developers as well as creates any sound that may seem to add to the project, from monsters to maps to battle and beyond.
|-
| '''Pixel Artists'''
| Nami, [[User:Salmondine|Salmondine]]
| Determines if art is ready for the game. Helps categorize art topics. Encourage artists contribute to the game and encourage players to try their hand at art. Understand content priorities and attempt to steer art to meeting art deadlines.
|-
| '''Mapping Lead'''
|
| Reviews maps for the game. Check for proper use of black border, collision tiles, and application of tiles onto the correct layers they belong on. Fix mapping errors.
|-
|}

Development:Projects and Teams

2013-05-10T19:06:29Z

Jenalya: Reserve monster ids for orum and waric follow-up quest.

<div style="font-size:250%" class="center">'''Projects'''</div>

<div class="center">Here is a list of the current projects under development. You can see the list of developers [[Developers|here]].</div>

{| border="1" cellspacing="0" cellpadding="5"
! style="background:#efdead;" | Project
! style="background:#efdead;" | Team
! style="background:#efdead;" | Description
! style="background:#efdead;" | Monster Reservations
! style="background:#efdead;" | Item Reservations
! style="background:#efdead;" | Map Reservations
! style="background:#efdead;" | New NPCs
! style="background:#efdead;" | Status
|-
| '''Trade City [[Argaes]]'''
| [[User:V0id|V0id]]
| Assassin Guild quest (Miriam follow-up) in Trade City
|
| Assassin Set
|
|
| Scenario writing.
|-
| '''New Desert Sonbral ([[Argaes]])'''
| [[User:Yubaba|Yubaba]]
| Creating Desert maps, area further from Tulimshar and new quests.
| Snake Lord, Desert Monsters
| Snake Skin Armour, Desert bow
|
| Desert/Egyptian NPCs
| Mapping and quest writing in progress, tileset art needed
|-
|-
| '''East [[Argaes]]'''
| [[User:Jenalya|Jenalya]], [[User:Tux|tux9th]]
| Extension to the east, including farmlands, port-city, waterfall area
| Farmmobs
| TBA
| 057 - 067
| Farm NPCs
| Mapping in progress, tileset art needed
|-
| '''Orum and Waric Continuation'''
| [[User:Jenalya|Jenalya]], [[User:Tux|tux9th]], mrgrey
| Continuation of the Orum and Waric quest.
| Evil Woodland monsters: 1104 DemonicMouboo, 1105 ViciousSquirrel, 1106 WickedMushroom, (?)1107 Blupar
| Rose hat, magical flowers
| 055, 056
|
| Scripting in progress
|-
| '''Barbarian Village ([[Kaizei]]).'''
| [[User:Jenalya|Jenalya]], [[User:Tux|tux9th]]
| A village of barbarians yet to be named.
| TBA
| TBA
| 049, 050, 053, 054
| Barbarian NPCs
| tilesets missing
|-
| '''Lumber Camp ([[Argaes]])'''
| [[User:o11c|o11c]]
| Southern [[Argaes]] expansion. Quests include: Help the Lumberjacks/Save the Dell (a choice); the Naturalist's Studies; ?
|
|
| 035-039
|
| on hold, graphics missing?
|-
| '''[[Thermin]] ([[Kaizei]])'''
| [[User:Jenalya|Jenalya]], [[User:Alastrim|Alastrim]]
| [[Kaizei]] area town. Once a large town that mined the firerock stones beneath the town, it was devastated by a poison gas leak. During the crisis to survive, they collaborated on several new technologies to both defend the town from the rampaging Yeti surrounding the town and to find ways to get back to using the mine, despite the poison gas problem.
|
| GasMask, Monocle
|
| Gasmask steam punk NPC, clockwork armor NPC, barbarian NPCs, [http://forums.themanaworld.org/viewtopic.php?f=8&t=12839 generic pose NPCs]
| tilesets missing
|-
| '''[[Thermin]] ([[Kaizei]]) Poisonous Mine'''
| [[User:Alastrim|Alastrim]]
| Poison gas mine. A constant moving adventure with puzzles and traps to solve and disarm along the way. Suggestions: Barriers of some type, puzzle mini-games (input code words chosen at random, arrange items, push buttons in a certain order, kill a certain monster on the map), a poison map flag, the use of event monster scripting instead of _mobs.txt spawning.
| Ice Skull, Purple Slime, Acid Goblin, Longjohn, Serqet, Fire Lizard
| Firerock,
| TBA
|
| tilesets missing
|-
| '''Crypt'''
| Skipy,[[User:Yubaba|Yubaba]]
| Reaper boss quest
| Reaper, scythe, the lost, ball lightning, vampire bat
| Death's Hand, Reaper blade
|
|
| tileset incomplete, art developer inactive.
|-
| '''Ancient Amulets'''
| [[User:Alastrim|Alastrim]]
| Five quests leading to different Four-Leaf Amulets of different strengh.
| Shadow Elemental (1st Quest)
| Four-Leaf Amulets
| 024-3 to 024-8
| Explorer
| on hold, developer inactive
|-
| '''Kageville'''
| [[User:Kage|Kage]]
| TBA
|
|
| 040
|
| on hold, developer inactive
|-
| '''Hetchel the silk weaver [376] ([[Tulimshar]])'''
| [[User:bh28|bh28]],[[User:Jenalya|Jenalya]],Chef Chelios.
| Lora Tay says she can sew Silk Robes provided you give her some silk sheets.and that Hetchel in Tulimshar can weave them for you.
|
| Silk Sheet [891], dyed Silk Sheets [2250 to 2259]
| 021-1
| Hetchel (376)
| First part completed, 021-2 or 068-1: add weaver workshop or Noble quarter. REQ: Loom
|-
| '''Tulimshar expansion'''
| wushin
|
| Caboo
|
| 068-073
|
| Mapping in progress, scenario writing
|-
| '''South to the Beach'''
| tux9th
| small map which is connected via an underground tunnel to 002-3. underground maps of 043 will be a dungeon which will be a new leveling ground for players from 1 to 99, having to fight in teams.
|
|
| 043
|
| Mapping in progress
|-
|}

<div style="font-size:250%" class="center">'''Teams'''</div>

<div class="center">Here is a list of all the different developer teams. You can see the list of developers [[Developers|here]].</div>

{| border="1" cellspacing="0" cellpadding="5"
! style="background:#efdead;" | Name
! style="background:#efdead;" | Member(s)
! style="background:#efdead;" | Role
|-
| '''The Mana World - Athena Leader'''
| [[User:Jenalya|Jenalya]]
| Coordinates tmwA. Network and delegate tasks. Increase participation.
|-
| '''Content Lead'''
| [[User:Jenalya|Jenalya]]
| Coordinates tmwA General Content (non-sound, non-art).
|-
| '''Source Lead'''
| [[User:o11c|o11c]]
| Adjusts and coordinates Athena source code. Meets content team requests for source code adjustments to further content. Research and development of Athena source code and scripting conventions.
|-
| '''Sound Lead'''
| [[User:Yubaba|Yubaba]]
| Determines if sound on the forums is ready for the game. Encourages people to get involved in sound and encourage players to try their hand at sound. Attempts to meet the [REQ]s of content developers as well as creates any sound that may seem to add to the project, from monsters to maps to battle and beyond.
|-
| '''Pixel Artists'''
| Nami, [[User:Salmondine|Salmondine]]
| Determines if art is ready for the game. Helps categorize art topics. Encourage artists contribute to the game and encourage players to try their hand at art. Understand content priorities and attempt to steer art to meeting art deadlines.
|-
| '''Mapping Lead'''
|
| Reviews maps for the game. Check for proper use of black border, collision tiles, and application of tiles onto the correct layers they belong on. Fix mapping errors.
|-
|}

Classic:TmwAthena Scripting Standards

2013-04-17T17:41:44Z

Jenalya: /* Labels and Subfunctions */ Add a note about L_Close

This is an attempt to standardize the eAthena coding. Any suggestions are welcome to be posted on the discussion page before editing.
=Code Formatting=
== Indentation ==
* Code is indented with four spaces.
* Code in the same block should have the same indentation.
* Labels have no indentation.
* Menu options are on their own lines and are indented further.
Example:
menu
"Yes.", L_Yes,
"No.", L_No;
* When using an if-statement, there should be a line break after the condition and the conditional command should be indented further. An exception to this is a series of if-statements at the beginning of a major code block which use gotos to jump to the correct position in the script. In this case the goto should be in the same line as the if-statement.
Example:
// if-statement and conditional command in the same line, gotos aligned
if (@quest >= 3) goto L_Done;
if (@quest == 2) goto L_Progress;
if (@quest == 1) goto L_Question;

// conditional command in the next line and indented further
if (BaseLevel < 40)
set @cost, 100;

== Whitespaces==
In many places whitespaces can increase readability. Examples are
* When concatenating text and variables:
mes "\"Hello " + strcharinfo(0) + "!\"";
instead of
mes "\"Hello "+strcharinfo(0)+"!\"";
* When assigning values to variables:
set @var, 3;
instead of
set @var,3;
* In menus:
menu
"Yes.", L_Yes,
"No.", L_No;
instead of
menu
"Yes.",L_Yes,
"No.",L_No;

== Code Blocks ==
* Code blocks should be separated from the others in a dinstinct way: insert a blank line between code blocks.
* Individual blocks should be together No blank lines within a block.
* The opening brackets should be at the end of the parent line, not in a new line; the closing ones should be in a line of their own.
* A 'menu' must not be in the body of an if statement. Instead, goto a new block for the menu, or negate the logic and goto somewhere else if the label should not be shown.
* The 'next' command goes at the end of a block (before a goto or fallthrough), never at the beginning. Make sure 'next' is never followed by something that leads to a 'close' without intervening text.

==Labels and Subfunctions==
* Labels should be named in this way: L_CamelCase
* Subfunctions should be named in this way: S_CamelCase
* Labels should always start with L_, except those that act as a subfunction, which should start with S_
* Newline before every label
* No newline after a label
* There must not be a fallthrough or goto to a subfunction label.
* A subfunction label must not goto a normal label. It may, however, goto another label that is specific to that subfunction, and eventually reach a return.

* Many scripts use a label L_Close, which is used to reset temporary player variables to 0, and then ends the scripts with the close; command. If you use a label with that purpose, it should be named L_Close for consistency. (There are older scripts which use different names, e.g. L_end, but new ones should go with L_Close.)

==Comments==
At the beginning of a script file there should be documented
* who is the author
* the purpose of the script
* which variables are used and what's their purpose
* any additional information that can help to understand the script
Example:
// Author: devxy
// This file contains the NPC John, who is part of the Example quest.
// Quest states are saved in Quest_Example.
// State 1: started the quest
// State 2: did the next step
[...]

Within the script there should be comments if there are parts which might be difficult to understand.

In some of the older scripts there are boxed comments used like this:
//#################################################################################
//# NPC John - By Smith #
//# #
//# ... #
//#################################################################################
Don't use them in new scripts.

== NPC Dialogs ==
In the following example our NPC dialog formatting guidelines are explained.
mes "[Example NPC Olaf]";
mes "\"When I start speaking my name is put in square brackets, and my spoken text here is in quotation marks.\"";
next;
mes "\"The next between my previous line and this one interrupted my speaking, so I started with new quotation marks.";
mes "But didn't close them in the same line, because I continue to speak here.";
mes "A new message command can be used to have a line break in the dialog without interrupting the speaking.";
mes "At the end I close the quotation marks again.\"";
next;
mes "Olaf stops speaking and scratches his head. This is a descriptive text, so it isn't put into quotation marks.";
next;
mes "[Example NPC Olaf]";
mes "\"Now that I start speaking again, I need my name in brackets again before my actual text starts, because something else happened in between.";
mes "It isn't that difficult, right?\"";
menu
"I agree.", -,
"(Leave.)", L_Close;
mes "[Example NPC Olaf]";
mes "\"It's the same after there was a menu with the player saying or doing something, again I put my name into sqaure brackets before starting to speak.\"";
next;
mes "\"In the menu you can see that something the player says isn't put into quotation marks, but just as plain text.";
mes "And an action the player takes is put into usual brackets.\"";
goto L_Close;

L_Close:
close;

=Variables=
==Document Variables==
in every file, document every variable as one of:

* # account variable (prefix #) (note that there are also ## variable which didn't work in the stable version of the server)
* permanent player variable (no prefix)
* @ temporary player variable (prefix @) - used after the script close;s or end;s.
* @ dynamic player variable (prefix @) - passed into or out of callsub or callfunc
* @ lexical (local) player variable (prefix @) - used only within the function (scripthelp.txt documents that ".@" means this but I don't know if that works)
* @ local constant (prefix @) - not dependent on the player, used only within the function. e.g. lots of @QUEST_FOO_{SHIFT,MASK}
* $ global permanent variable (prefix $) (I'm not sure if we have any of these right now)
* $ npc permanent variable (prefix $) same as above but only used by one NPC
* $ global temporary variable (prefix $@)
* $@ npc temporary variable (prefix $@) same as above but only used by one NPC, scripthelp.txt mentions prefix "." but I don't know if that works
* special variable (in db/const.txt with a 1 following)
* global constant (in const.txt)

'''If we use a consistent method of documenting these, we can then generate a list of all variables by type.'''

==Variables initialization==
Check for troublesome arrays:
A troublesome array is defined as an array that is not
*initialized all at once
*initialized by appending elements to the end, for use in a menu
Nothing needs to be done, merely document them. I want this information at hand when I design the new scripting language to minimize conversion pains.
I wouldn't be surprised if there were no troublesome arrays at all. If there are only a couple it might be worth refactoring the code to remove them, but that might be a high-level decision which is beyond the scope of this proposal.

Set dynamic and local @variables to 0 before close;
==Naming Variables==

==Using as little variables as you need==
So there are some quests, which require lots of variables.
Think of monster oil quest, Oric and Warum quest etc.

This can often be done by bitmasking:
One variable has 32 bits. So a variabe can store 2^32 different numbers: 4294967296

But sometimes you only need numbers from 0 to 15, but more of these variables.
but numbers in range 0 to 15 can be stored in 4 bits ( 2^4 = 16 different numbers)

Here is an example how to use bitmasking:
[[Media:Tester.txt]]
== Defining Map Objects ==

These sections describe how to define map objects.

=== Warp Definitions ===
'''Shouldn't be done manually.'''
Warps are what move players between maps. They can also be used to move players around a single map, if needed. Warps are defined like this:

map1,startX,startY|warp|name|width,height,map2,endX,endY

Key:
{|
|map1 ||the starting map
|-
|startX||the x-coordinate of the starting warp tile
|-
|startY||the y-coordinate of the starting warp tile
|-
|name ||the name of the warp, unused but must be defined
|-
|width ||the width of the warp
|-
|height||the height of the warp
|-
|map2 ||the ending map
|-
|endX ||the x-coordinate of the tile the player will end up on
|-
|endY ||the y-coordinate of the tile the player will end up on
|}

Width and height are described in detail here: [[EAthena Scripting Standards/Warp Details|Warp Details]].

=== Monster Definitions ===
'''Shouldn't be done manually.'''
Monsters are defined like this:

<map name>,<x>,<y>,<width>,<height>|monster|<name>|<mobID>,<count>,<spawn1>,<spawn2>,{<eventcode>}

{|
|map name ||the map the monsters should appear on
|-
|x ||the x-coordinate of the spawn tile
|-
|y ||the y-coordinate of the spawn tile
|-
|width ||the tile width of the spawn area
|-
|height ||the tile height of the spawn area
|-
|name ||the name of the mob, unused but must be defined. '''DO NOT''' use the keywords such as "spawn" in this name to avoid conflict with other game systems (magic for example)
|-
|mobID ||the mob identifier of the desired monster (in the monster db)the number to spawn
|-
|count ||the number to spawn
|-
|spawn1 ||the minimum delay between successive spawns (per individual)
|-
|spawn2 ||the minimum delay between death and respawn (per individual)
|-
|eventcode ||the script event to fire upon death
|}
A detailed description of position and area can be found here: [[EAthena Scripting Standards/Mob Details|Mob Details]].

=== NPC Definitions ===
<map name>,<x>,<y>,<facing>|script|<Name>|<spriteID>,<nowiki>{<code>}</nowiki>
<map name>,<x>,<y>,<facing>|script|<Name>|<spriteID>,<triggerX>,<triggerY>,<nowiki>{<code>}</nowiki>

{|
|map name ||the map the monsters should appear on
|-
|x ||the x-coordinate of the spawn tile
|-
|y ||the y-coordinate of the spawn tile
|-
|facing ||Direction the NPC faces to. '''It must be set to 0''' in TMW
|-
|height ||the tile height of the spawn area
|-
|Name ||the name of the NPC
|-
|spriteID ||the mob identifier of the desired NPC. Sprite ID
|-
|triggerX ||
|-
|triggerY ||
|-
|eventcode ||the script event to fire upon death
|}
* Server side :
::NPC definitions (script) are usually stored as : (tmwa-server-data/)world/map/npc/<map name>/<NPC Name>.txt or in the file : (tmwa-server-data/)world/map/npc/<map name>/npc.txt
* Client side :
::The NPC is associated with a sprite (the image that will appear in the game), and a XML file which tells the client some display parameters. (tmwa-client-data/)graphics/sprites/npcs/npc-<Name>.png (tmwa-client-data/)graphics/sprites/npcs/npc-<Name>.xml The NPC spriteID is linked to graphic files and XML in the file : (tmwa-client-data/)npcs.xml



== Script Functions ==
function|script|<function name>|<nowiki>{<code>}</nowiki>
Actual script functions are stored or imported in the files : (tmwa-server-data/)world/map/npc/functions/<function name>.txt, regardless rhey are called from a Map, NPC, Mob or item.

==Script Loading==
The main script import file is:[https://github.com/themanaworld/tmwa-server-data/blob/master/world/map/npc/scripts.conf (tmwa-server-data/)world/map/npc/scripts.conf] 
It loads [https://github.com/themanaworld/tmwa-server-data/blob/master/world/map/npc/_import.txt (tmwa-server-data/)world/map/npc/_import.txt] which imports all NPC scripts wich are stored under the respective map name folders, usually under NPC name.

=Examples=
== Open a chest and get reward ==
An example is given by a quest to get a key for a chest (in fact 3 keys):

{| style="width:850px;" border=0 cellspacing="10"
|-valign="Top"
|<pre>
// A treasure chest. You need three keys to open it.
//
// TMW_Quest (document variable here)
//

002-4.gat,93,37,0|script|Treasure|111,{

if (TMW_Quest >= 38) goto L_Finished;

mes "There is a chest here.";
mes "Do you want to try to open it?";
next;
menu
"Yes.", L_Yes,
"No.", -;
close;

L_Yes:
if(countitem("TreasureKey") < 3)
goto L_Not_Enough;
getinventorylist;
if (@inventorylist_count == 100 && countitem("TreasureKey") > 3)
goto L_TooMany;
mes "You opened the chest and found a short bow!";
delitem "TreasureKey", 3;
getitem "ShortBow", 1;
set TMW_Quest, 38;
close;

L_Not_Enough:
mes "It seems that you do not have the right key for this chest yet...";
close;

L_Finished:
mes "You have already opened this chest.";
close;

L_TooMany:
mes "You do not have enough room to loot this chest. Maybe you should try again later.";
close;
}
</pre>
|}
This script starts with describing the NPC (the chest, NPC sprite 111) and its location (map 002-4 X=93, Y=37, in tiles from top left of the map). Then follows what happens on activation:
First, the variable ''"TMW_Quest"'' is checked to know if the player already accomplished the quest '''(the variable should be documented)''', If he has the script continues at label ''L_Finished'', the player is reminded fe alredy accomplished the task and script finishes, if not the scrip continues. A message is shown (mes), then an option dialog (menu) is displayed with two possible answers : "Yes." or "No.". If the player answers "No." the script stops (close;); if he answers "Yes." the script continues at label ''L_Yes''. Now player is checked to know if he has at least 3 keys, if not script branches to label ''L_Not_Enough'' tells the player he "has not the right key" and script closes. If he has keys enough, his inventory list is retrieved by the built-in function "getinventorylist" and it's content is checked to know if the player will have room enough to store the reward after the 3 keys use. If not, script goes to label ''L_TooMany'' and script close after a warning message, If yes 3 keys are deleted in player's inventory, he gets the reward: a Short Bow and the variable TMW_Quest is set to 38.

For more examples of the current system, check out the current scripts in use by the server. Beware though, this could affect your enjoyment of the game as it does spoil some of the mystery. Here's a link to git so you can view them in your browser:

https://github.com/themanaworld/tmwa-server-data/tree/master/world/map/npc

Note that anything said by an NPC should be put in double quotes ("). You can do that like this: "'''\"'''Hello!'''\"''' she said."
=References=
* [[EAthena Scripting Basics]]
* [[EAthena Scripting Reference]]
* [http://forums.themanaworld.org/viewtopic.php?f=13&t=13653 script cleanup/scripting standards proposal]

Classic:TmwAthena Scripting Reference

2013-04-12T19:55:59Z

Jenalya: /* delitem */ Add note about problem with not stackable items.

This page is a reference for commands believed to work in the eAthena scripting language still used by tmwAthena.

A number of problematic commands have been removed from this list, but not all commands have been tested.

== Language Commands ==
These are command that are closely tied to the language itself.

=== goto ===
<pre>
goto L_1;
</pre>
Unconditionally jump to a label. Often used in an "if" body.

=== callsub ===
<pre>
callsub S_labelname, arguments...;
</pre>
Jump to the given label. When the "return" statement is executed, continue on the next line.

It is not known whether "arguments..." works, we use temporary variables instead.

It might also be possible to use this as a function, if the form of return with a value is used, but we use temporary variables instead.

=== callfunc ===
<pre>
callfunc "function_name", arguments...;
</pre>
Jump to the given function script. When the "return" statement is executed, continue on the next line of this script.

It is not known whether "arguments..." works, we use temporary variables instead.

It might also be possible to use this as a function, if the form of return with a value is used, but we use temporary variables instead.

"return" is broken if this is used from within an if(). If you need a conditional callfunc, first goto a label.

=== return ===
<pre>
return;
return expr;
</pre>
Return from this script or sublabel to the calling function.

It is unknown what happens if this is used from the top-level script, use "close" or "end" instead.

We use temporary variables instead of the form that returns an expression.

=== getarg ===
<pre>
getarg(index)
</pre>
Return (by reference?) an argument of "callsub" or "callfunc". Aborts the script if used at toplevel of if out of range.

We use temporary variables instead.

=== set ===
<pre>
set variable, expression;
</pre>
Very common command, to set variables.

=== setarray ===
<pre>
setarray arrayvariable, val1, val2, ...;
</pre>
Set elements of an array. Previous elements are not cleared. At most 128 elements can be assigned.

It is currently possible, but deprecated, to specify a (zero-based) array index to start at the given part of an array. It's pretty amazing that that code works anyway.

Remember that there are no permanent arrays, only temporary.

=== cleararray ===
<pre>
cleararray variable, value, count;
</pre>
Fill an array with "count" copies of "value".

=== copyarray ===
<pre>
copyarray dest_var, src_var, count;
</pre>
Copy elements of an array.

This function looks broken to me.

=== getarraysize ===
<pre>
getarraysize variable;
</pre>
Get the size of an array.

The size of an array is simply one more than the index of the last nonzero integer or nonempty string.

WARNING: most functions that set an array do not bother to clear out high indices. You should almost always use an explicitly-provided size instead.

=== deletearray ===
<pre>
deletearray variable[, count = 1];
</pre>
Remove count elements from an array.

If there are elements beyond count, they will be shifted into lower indices.

After that, all remaining elements will be set to 0 or "".

This function is currently broken, instead use cleararray variable, 0, count;

=== getelementofarray ===
<pre>
getelementofarray(arrayname, index_expr)
</pre>
This function is invoked internally by the arrayname[index_expr] syntax.

=== if ===
<pre>
if (condition) condition_command [conditional_command_args, ...];
</pre>
If condition is zero, do nothing. Else, evaluate the conditional command.

The only thing special about the if command is the lack of commas during parsing (from my reading this is only a warning?). During execution it is perfectly normal.

=== end ===
<pre>
end;
</pre>
Stop executing the script.

Don't use this if you have opened a dialog to the player, use "close" instead. Or, use "close2" and *then* "end".

=== debugmes ===
<pre>
debugmes "string"
</pre>
Print a message to stdout.

== Message Commands ==
These are commands for dialog or one-way chat with players.

=== mes ===
<pre>
mes "string";
</pre>
Display a line of text to the player. If a dialog box is not already open for the attached NPC, one will be created.

It is unknown if the client properly supports dialog with multiple NPCs simultaneously. Note that the server only allows each account one paused script at a time, so it probably wouldn't work anyway.

If you need to include the '''"''' character inside the message, (especially for dialogs) insert it as '''\"'''.
When doing several messages without a next; in between, there should be only a single \" at the beginning and the end each.

'''Example 1''':
mes "\"I start talking here, and don't close the quotation marks, because I'm not yet done talking.";
mes "And start a new line, but without new quotation marks.";
mes "Here I stop talking, so I close the quotation marks.\"";
gives:

"I start talking here, and don't close the quotation marks, because I'm not yet done talking. 
And start a new line, but without new quotation marks. 
Here I stop talking, so I close the quotation marks."

'''Example 2''': Hamlet (Act 3, scene 1)
<pre>
mes "[King Claudius]"
mes "\"Aside O, 'tis too true!"
mes "How smart a lash that speech doth give my conscience!"
mes "The harlot's cheek, beautied with plastering art,"
mes "Is not more ugly to the thing that helps it"
mes "Than is my deed to my most painted word:"
mes "O heavy burthen!\""
mes ""
mes "[Lord Polonius]"
mes "\"I hear him coming: let's withdraw, my lord.\""
mes ""
mes "Exeunt KING CLAUDIUS and POLONIUS Enter HAMLET"
mes ""
mes "[Hamlet]"
mes "\"To be, or not to be: that is the question:"
mes "Whether 'tis nobler in the mind to suffer"
mes "The slings and arrows of outrageous fortune,"
mes "Or to take arms against a sea of troubles,"
mes "And by opposing end them? To die: to sleep;"
mes "No more; and by a sleep to say we end"
mes "The heart-ache and the thousand natural shocks"
mes "That flesh is heir to, 'tis a consummation"
mes "Devoutly to be wish'd. To die, to sleep;"
mes "To sleep: perchance to dream: ay, there's the rub;"
mes "For in that sleep of death what dreams may come"
mes "When we have shuffled off this mortal coil,"
mes "Must give us pause: there's the respect"
mes "That makes calamity of so long life;"
mes "For who would bear the whips and scorns of time,"
mes "The oppressor's wrong, the proud man's contumely,"
mes "The pangs of despised love, the law's delay,"
mes "The insolence of office and the spurns"
mes "That patient merit of the unworthy takes,"
mes "When he himself might his quietus make"
mes "With a bare bodkin? who would these fardels bear,"
mes "To grunt and sweat under a weary life,"
mes "But that the dread of something after death,"
mes "The undiscover'd country from whose bourn"
mes "No traveller returns, puzzles the will"
mes "And makes us rather bear those ills we have"
mes "Than fly to others that we know not of?"
mes "Thus conscience does make cowards of us all;"
mes "And thus the native hue of resolution"
mes "Is sicklied o'er with the pale cast of thought,"
mes "And enterprises of great pitch and moment"
mes "With this regard their currents turn awry,"
mes "And lose the name of action.--Soft you now!"
mes "The fair Ophelia! Nymph, in thy orisons"
mes "Be all my sins remember'd.\""
mes ""
mes "[Ophelia]"
mes "\"Good my lord,"
mes "How does your honour for this many a day?\""
mes ""
mes "[Hamlet]"
mes "\"I humbly thank you; well, well, well.\""
</pre>
Will give:

[King Claudius] 
"Aside O, 'tis too true!" 
How smart a lash that speech doth give my conscience! 
The harlot's cheek, beautied with plastering art, 
Is not more ugly to the thing that helps it 
Than is my deed to my most painted word: 
O heavy burthen!"

[Lord Polonius] 
"I hear him coming: let's withdraw, my lord."

Exeunt KING CLAUDIUS and POLONIUS Enter HAMLET

[Hamlet] 
"To be, or not to be: that is the question: 
Whether 'tis nobler in the mind to suffer 
The slings and arrows of outrageous fortune, 
Or to take arms against a sea of troubles, 
And by opposing end them? To die: to sleep; 
No more; and by a sleep to say we end 
The heart-ache and the thousand natural shocks 
That flesh is heir to, 'tis a consummation 
Devoutly to be wish'd. To die, to sleep; 
To sleep: perchance to dream: ay, there's the rub; 
For in that sleep of death what dreams may come 
When we have shuffled off this mortal coil, 
Must give us pause: there's the respect 
That makes calamity of so long life; 
For who would bear the whips and scorns of time, 
The oppressor's wrong, the proud man's contumely, 
The pangs of despised love, the law's delay, 
The insolence of office and the spurns 
That patient merit of the unworthy takes, 
When he himself might his quietus make 
With a bare bodkin? who would these fardels bear, 
To grunt and sweat under a weary life, 
But that the dread of something after death, 
The undiscover'd country from whose bourn 
No traveller returns, puzzles the will 
And makes us rather bear those ills we have 
Than fly to others that we know not of? 
Thus conscience does make cowards of us all; 
And thus the native hue of resolution 
Is sicklied o'er with the pale cast of thought, 
And enterprises of great pitch and moment 
With this regard their currents turn awry, 
And lose the name of action.--Soft you now! 
The fair Ophelia! Nymph, in thy orisons 
Be all my sins remember'd."

[Ophelia] 
"Good my lord, 
How does your honour for this many a day?"

[Hamlet] 
"I humbly thank you; well, well, well."

=== next ===
<pre>
next;
</pre>
Stop the script until the user presses "Next" in the dialog.

=== close ===
<pre>
close;
</pre>
Stop executing the script and give the user a "Close" button in the dialog.

=== close2 ===
<pre>
close2;
</pre>
Stop the script until the user presses the "Close" button in the dialog, then keep executing the script.

WARNING: unlike close, this command is a blocking command, the usual caveats apply.

=== menu ===
<pre>
menu
"option 1", L_1,
"option 2", L_2,
"default", -;
</pre>
Display a list of choices to the player, then branch to the specified label. The special label "-" means don't branch, just continue with the next statement.

Additionally, the temporary variable "@menu" is set to the 1-based index of the choice.

The options must not contain the character ":", as the protocol uses it as a separator.

=== input ===
<pre>
input variable_name;
</pre>
Input an integer or string to the given variable, depending on whether has the '$' string postfix.

The implementation allows variable_name to be omitted if input is an integer, in case l14 is used. Don't use this.

=== announce ===
<pre>
announce "message", flag;
</pre>
Do a GM message.

If flag & 0xF == 0 forward it to all map servers.
If flag & 0x8, message is from the OID (NPC? usually?) rather than the RID (player).

If (flag & 0x7) == 1, send to all on map.
If (flag & 0x7) == 2, send to all in line of sight.
If (flag & 0x7) == 3, send to self only.
If (flag & 0x7) == anything else, send to all clients.

=== mapannounce ===
<pre>
mapannounce "mapname", "message", flag;
</pre>
Send an announcement to all players in map.

Only flag & 0x10 is interpreted, which does not work with the Mana client. So, flag must be 0.

=== areaannounce ===
<pre>
areaannounce "mapname", x0, y0, x1, y1, "message", flag;
</pre>
Send an announcement to all players in area.

Only flag & 0x10 is interpreted, which does not work with the Mana client. So, flag must be 0.

=== message ===
<pre>
message "player", "message";
</pre>
Display (in chat) a message from the server to a single user.

=== npctalk ===
<pre>
npctalk "message";
</pre>
Make an NPC say something publicly.

Note: in many cases areaannounce is a better choice.

== Character Commands ==
These have to do with attributes of the player.

=== setlook ===
<pre>
setlook type, value;
</pre>
Set an aspect of a character's appearance. Used e.g. by the barber.

There are constant provided for the LOOK type, and for hair color and hair style.

=== heal ===
<pre>
heal hp, sp
</pre>
Increase or decrease the player's hp and sp.

=== itemheal ===
<pre>
itemheal "ii"
</pre>
Increase or decrease the player's hp and sp, for use in item scripts.

=== percentheal ===
<pre>
percentheal "ii"
</pre>
Increase or decrease the player's hp and sp, by percentage of max HP.

This is probably the best way to instakill the player.

=== readparam ===
<pre>
readparam(type[, "playername"])
</pre>
Return one of the core parameters of a player.

type is one of the bCamelCase constants, see db/const.txt

=== getcharid ===
<pre>
getcharid(type[ "playername"])
</pre>
Get an id of the attached (or given) player.

Type is:
0: char id
1: party id
2: guild id (deprecated)
3: account id

You usually want 3.

=== getpartyname ===
<pre>
getpartyname(partyid)
</pre>
Return the name of the party with the given id, or "null".

=== getpartymember ===
<pre>
getpartymember partyid
</pre>
Fills in the array $@partymembername$

=== strcharinfo ===
<pre>
strcharinfo(num)
</pre>
Return string information about an account:
num==0: name
num==1: party name
num==2: guild name (deprecated)

=== sc_start ===
<pre>
sc_start type, tick, val1[, beingid];
</pre>
Apply a status effect to a player (or monster?).

type is one of the sc_* constants.

=== sc_start2 ===
<pre>
sc_start2 type, tick, val1, chance[, beingid];
</pre>
Chance of applying a status effect, out of 10000.

=== sc_end ===
<pre>
sc_end type;
</pre>
Immediately end status effect on current player.

=== sc_check ===
<pre>
sc_check(type)
</pre>
Whether a status effect is currently active.

=== getscrate ===
<pre>
getscrate(type, rate[, being_id])
</pre>
If the sc is poison, modify rate by (3 + vit + luk/3) percent.

The form that accepts a being_id is broken in the current stable version of the server.

=== resetlvl ===
<pre>
resetlvl type;
</pre>

=== resetstatus ===
<pre>
resetstatus;
</pre>

=== resetskill ===
<pre>
resetskill;
</pre>

=== changesex ===
<pre>
changesex;
</pre>
Ask the login server (via the char server) to toggle this account's sex, then kick the player.

=== attachrid ===
<pre>
attachrid(id)
</pre>
Change the being associated with this script.

Return true if such a player is logged in.

=== detachrid ===
<pre>
detachrid;
</pre>
Detach the player associated with this script.

=== isloggedin ===
<pre>
isloggedin(id)
</pre>
Return true if the given ID is logged in.

Often you shouldn't use this, but attachrid(id) instead

=== marriage ===
<pre>
marriage("otherplayer")
</pre>
Marry the attached player to the other player.

Return 1 on success and 0 on failure.

=== divorce ===
<pre>
divorce()
</pre>
Divorce the attached player from their partner

Return 1 on success and 0 on failure.

=== getpartnerid2 ===
<pre>
getpartnerid2()
</pre>
Return the ID of the attached player's partner (0 is none).

=== getexp ===
<pre>
getexp base, job;
</pre>
Increase the types of experience.

=== getinventorylist ===
<pre>
getinventorylist;
</pre>
Fill in some arrays of useful information: "@inventorylist_id", "@inventorylist_amount", "@inventorylist_equip".

The arrays are not cleared between calls, use "@inventory_count".

=== getskilllist ===
<pre>
getskilllist;
</pre>
Fill in some arrays of useful information: "@skilllist_id", "@skilllist_lv", "@skilllist_flag".

The arrays are not cleared between calls, use "@skill_count".

=== getpoolskilllist ===
<pre>
getpoolskilllist;
</pre>
Same, but only poolable skills.

=== getactivatedpoolskilllist ===
<pre>
getactivatedpoolskilllist;
</pre>
Same, but only activated pool skills.

=== getunactivatedpoolskilllist ===
<pre>
getunactivatedpoolskilllist;
</pre>
Same, but only unactivated pool skills.

=== poolskill ===
<pre>
poolskill skill_id;
</pre>
Activate a poolable skill.

=== unpoolskill ===
<pre>
unpoolskill skill_id;
</pre>
Deactivate a poolable skill.

=== checkpoolskill ===
<pre>
checkpoolskill(skill_id)
</pre>
Check if a pool skill is activated

=== misceffect ===
<pre>
misceffect type, "player_name";
misceffect type, being_id;
misceffect type;
</pre>
Display a miscellaneous effect on a being.

In the third form, it will use the OID if possible, and fallback to the RID.

=== getlook ===
<pre>
getlook(type)
</pre>
Return part of the player's appearance:
val==1: hair
val==2: weapon
val==3: bottom
val==4: middle
val==5: top
val==6: hair color
val==8: shield
val==9: shoes

On failure, return -1.

=== getsavepoint ===
<pre>
getsavepoint(type)
</pre>
type==0: Return savepoint map
type==1: Return savepoint x
type==2: Return savepoint y

This is believed to be the only function (other than callfunc and callsub of course) that returns a different type depending on its arguments.

=== shop ===
<pre>
shop "npcname";
</pre>
Close the script and open the given NPC's shop.

=== isdead ===
<pre>
isdead()
</pre>
Return 1 if the attached player is dead, else 0.

=== fakenpcname ===
<pre>
fakenpcname "name", "newname", new_sprite_id;
</pre>
Change the appearance of an NPC.

== Location Commands ==
These are commands that have to do with the location of players

=== warp ===
<pre>
warp "mapname", x, y;
</pre>
Warp the attached player to the given location. "mapname" may have the special values "Random", "SavePoint", and "Save" (case-sensitive), but x and y are still required.

=== isat ===
<pre>
isat("mapname", x, y)
</pre>
Return 1 if the attached player is at the given location, 0 otherwise.

=== areawarp ===
<pre>
areawarp "src_map", x0, y0, x1, y1, "dst_map", x, y;
</pre>
Warp all players in the given area to the given location.

=== getusers ===
<pre>
getusers(type)
</pre>
Count users.

If flag & 0x8, base on OID instead of RID.
If (flag & 0x7) == 0, return users on the map.
If (flag & 0x7) == 1, return users on the server.

=== getmapusers ===
<pre>
getmapusers("mapname")
</pre>
Count users on a given map.

=== getareausers ===
<pre>
getareausers("mapname", x0, y0, x1, y1)
</pre>
Count users in an area.

=== mapwarp ===
<pre>
mapwarp "src_map", "dst_map", x, y;
</pre>
Warp all players from source map to destination location.

=== npcwarp ===
<pre>
npcwarp x, y, "npcname";
</pre>
Move an NPC to a different location on the same map.

=== isin ===
<pre>
isin("mapname", x0, y0, x1, y1)
</pre>
Check if the player is in the area.

=== getx ===
<pre>
getx()
</pre>
Return attached player's x coordinate.

=== gety ===
<pre>
gety()
</pre>
Return attached player's y coordinate.

=== getmap ===
<pre>
getmap()
</pre>
Return attached player's current map.

== Item Commands ==
These have to do with items or inventory.

=== getitem ===
<pre>
getitem "itemname", count[, unused_argument[, playerid]];
getitem itemid, count[, unused_argument[, playerid]];
"ii**"
</pre>
Grant the attached player (or the given player) "count" copies of an item.

If itemname is unrecognized you get an iten (727) instead.

=== makeitem ===
<pre>
makeitem "itemname", count, "mapname", x, y;
makeitem itemid, count, "mapname", x, y;
</pre>
Drop items on the ground.

The special "mapname" value "this" means the map of the attached player.

=== delitem ===
<pre>
delitem "itemname", count;
delitem itemid, count;
</pre>
Remove items from the attached player's inventory.

This command is buggy if the player does not have enough of the item. And if the item is not stackable, the command will delete only one of them, even if a higher number is specified.

=== countitem ===
<pre>
countitem("itemname")
countitem(itemid)
</pre>
Return the number of the given item in the player's inventory.

=== checkweight ===
<pre>
checkweight("itemname", count)
checkweight(itemid, count)
</pre>
Return 0 if adding "count" of the item would put player above max weight, 1 if it would still be less than max weight.
Also returns 0 if item does not exist.

=== getequipid ===
<pre>
getequipid(equip_point)
</pre>
Return the ID of the item in the given equip slot.

equip_point is one of the equip_* constants

=== getequipname ===
<pre>
getequipname(equip_point)
</pre>
Return the name of the item in the given equip slot.

equip_point is one of the equip_* constants

=== getequipisequiped ===
<pre>
getequipisequiped(num)
</pre>
Return 1 if the player currently has an item equipped in the slot.

=== statusup ===
<pre>
statusup bType;
</pre>
Permanently increase a stat by one point.

=== statusup2 ===
<pre>
statusup2 bType, delta;
</pre>
Permanently increase or decrease a stat.

=== bonus ===
<pre>
bonus bType, delta
</pre>
Temporarily increase a stat. For use in item scripts only.

=== skill ===
<pre>
skill id, level[, flag = 1];
</pre>
Grant a skill.

flag==0: permanent skill
flag==1: temporary skill (item scripts only)

(Untested)

=== setskill ===
<pre>
setskill id, level;
</pre>
Grant a skill permanently.

=== getskilllv ===
<pre>
getskilllv(skill)
</pre>
Return the player's level of the given skill.

=== getgmlevel ===
<pre>
getgmlevel()
</pre>
Return the player's GM level.

=== getopt2 ===
<pre>
getopt2()
</pre>
Return the player's opt2 flags.

=== setopt2 ===
<pre>
setopt2 flags;
</pre>
Set the player's opt2 flags.

=== checkoption ===
<pre>
checkoption(type)
</pre>
Return 1 if the player has any of the given (XOR'ed) option bits. Usually only one is given.

=== setoption ===
<pre>
setoption type
</pre>
Set the player's option flags exactly (not OR'ing).

=== savepoint ===
<pre>
savepoint "mapname", x, y;
</pre>
Set the player's save point. Used e.g. by Soul Menhirs, and during the time travel quest.

=== openstorage ===
<pre>
openstorage;
</pre>
Open the player's storage.

=== getitemname ===
<pre>
getitemname("itemname")
getitemname(itemid)
</pre>
Return the name of the item, or "Unknown Item".

=== clearitem ===
<pre>
clearitem;
</pre>
Remove all items from a player's inventory.

=== nude ===
<pre>
nude;
</pre>
Unequip all items.

=== hasitems ===
<pre>
hasitems()
</pre>
Return 1 if the player has any inventory, 0 otherwise.

=== unequipbyid ===
<pre>
unequipbyid slot_id;
</pre>
Unequip whatever is in the slot

=== getareadropitem ===
<pre>
getareadropitem("mapname", x0, y0, x1, y1, "itemname"[, delitems = 0]);
getareadropitem("mapname", x0, y0, x1, y1, itemid[, delitems = 0]);
</pre>
Count items on the floor in an area. If delitems, the items will be deleted as well.

== Common Functions ==
These are not mostly not related to the RPG or the scripting language.

=== rand ===
<pre>
rand(range)
rand(min, max)
</pre>
In the first form, return a random number between 0 (inclusive) and range (exclusive). Return 0 if range is not positive.
In the second form, return a random number between min and max, inclusive. Min and max may be swapped.

=== gettimetick ===
<pre>
gettimetick(type)
</pre>
Return one of the ticks

type==0 (or other): milliseconds since some point in time, wraps every 50 days.
type==1: time since midnight, UTC.
type==2: seconds since the epoch.

You should almost always use type 2.

=== gettime ===
<pre>
gettime(type)
</pre>
Get a component of the time (UTC).

1: second (0-59)
2: minute (0-59)
3: hour (0-23)
4: day of week (0-6)
5: day of month (1-31)
6: month (1-12)
7: year (1902-2038)

=== gettimestr ===
<pre>
gettimestr("format", length)
</pre>
Frontend for strftime(3).

This function may be removed for technical reasons, please construct the string manually using gettime().

There is a script function that does this: callfunct "time_stamp";

== Timers and Events ==
These have to do with transfering control in ways that are not immediately obvious.

The most common ones are initnpctimer or startnpctimer, stopnpctimer, and setnpctimer.

=== doevent ===
<pre>
doevent "event";
</pre>
Manually invoke an NPC event.

=== donpcevent ===
<pre>
donpcevent "event";
</pre>
Manually invoke an NPC event.

=== addtimer ===
<pre>
addtimer tick, "event";
</pre>
Invoke an NPC event after a delay, for the attached NPC.

This command does the same thing as areatimer, but for only the attached player.

=== deltimer ===
<pre>
deltimer "event";
</pre>
This command is untested and might freeze the server.

=== initnpctimer ===
<pre>
initnpctimer;
</pre>
Set the NPC's attached timer to tick 0 and start it.

This is equivalent to setnpctimer, 0; startnpctimer;

=== stopnpctimer ===
<pre>
stopnpctimer;
</pre>
Stop the NPC's attached timer.

This DOES NOT do anything about the tick. But that's okay, you should normally be starting it with initnpctimer.

=== startnpctimer ===
<pre>
startnpctimer;
</pre>
Start the NPC's attached timer, without setting the tick.

=== setnpctimer ===
<pre>
setnpctimer tick;
</pre>
Set the NPC's timer to a specific tick. Generally, this is only useful for tick 0.

=== getnpctimer ===
<pre>
getnpctimer(type)
</pre>
Get the current tick of an NPC's timer.

type==0: timer event tick (like setnpctimer)
type==1: bool if it has a next timer.
type==2: timer amount

=== cmdothernpc ===
<pre>
cmdothernpc "npc", "Foo";
</pre>
Invoke ::OnCommandFoo

=== mobcount ===
<pre>
mobcount("mapname", "event")
</pre>
Count the remaining mobs from the spawn with the given event. Has an offset of -1.

=== areatimer ===
<pre>
areatimer "mapname", x0, y0, x1, y1, tick, "event";
</pre>
Add a PC event timer to all players in the area.

After "tick" milliseconds, the given NPC event will fire with each player as the RID.

== Unsorted Commands ==
These are commands that still need sorting, please edit this page, see talk page for category (and subcategory?) suggestions.

=== monster ===
<pre>
monster "mapname", x, y, "string", class, count[, "event"];
</pre>
Spawn monsters at a point. If you define an OnDead event using a trigger area then the event is shot only inside that area, hence the event is ignored when the monster is killed outside the trigger area.

=== areamonster ===
<pre>
areamonster "mapname", x0, y0, x1, y1, "string", class, count[, "event"];
</pre>
Spawn monsters in an area. If you define an OnDead event using a trigger area then the event is shot only inside that area, hence the event is ignored when the monster is killed outside the trigger area.

=== killmonster ===
<pre>
killmonster "mapname", "event";
</pre>
Kill monsters on a map.

Unless it is "All", "event" must match the one used at spawn time.

If "All" is given, this function properly preserves permanently respawning monsters.

=== killmonsterall ===
<pre>
killmonsterall "mapname";
</pre>
Kill all monsters unconditionally.

This command might prevent monsters from respawning. Instead use "killmonster" with "event" == "All".

=== enablenpc ===
<pre>
enablenpc "name";
</pre>
Enable an NPC.

=== disablenpc ===
<pre>
disablenpc "name";
</pre>
Disable an NPC.

=== hideoffnpc ===
<pre>
hideoffnpc "name";
</pre>
What does this do?

=== hideonnpc ===
<pre>
hideonnpc "name";
</pre>
What does this do?

=== setmapflagnosave ===
<pre>
setmapflagnosave "mapname", "savemap", x, y;
</pre>
Set the nosave flag and respawn location.

=== setmapflag ===
<pre>
setmapflag "mapname", flag;
</pre>
Set an arbitrary mapflag.

=== removemapflag ===
<pre>
removemapflag "mapname", flag;
</pre>
Unset an arbitrary mapflag.

=== getmapflag ===
<pre>
getmapflag("mapname", flag);
</pre>
Check an arbitrary mapflag.

=== pvpon ===
<pre>
pvpon "mapname";
</pre>
Allow PvP on a map.

=== pvpoff ===
<pre>
pvpoff "mapname";
</pre>
Deny PvP on a map.

=== emotion ===
<pre>
emotion emote_index;
</pre>
Show a smiley above the OID.

=== getspellinvocation ===
<pre>
getspellinvocation("spell-identifier")
</pre>
Return the #invocation used for a spell, or "...".

=== getanchorinvocation ===
<pre>
getanchorinvocation "anchor-identifier"
</pre>
Return the invocation used for a teleport anchor (?)

=== strmobinfo ===
<pre>
strmobinfo(num, class)
</pre>
Info about a type of mob:
num==1: name
num==2: jname
num==3: lv
num==4: maxhp
num==5: maxsp
num==6: base_exp
num==7: job_exp

Note that only types 1 and 2 actually return strings, the rest return integers

=== specialeffect ===
<pre>
specialeffect type;
</pre>
Display a special effect on the OID.

Same as "misceffect", but does not fallback when there is no OID.

=== specialeffect2 ===
<pre>
specialeffect2 type;
</pre>
Same as "misceffect", but works when there is an OID.

=== gmcommand ===
<pre>
gmcommand "@command maybe with arguments";
</pre>
Run a GM command, at level 99.

Classic:TmwAthena Scripting Standards

2013-04-10T10:23:04Z

Jenalya: /* Code Formatting */ Add section about NPC dialogs.

This is an attempt to standardize the eAthena coding. Any suggestions are welcome to be posted on the discussion page before editing.
=Code Formatting=
== Indentation ==
* Code is indented with four spaces.
* Code in the same block should have the same indentation.
* Labels have no indentation.
* Menu options are on their own lines and are indented further.
Example:
menu
"Yes.", L_Yes,
"No.", L_No;
* When using an if-statement, there should be a line break after the condition and the conditional command should be indented further. An exception to this is a series of if-statements at the beginning of a major code block which use gotos to jump to the correct position in the script. In this case the goto should be in the same line as the if-statement.
Example:
// if-statement and conditional command in the same line, gotos aligned
if (@quest >= 3) goto L_Done;
if (@quest == 2) goto L_Progress;
if (@quest == 1) goto L_Question;

// conditional command in the next line and indented further
if (BaseLevel < 40)
set @cost, 100;

== Whitespaces==
In many places whitespaces can increase readability. Examples are
* When concatenating text and variables:
mes "\"Hello " + strcharinfo(0) + "!\"";
instead of
mes "\"Hello "+strcharinfo(0)+"!\"";
* When assigning values to variables:
set @var, 3;
instead of
set @var,3;
* In menus:
menu
"Yes.", L_Yes,
"No.", L_No;
instead of
menu
"Yes.",L_Yes,
"No.",L_No;

== Code Blocks ==
* Code blocks should be separated from the others in a dinstinct way: insert a blank line between code blocks.
* Individual blocks should be together No blank lines within a block.
* The opening brackets should be at the end of the parent line, not in a new line; the closing ones should be in a line of their own.
* A 'menu' must not be in the body of an if statement. Instead, goto a new block for the menu, or negate the logic and goto somewhere else if the label should not be shown.
* The 'next' command goes at the end of a block (before a goto or fallthrough), never at the beginning. Make sure 'next' is never followed by something that leads to a 'close' without intervening text.

==Labels and Subfunctions==
* Labels should be named in this way: L_CamelCase
* Subfunctions should be named in this way: S_CamelCase
* Labels should always start with L_, except those that act as a subfunction, which should start with S_
* Newline before every label
* No newline after a label
* There must not be a fallthrough or goto to a subfunction label.
* A subfunction label must not goto a normal label. It may, however, goto another label that is specific to that subfunction, and eventually reach a return.

==Comments==
At the beginning of a script file there should be documented
* who is the author
* the purpose of the script
* which variables are used and what's their purpose
* any additional information that can help to understand the script
Example:
// Author: devxy
// This file contains the NPC John, who is part of the Example quest.
// Quest states are saved in Quest_Example.
// State 1: started the quest
// State 2: did the next step
[...]

Within the script there should be comments if there are parts which might be difficult to understand.

In some of the older scripts there are boxed comments used like this:
//#################################################################################
//# NPC John - By Smith #
//# #
//# ... #
//#################################################################################
Don't use them in new scripts.

== NPC Dialogs ==
In the following example our NPC dialog formatting guidelines are explained.
mes "[Example NPC Olaf]";
mes "\"When I start speaking my name is put in square brackets, and my spoken text here is in quotation marks.\"";
next;
mes "\"The next between my previous line and this one interrupted my speaking, so I started with new quotation marks.";
mes "But didn't close them in the same line, because I continue to speak here.";
mes "A new message command can be used to have a line break in the dialog without interrupting the speaking.";
mes "At the end I close the quotation marks again.\"";
next;
mes "Olaf stops speaking and scratches his head. This is a descriptive text, so it isn't put into quotation marks.";
next;
mes "[Example NPC Olaf]";
mes "\"Now that I start speaking again, I need my name in brackets again before my actual text starts, because something else happened in between.";
mes "It isn't that difficult, right?\"";
menu
"I agree.", -,
"(Leave.)", L_Close;
mes "[Example NPC Olaf]";
mes "\"It's the same after there was a menu with the player saying or doing something, again I put my name into sqaure brackets before starting to speak.\"";
next;
mes "\"In the menu you can see that something the player says isn't put into quotation marks, but just as plain text.";
mes "And an action the player takes is put into usual brackets.\"";
goto L_Close;

L_Close:
close;

=Variables=
==Document Variables==
in every file, document every variable as one of:

* # account variable (prefix #) (note that there are also ## variable which didn't work in the stable version of the server)
* permanent player variable (no prefix)
* @ temporary player variable (prefix @) - used after the script close;s or end;s.
* @ dynamic player variable (prefix @) - passed into or out of callsub or callfunc
* @ lexical (local) player variable (prefix @) - used only within the function (scripthelp.txt documents that ".@" means this but I don't know if that works)
* @ local constant (prefix @) - not dependent on the player, used only within the function. e.g. lots of @QUEST_FOO_{SHIFT,MASK}
* $ global permanent variable (prefix $) (I'm not sure if we have any of these right now)
* $ npc permanent variable (prefix $) same as above but only used by one NPC
* $ global temporary variable (prefix $@)
* $@ npc temporary variable (prefix $@) same as above but only used by one NPC, scripthelp.txt mentions prefix "." but I don't know if that works
* special variable (in db/const.txt with a 1 following)
* global constant (in const.txt)

'''If we use a consistent method of documenting these, we can then generate a list of all variables by type.'''

==Variables initialization==
Check for troublesome arrays:
A troublesome array is defined as an array that is not
*initialized all at once
*initialized by appending elements to the end, for use in a menu
Nothing needs to be done, merely document them. I want this information at hand when I design the new scripting language to minimize conversion pains.
I wouldn't be surprised if there were no troublesome arrays at all. If there are only a couple it might be worth refactoring the code to remove them, but that might be a high-level decision which is beyond the scope of this proposal.

Set dynamic and local @variables to 0 before close;
==Naming Variables==

==Using as little variables as you need==
So there are some quests, which require lots of variables.
Think of monster oil quest, Oric and Warum quest etc.

This can often be done by bitmasking:
One variable has 32 bits. So a variabe can store 2^32 different numbers: 4294967296

But sometimes you only need numbers from 0 to 15, but more of these variables.
but numbers in range 0 to 15 can be stored in 4 bits ( 2^4 = 16 different numbers)

Here is an example how to use bitmasking:
[[Media:Tester.txt]]
== Defining Map Objects ==

These sections describe how to define map objects.

=== Warp Definitions ===
'''Shouldn't be done manually.'''
Warps are what move players between maps. They can also be used to move players around a single map, if needed. Warps are defined like this:

map1,startX,startY|warp|name|width,height,map2,endX,endY

Key:
{|
|map1 ||the starting map
|-
|startX||the x-coordinate of the starting warp tile
|-
|startY||the y-coordinate of the starting warp tile
|-
|name ||the name of the warp, unused but must be defined
|-
|width ||the width of the warp
|-
|height||the height of the warp
|-
|map2 ||the ending map
|-
|endX ||the x-coordinate of the tile the player will end up on
|-
|endY ||the y-coordinate of the tile the player will end up on
|}

Width and height are described in detail here: [[EAthena Scripting Standards/Warp Details|Warp Details]].

=== Monster Definitions ===
'''Shouldn't be done manually.'''
Monsters are defined like this:

<map name>,<x>,<y>,<width>,<height>|monster|<name>|<mobID>,<count>,<spawn1>,<spawn2>,{<eventcode>}

{|
|map name ||the map the monsters should appear on
|-
|x ||the x-coordinate of the spawn tile
|-
|y ||the y-coordinate of the spawn tile
|-
|width ||the tile width of the spawn area
|-
|height ||the tile height of the spawn area
|-
|name ||the name of the mob, unused but must be defined. '''DO NOT''' use the keywords such as "spawn" in this name to avoid conflict with other game systems (magic for example)
|-
|mobID ||the mob identifier of the desired monster (in the monster db)the number to spawn
|-
|count ||the number to spawn
|-
|spawn1 ||the minimum delay between successive spawns (per individual)
|-
|spawn2 ||the minimum delay between death and respawn (per individual)
|-
|eventcode ||the script event to fire upon death
|}
A detailed description of position and area can be found here: [[EAthena Scripting Standards/Mob Details|Mob Details]].

=== NPC Definitions ===
<map name>,<x>,<y>,<facing>|script|<Name>|<spriteID>,<nowiki>{<code>}</nowiki>
<map name>,<x>,<y>,<facing>|script|<Name>|<spriteID>,<triggerX>,<triggerY>,<nowiki>{<code>}</nowiki>

{|
|map name ||the map the monsters should appear on
|-
|x ||the x-coordinate of the spawn tile
|-
|y ||the y-coordinate of the spawn tile
|-
|facing ||Direction the NPC faces to. '''It must be set to 0''' in TMW
|-
|height ||the tile height of the spawn area
|-
|Name ||the name of the NPC
|-
|spriteID ||the mob identifier of the desired NPC. Sprite ID
|-
|triggerX ||
|-
|triggerY ||
|-
|eventcode ||the script event to fire upon death
|}
* Server side :
::NPC definitions (script) are usually stored as : (tmwa-server-data/)world/map/npc/<map name>/<NPC Name>.txt or in the file : (tmwa-server-data/)world/map/npc/<map name>/npc.txt
* Client side :
::The NPC is associated with a sprite (the image that will appear in the game), and a XML file which tells the client some display parameters. (tmwa-client-data/)graphics/sprites/npcs/npc-<Name>.png (tmwa-client-data/)graphics/sprites/npcs/npc-<Name>.xml The NPC spriteID is linked to graphic files and XML in the file : (tmwa-client-data/)npcs.xml



== Script Functions ==
function|script|<function name>|<nowiki>{<code>}</nowiki>
Actual script functions are stored or imported in the files : (tmwa-server-data/)world/map/npc/functions/<function name>.txt, regardless rhey are called from a Map, NPC, Mob or item.

==Script Loading==
The main script import file is:[https://github.com/themanaworld/tmwa-server-data/blob/master/world/map/npc/scripts.conf (tmwa-server-data/)world/map/npc/scripts.conf] 
It loads [https://github.com/themanaworld/tmwa-server-data/blob/master/world/map/npc/_import.txt (tmwa-server-data/)world/map/npc/_import.txt] which imports all NPC scripts wich are stored under the respective map name folders, usually under NPC name.

=Examples=
== Open a chest and get reward ==
An example is given by a quest to get a key for a chest (in fact 3 keys):

{| style="width:850px;" border=0 cellspacing="10"
|-valign="Top"
|<pre>
// A treasure chest. You need three keys to open it.
//
// TMW_Quest (document variable here)
//

002-4.gat,93,37,0|script|Treasure|111,{

if (TMW_Quest >= 38) goto L_Finished;

mes "There is a chest here.";
mes "Do you want to try to open it?";
next;
menu
"Yes.", L_Yes,
"No.", -;
close;

L_Yes:
if(countitem("TreasureKey") < 3)
goto L_Not_Enough;
getinventorylist;
if (@inventorylist_count == 100 && countitem("TreasureKey") > 3)
goto L_TooMany;
mes "You opened the chest and found a short bow!";
delitem "TreasureKey", 3;
getitem "ShortBow", 1;
set TMW_Quest, 38;
close;

L_Not_Enough:
mes "It seems that you do not have the right key for this chest yet...";
close;

L_Finished:
mes "You have already opened this chest.";
close;

L_TooMany:
mes "You do not have enough room to loot this chest. Maybe you should try again later.";
close;
}
</pre>
|}
This script starts with describing the NPC (the chest, NPC sprite 111) and its location (map 002-4 X=93, Y=37, in tiles from top left of the map). Then follows what happens on activation:
First, the variable ''"TMW_Quest"'' is checked to know if the player already accomplished the quest '''(the variable should be documented)''', If he has the script continues at label ''L_Finished'', the player is reminded fe alredy accomplished the task and script finishes, if not the scrip continues. A message is shown (mes), then an option dialog (menu) is displayed with two possible answers : "Yes." or "No.". If the player answers "No." the script stops (close;); if he answers "Yes." the script continues at label ''L_Yes''. Now player is checked to know if he has at least 3 keys, if not script branches to label ''L_Not_Enough'' tells the player he "has not the right key" and script closes. If he has keys enough, his inventory list is retrieved by the built-in function "getinventorylist" and it's content is checked to know if the player will have room enough to store the reward after the 3 keys use. If not, script goes to label ''L_TooMany'' and script close after a warning message, If yes 3 keys are deleted in player's inventory, he gets the reward: a Short Bow and the variable TMW_Quest is set to 38.

For more examples of the current system, check out the current scripts in use by the server. Beware though, this could affect your enjoyment of the game as it does spoil some of the mystery. Here's a link to git so you can view them in your browser:

https://github.com/themanaworld/tmwa-server-data/tree/master/world/map/npc

Note that anything said by an NPC should be put in double quotes ("). You can do that like this: "'''\"'''Hello!'''\"''' she said."
=References=
* [[EAthena Scripting Basics]]
* [[EAthena Scripting Reference]]
* [http://forums.themanaworld.org/viewtopic.php?f=13&t=13653 script cleanup/scripting standards proposal]

TMW Team

2013-04-02T17:37:49Z

Jenalya: /* Members */ Update

{{Status Under Construction|See: [http://forums.themanaworld.org/viewtopic.php?p=132138#p132138 Forum TMW organization structure - TMW Committee]}}

*See: [http://forums.themanaworld.org/viewtopic.php?p=132138#p132138 Forum TMW organization structure - TMW Committee]
*The Name is not sure TMW Committee or TMW Council?

==Structure and Roles==

# The purpose of the The Mana World Committee is to make or delegate decisions regarding the running of The Mana World.
#There are different scopes under The Mana World Committee's authority. Some may require involvement of those who are not members of The Mana World Committee, but have the required knowledge or experience. The Mana World Committee members are pulled from the following categories of contributors:
## ''Game Masters''. Game Masters are responsible for enforcing the rules of the game, in game. Secondarily, Game Masters act as a bridge from the players to development team. All Game Masters are members of The Mana World Committee. To become a Game Master, a person must be voted in by the player community and approved by The Mana World Committee.
## ''Server Admins''. Admins are those that have ssh access to the server and are responsible for server restarts, maintenance, and the general health of the server overall. Forum Admin and Wiki Admin are subcategories of this group. Our new server host, who wishes to remain anonymous, also has input regarding these matters but is not considered a member of The Mana World Committee. To become a member of this group, a player or contributor must first show the appropriate knowledge, willingness to devote time, and must be unanimously approved by The Mana World Committee.
## ''Programmers''. Programmers are responsible for making changes to the codebase. Not all members of the Programmer group are admitted to The Mana World Committee. To become a member of this group, a player or contributor must show appropriate knowledge, contribute to the project and learn and gain 'git' access.
## ''Content Creators''. Content Creators are responsible for adding quests, items and monsters either via scripting, mapping, sound or pixel art. Content Creation has Council and #themanaworld-event as private domains; and #themanaworld-dev and other forums as public. Not all members of Content Creators are members of The Mana World Committee. To become a member of this group, a player or contributor must show appropriate skill, contribute to the project and is encouraged to learn and gain 'git' access.
# A newly created role in The Mana World Commitee will be that of ''Advisor''. TMWC Advisors are those contributors or GHP members that have stepped away from the game or development, yet offer insight, advice and/or periodic assistance with game decisions and development, while not directly taking decisions.
==Members==

The current members of The Mana World Committee are as follows:

* Big Crunch - [[Game Masters|Game Master]]
* Tiana - [[Game Masters|Game Master]]
* prsm - [[Game Masters|Game Master]]
* [[User:Narus|Narus]] - [[Game Masters|Game Master]]
* mrgrey - [[Game Masters|Game Master]]
* Silent Dawn - [[Game Masters|Game Master]]
* [[User:o11c|o11c]] - Programmer (Lead) and Server Administrator
* [[User:4144|4144]] - Programmer and Client Developer
* [[User:Frost|Frost]] - Server Administrator (Main)
* [[User:Jenalya|Jenalya]] - Content Creator (Lead) and Server Administrator
* [[User:V0id|V0id]] - Content Creator
* [[User:Yubaba|Chicka-Maria/Yubaba]] - Content Creator
* [[User:Crush|Crush]] - (Forum administrator, wiki [[TheManaWorld:Bureaucrats|bureaucrat]] & [[TheManaWorld:Administrators|administrator]])

The Advisors group is as follows:

* [[User:Freeyorp|Freeyorp]] (Former Administrator and developer, forum administrator)
* [[User:Bjorn|Bjorn]] (Former Administrator and developer, wiki [[TheManaWorld:Bureaucrats|bureaucrat]] & [[TheManaWorld:Administrators|administrator]])
* [[User:ElvenProgrammer|ElvenProgrammer]] (project founder)
* [[User:Rotonen|Rotonen]] (Former developer)
* [[User:AnonDuck|AnonDuck]] (Former developer)
* [[User:Wombat|Wombat]] (Former Content leader, developer)
* [[User:irukard|irukard]] (Former developer)

More advisors may be added or removed in the future, pending contact.

Development:Projects and Teams

2013-03-28T15:05:44Z

Jenalya: Add project 'Tulimshar expansion'

<div style="font-size:250%" class="center">'''Projects'''</div>

<div class="center">Here is a list of the current projects under development. You can see the list of developers [[Developers|here]].</div>

{| border="1" cellspacing="0" cellpadding="5"
! style="background:#efdead;" | Project
! style="background:#efdead;" | Team
! style="background:#efdead;" | Description
! style="background:#efdead;" | Monster Reservations
! style="background:#efdead;" | Item Reservations
! style="background:#efdead;" | Map Reservations
! style="background:#efdead;" | New NPCs
! style="background:#efdead;" | Status
|-
| '''Trade City [[Argaes]]'''
| [[User:V0id|V0id]]
| Assassin Guild quest (Miriam follow-up) in Trade City
|
| Assassin Set
|
|
| Scenario writing.
|-
| '''New Desert Area ([[Tonori]])'''
| [[User:Yubaba|Yubaba]]
| Creating Desert maps, area further from Tulimshar and new quests.
| Snake Lord, Desert Monsters
| Snake Skin Armour, Desert bow
|
| Desert/Egyptian NPCs
| Mapping and quest writing in progress, tileset art needed
|-
|-
| '''East [[Argaes]]'''
| [[User:Jenalya|Jenalya]], [[User:Tux|tux9th]]
| Extension to the east, including farmlands, port-city, waterfall area
| Farmmobs
| TBA
| 057 - 067
| Farm NPCs
| Mapping in progress, tileset art needed
|-
| '''Orum and Waric Continuation'''
| [[User:Jenalya|Jenalya]], [[User:Tux|tux9th]], mrgrey
| Continuation of the Orum and Waric quest.
| Evil Woodland monsters
| Rose hat, magical flowers
| 055, 056
|
| Scripting in progress
|-
| '''Barbarian Village ([[Kaizei]]).'''
| [[User:Jenalya|Jenalya]], [[User:Tux|tux9th]]
| A village of barbarians yet to be named.
| TBA
| TBA
| 049, 050, 053, 054
| Barbarian NPCs
| tilesets missing
|-
| '''Lumber Camp ([[Argaes]])'''
| [[User:o11c|o11c]]
| Southern [[Argaes]] expansion. Quests include: Help the Lumberjacks/Save the Dell (a choice); the Naturalist's Studies; ?
|
|
| 035-039
|
| on hold, graphics missing?
|-
| '''[[Thermin]] ([[Kaizei]])'''
| [[User:Jenalya|Jenalya]], [[User:Alastrim|Alastrim]]
| [[Kaizei]] area town. Once a large town that mined the firerock stones beneath the town, it was devastated by a poison gas leak. During the crisis to survive, they collaborated on several new technologies to both defend the town from the rampaging Yeti surrounding the town and to find ways to get back to using the mine, despite the poison gas problem.
|
| GasMask, Monocle
|
| Gasmask steam punk NPC, clockwork armor NPC, barbarian NPCs, [http://forums.themanaworld.org/viewtopic.php?f=8&t=12839 generic pose NPCs]
| tilesets missing
|-
| '''[[Thermin]] ([[Kaizei]]) Poisonous Mine'''
| [[User:Alastrim|Alastrim]]
| Poison gas mine. A constant moving adventure with puzzles and traps to solve and disarm along the way. Suggestions: Barriers of some type, puzzle mini-games (input code words chosen at random, arrange items, push buttons in a certain order, kill a certain monster on the map), a poison map flag, the use of event monster scripting instead of _mobs.txt spawning.
| Ice Skull, Purple Slime, Acid Goblin, Longjohn, Serqet, Fire Lizard
| Firerock,
| 043
|
| tilesets missing
|-
| '''Crypt'''
| Skipy,[[User:Yubaba|Yubaba]]
| Reaper boss quest
| Reaper, scythe, the lost, ball lightning, vampire bat
| Death's Hand, Reaper blade
|
|
| tileset incomplete, art developer inactive.
|-
| '''Ancient Amulets'''
| [[User:Alastrim|Alastrim]]
| Five quests leading to different Four-Leaf Amulets of different strengh.
| Shadow Elemental (1st Quest)
| Four-Leaf Amulets
| 024-3 to 024-8
| Explorer
| on hold, developer inactive
|-
| '''Kageville'''
| [[User:Kage|Kage]]
| TBA
|
|
| 040
|
| on hold, developer inactive
|-
| '''Hetchel the silk weaver [373] ([[Tulimshar]])'''
| [[User:bh28|bh28]]
| Lora Tay says she can sew Silk Robes provided you give her some silk sheets.and that Hetchel in Tulimshar can weave them for you.
|
| Silk Sheet [881], dyed Silk Sheets [2250 to 2259]
| 021-1
| Hetchel (373)
| Hetche graphics update, 021-2 : add weaver workshop
|-
| '''Tulimshar expansion'''
| wushin
|
| Caboo
|
| 068-073
|
| Mapping in progress, scenario writing
|-
|}

<div style="font-size:250%" class="center">'''Teams'''</div>

<div class="center">Here is a list of all the different developer teams. You can see the list of developers [[Developers|here]].</div>

{| border="1" cellspacing="0" cellpadding="5"
! style="background:#efdead;" | Name
! style="background:#efdead;" | Member(s)
! style="background:#efdead;" | Role
|-
| '''The Mana World - Athena Leader'''
| [[User:Jenalya|Jenalya]]
| Coordinates tmwA. Network and delegate tasks. Increase participation.
|-
| '''Content Lead'''
| [[User:Jenalya|Jenalya]]
| Coordinates tmwA General Content (non-sound, non-art).
|-
| '''Source Lead'''
| [[User:o11c|o11c]]
| Adjusts and coordinates Athena source code. Meets content team requests for source code adjustments to further content. Research and development of Athena source code and scripting conventions.
|-
| '''Sound Lead'''
| [[User:Yubaba|Yubaba]]
| Determines if sound on the forums is ready for the game. Encourages people to get involved in sound and encourage players to try their hand at sound. Attempts to meet the [REQ]s of content developers as well as creates any sound that may seem to add to the project, from monsters to maps to battle and beyond.
|-
| '''Pixel Artists'''
| Nami, [[User:Salmondine|Salmondine]]
| Determines if art is ready for the game. Helps categorize art topics. Encourage artists contribute to the game and encourage players to try their hand at art. Understand content priorities and attempt to steer art to meeting art deadlines.
|-
| '''Mapping Lead'''
|
| Reviews maps for the game. Check for proper use of black border, collision tiles, and application of tiles onto the correct layers they belong on. Fix mapping errors.
|-
|}

Development:Projects and Teams

2013-03-19T14:05:59Z

Jenalya: Add some notes about art needed

<div style="font-size:250%" class="center">'''Projects'''</div>

<div class="center">Here is a list of the current projects under development. You can see the list of developers [[Developers|here]].</div>

{| border="1" cellspacing="0" cellpadding="5"
! style="background:#efdead;" | Project
! style="background:#efdead;" | Team
! style="background:#efdead;" | Description
! style="background:#efdead;" | Monster Reservations
! style="background:#efdead;" | Item Reservations
! style="background:#efdead;" | Map Reservations
! style="background:#efdead;" | New NPCs
! style="background:#efdead;" | Status
|-
| '''Trade City [[Argaes]]'''
| [[User:V0id|V0id]]
| Assassin Guild quest (Miriam follow-up) in Trade City
|
| Assassin Set
|
|
| Scenario writing.
|-
| '''New Desert Area ([[Tonori]])'''
| [[User:Yubaba|Yubaba]]
| Creating Desert maps, area further from Tulimshar and new quests.
| Snake Lord, Desert Monsters
| Snake Skin Armour, Desert bow
|
| Desert/Egyptian NPCs
| Mapping and quest writing in progress, tileset art needed
|-
|-
| '''East [[Argaes]]'''
| [[User:Jenalya|Jenalya]], [[User:Tux|tux9th]]
| Extension to the east, including farmlands, port-city, waterfall area
| Farmmobs
| TBA
| 057 - 067
| Farm NPCs
| Mapping in progress, tileset art needed
|-
| '''Orum and Waric Continuation'''
| [[User:Jenalya|Jenalya]], [[User:Tux|tux9th]], mrgrey
| Continuation of the Orum and Waric quest.
| Evil Woodland monsters
| Rose hat, magical flowers
| 055, 056
|
| Scripting in progress
|-
| '''Barbarian Village ([[Kaizei]]).'''
| [[User:Jenalya|Jenalya]], [[User:Tux|tux9th]]
| A village of barbarians yet to be named.
| TBA
| TBA
| 049, 050, 053, 054
| Barbarian NPCs
| tilesets missing
|-
| '''Lumber Camp ([[Argaes]])'''
| [[User:o11c|o11c]]
| Southern [[Argaes]] expansion. Quests include: Help the Lumberjacks/Save the Dell (a choice); the Naturalist's Studies; ?
|
|
| 035-039
|
| on hold, graphics missing?
|-
| '''[[Thermin]] ([[Kaizei]])'''
| [[User:Jenalya|Jenalya]], [[User:Alastrim|Alastrim]]
| [[Kaizei]] area town. Once a large town that mined the firerock stones beneath the town, it was devastated by a poison gas leak. During the crisis to survive, they collaborated on several new technologies to both defend the town from the rampaging Yeti surrounding the town and to find ways to get back to using the mine, despite the poison gas problem.
|
| GasMask, Monocle
|
| Gasmask steam punk NPC, clockwork armor NPC, barbarian NPCs, [http://forums.themanaworld.org/viewtopic.php?f=8&t=12839 generic pose NPCs]
| tilesets missing
|-
| '''[[Thermin]] ([[Kaizei]]) Poisonous Mine'''
| [[User:Alastrim|Alastrim]]
| Poison gas mine. A constant moving adventure with puzzles and traps to solve and disarm along the way. Suggestions: Barriers of some type, puzzle mini-games (input code words chosen at random, arrange items, push buttons in a certain order, kill a certain monster on the map), a poison map flag, the use of event monster scripting instead of _mobs.txt spawning.
| Ice Skull, Purple Slime, Acid Goblin, Longjohn, Serqet, Fire Lizard
| Firerock,
| 043
|
| tilesets missing
|-
| '''Crypt'''
| Skipy,[[User:Yubaba|Yubaba]]
| Reaper boss quest
| Reaper, scythe, the lost, ball lightning, vampire bat
| Death's Hand, Reaper blade
|
|
| tileset incomplete, art developer inactive.
|-
| '''Ancient Amulets'''
| [[User:Alastrim|Alastrim]]
| Five quests leading to different Four-Leaf Amulets of different strengh.
| Shadow Elemental (1st Quest)
| Four-Leaf Amulets
| 024-3 to 024-8
| Explorer
| on hold, developer inactive
|-
| '''Kageville'''
| [[User:Kage|Kage]]
| TBA
|
|
| 040
|
| on hold, developer inactive
|-
| '''Hetchel the silk weaver [373] ([[Tulimshar]])'''
| [[User:bh28|bh28]]
| Lora Tay says she can sew Silk Robes provided you give her some silk sheets.and that Hetchel in Tulimshar can weave them for you.
|
| Silk Sheet [881], dyed Silk Sheets [2250 to 2259]
| 021-1
| Hetchel (373)
| Hetche graphics update, 021-2 : add weaver workshop
|}

<div style="font-size:250%" class="center">'''Teams'''</div>

<div class="center">Here is a list of all the different developer teams. You can see the list of developers [[Developers|here]].</div>

{| border="1" cellspacing="0" cellpadding="5"
! style="background:#efdead;" | Name
! style="background:#efdead;" | Member(s)
! style="background:#efdead;" | Role
|-
| '''The Mana World - Athena Leader'''
| [[User:Jenalya|Jenalya]]
| Coordinates tmwA. Network and delegate tasks. Increase participation.
|-
| '''Content Lead'''
| [[User:Jenalya|Jenalya]]
| Coordinates tmwA General Content (non-sound, non-art).
|-
| '''Source Lead'''
| [[User:o11c|o11c]]
| Adjusts and coordinates Athena source code. Meets content team requests for source code adjustments to further content. Research and development of Athena source code and scripting conventions.
|-
| '''Sound Lead'''
| [[User:Yubaba|Yubaba]]
| Determines if sound on the forums is ready for the game. Encourages people to get involved in sound and encourage players to try their hand at sound. Attempts to meet the [REQ]s of content developers as well as creates any sound that may seem to add to the project, from monsters to maps to battle and beyond.
|-
| '''Pixel Artists'''
| Nami, [[User:Salmondine|Salmondine]]
| Determines if art is ready for the game. Helps categorize art topics. Encourage artists contribute to the game and encourage players to try their hand at art. Understand content priorities and attempt to steer art to meeting art deadlines.
|-
| '''Mapping Lead'''
|
| Reviews maps for the game. Check for proper use of black border, collision tiles, and application of tiles onto the correct layers they belong on. Fix mapping errors.
|-
|}

Classic:TmwAthena Scripting Reference

2013-03-10T19:14:31Z

Jenalya: Amend the description of mobcount with a note about the -1 offset.

This page is a reference for commands believed to work in the eAthena scripting language still used by tmwAthena.

A number of problematic commands have been removed from this list, but not all commands have been tested.

== Language Commands ==
These are command that are closely tied to the language itself.

=== goto ===
<pre>
goto L_1;
</pre>
Unconditionally jump to a label. Often used in an "if" body.

=== callsub ===
<pre>
callsub S_labelname, arguments...;
</pre>
Jump to the given label. When the "return" statement is executed, continue on the next line.

It is not known whether "arguments..." works, we use temporary variables instead.

It might also be possible to use this as a function, if the form of return with a value is used, but we use temporary variables instead.

=== callfunc ===
<pre>
callfunc "function_name", arguments...;
</pre>
Jump to the given function script. When the "return" statement is executed, continue on the next line of this script.

It is not known whether "arguments..." works, we use temporary variables instead.

It might also be possible to use this as a function, if the form of return with a value is used, but we use temporary variables instead.

"return" is broken if this is used from within an if(). If you need a conditional callfunc, first goto a label.

=== return ===
<pre>
return;
return expr;
</pre>
Return from this script or sublabel to the calling function.

It is unknown what happens if this is used from the top-level script, use "close" or "end" instead.

We use temporary variables instead of the form that returns an expression.

=== getarg ===
<pre>
getarg(index)
</pre>
Return (by reference?) an argument of "callsub" or "callfunc". Aborts the script if used at toplevel of if out of range.

We use temporary variables instead.

=== set ===
<pre>
set variable, expression;
</pre>
Very common command, to set variables.

=== setarray ===
<pre>
setarray arrayvariable, val1, val2, ...;
</pre>
Set elements of an array. Previous elements are not cleared. At most 128 elements can be assigned.

It is currently possible, but deprecated, to specify a (zero-based) array index to start at the given part of an array. It's pretty amazing that that code works anyway.

Remember that there are no permanent arrays, only temporary.

=== cleararray ===
<pre>
cleararray variable, value, count;
</pre>
Fill an array with "count" copies of "value".

=== copyarray ===
<pre>
copyarray dest_var, src_var, count;
</pre>
Copy elements of an array.

This function looks broken to me.

=== getarraysize ===
<pre>
getarraysize variable;
</pre>
Get the size of an array.

The size of an array is simply one more than the index of the last nonzero integer or nonempty string.

WARNING: most functions that set an array do not bother to clear out high indices. You should almost always use an explicitly-provided size instead.

=== deletearray ===
<pre>
deletearray variable[, count = 1];
</pre>
Remove count elements from an array.

If there are elements beyond count, they will be shifted into lower indices.

After that, all remaining elements will be set to 0 or "".

This function is currently broken, instead use cleararray variable, 0, count;

=== getelementofarray ===
<pre>
getelementofarray(arrayname, index_expr)
</pre>
This function is invoked internally by the arrayname[index_expr] syntax.

=== if ===
<pre>
if (condition) condition_command [conditional_command_args, ...];
</pre>
If condition is zero, do nothing. Else, evaluate the conditional command.

The only thing special about the if command is the lack of commas during parsing (from my reading this is only a warning?). During execution it is perfectly normal.

=== end ===
<pre>
end;
</pre>
Stop executing the script.

Don't use this if you have opened a dialog to the player, use "close" instead. Or, use "close2" and *then* "end".

=== debugmes ===
<pre>
debugmes "string"
</pre>
Print a message to stdout.

== Message Commands ==
These are commands for dialog or one-way chat with players.

=== mes ===
<pre>
mes "string";
</pre>
Display a line of text to the player. If a dialog box is not already open for the attached NPC, one will be created.

It is unknown if the client properly supports dialog with multiple NPCs simultaneously. Note that the server only allows each account one paused script at a time, so it probably wouldn't work anyway.

=== next ===
<pre>
next;
</pre>
Stop the script until the user presses "Next" in the dialog.

=== close ===
<pre>
close;
</pre>
Stop executing the script and give the user a "Close" button in the dialog.

=== close2 ===
<pre>
close2;
</pre>
Stop the script until the user presses the "Close" button in the dialog, then keep executing the script.

WARNING: unlike close, this command is a blocking command, the usual caveats apply.

=== menu ===
<pre>
menu
"option 1", L_1,
"option 2", L_2,
"default", -;
</pre>
Display a list of choices to the player, then branch to the specified label. The special label "-" means don't branch, just continue with the next statement.

Additionally, the temporary variable "@menu" is set to the 1-based index of the choice.

The options must not contain the character ":", as the protocol uses it as a separator.

=== input ===
<pre>
input variable_name;
</pre>
Input an integer or string to the given variable, depending on whether has the '$' string postfix.

The implementation allows variable_name to be omitted if input is an integer, in case l14 is used. Don't use this.

=== announce ===
<pre>
announce "message", flag;
</pre>
Do a GM message.

If flag & 0xF == 0 forward it to all map servers.
If flag & 0x8, message is from the OID (NPC? usually?) rather than the RID (player).

If (flag & 0x7) == 1, send to all on map.
If (flag & 0x7) == 2, send to all in line of sight.
If (flag & 0x7) == 3, send to self only.
If (flag & 0x7) == anything else, send to all clients.

=== mapannounce ===
<pre>
mapannounce "mapname", "message", flag;
</pre>
Send an announcement to all players in map.

Only flag & 0x10 is interpreted, which does not work with the Mana client. So, flag must be 0.

=== areaannounce ===
<pre>
areaannounce "mapname", x0, y0, x1, y1, "message", flag;
</pre>
Send an announcement to all players in area.

Only flag & 0x10 is interpreted, which does not work with the Mana client. So, flag must be 0.

=== message ===
<pre>
message "player", "message";
</pre>
Display (in chat) a message from the server to a single user.

=== npctalk ===
<pre>
npctalk "message";
</pre>
Make an NPC say something publicly.

Note: in many cases areaannounce is a better choice.

== Character Commands ==
These have to do with attributes of the player.

=== setlook ===
<pre>
setlook type, value;
</pre>
Set an aspect of a character's appearance. Used e.g. by the barber.

There are constant provided for the LOOK type, and for hair color and hair style.

=== heal ===
<pre>
heal hp, sp
</pre>
Increase or decrease the player's hp and sp.

=== itemheal ===
<pre>
itemheal "ii"
</pre>
Increase or decrease the player's hp and sp, for use in item scripts.

=== percentheal ===
<pre>
percentheal "ii"
</pre>
Increase or decrease the player's hp and sp, by percentage of max HP.

This is probably the best way to instakill the player.

=== readparam ===
<pre>
readparam(type[, "playername"])
</pre>
Return one of the core parameters of a player.

type is one of the bCamelCase constants, see db/const.txt

=== getcharid ===
<pre>
getcharid(type[ "playername"])
</pre>
Get an id of the attached (or given) player.

Type is:
0: char id
1: party id
2: guild id (deprecated)
3: account id

You usually want 3.

=== getpartyname ===
<pre>
getpartyname(partyid)
</pre>
Return the name of the party with the given id, or "null".

=== getpartymember ===
<pre>
getpartymember partyid
</pre>
Fills in the array $@partymembername$

=== strcharinfo ===
<pre>
strcharinfo(num)
</pre>
Return string information about an account:
num==0: name
num==1: party name
num==2: guild name (deprecated)

=== sc_start ===
<pre>
sc_start type, tick, val1[, beingid];
</pre>
Apply a status effect to a player (or monster?).

type is one of the sc_* constants.

=== sc_start2 ===
<pre>
sc_start2 type, tick, val1, chance[, beingid];
</pre>
Chance of applying a status effect, out of 10000.

=== sc_end ===
<pre>
sc_end type;
</pre>
Immediately end status effect on current player.

=== sc_check ===
<pre>
sc_check(type)
</pre>
Whether a status effect is currently active.

=== getscrate ===
<pre>
getscrate(type, rate[, being_id])
</pre>
If the sc is poison, modify rate by (3 + vit + luk/3) percent.

The form that accepts a being_id is broken in the current stable version of the server.

=== resetlvl ===
<pre>
resetlvl type;
</pre>

=== resetstatus ===
<pre>
resetstatus;
</pre>

=== resetskill ===
<pre>
resetskill;
</pre>

=== changesex ===
<pre>
changesex;
</pre>
Ask the login server (via the char server) to toggle this account's sex, then kick the player.

=== attachrid ===
<pre>
attachrid(id)
</pre>
Change the being associated with this script.

Return true if such a player is logged in.

=== detachrid ===
<pre>
detachrid;
</pre>
Detach the player associated with this script.

=== isloggedin ===
<pre>
isloggedin(id)
</pre>
Return true if the given ID is logged in.

Often you shouldn't use this, but attachrid(id) instead

=== marriage ===
<pre>
marriage("otherplayer")
</pre>
Marry the attached player to the other player.

Return 1 on success and 0 on failure.

=== divorce ===
<pre>
divorce()
</pre>
Divorce the attached player from their partner

Return 1 on success and 0 on failure.

=== getpartnerid2 ===
<pre>
getpartnerid2()
</pre>
Return the ID of the attached player's partner (0 is none).

=== getexp ===
<pre>
getexp base, job;
</pre>
Increase the types of experience.

=== getinventorylist ===
<pre>
getinventorylist;
</pre>
Fill in some arrays of useful information: "@inventorylist_id", "@inventorylist_amount", "@inventorylist_equip".

The arrays are not cleared between calls, use "@inventory_count".

=== getskilllist ===
<pre>
getskilllist;
</pre>
Fill in some arrays of useful information: "@skilllist_id", "@skilllist_lv", "@skilllist_flag".

The arrays are not cleared between calls, use "@skill_count".

=== getpoolskilllist ===
<pre>
getpoolskilllist;
</pre>
Same, but only poolable skills.

=== getactivatedpoolskilllist ===
<pre>
getactivatedpoolskilllist;
</pre>
Same, but only activated pool skills.

=== getunactivatedpoolskilllist ===
<pre>
getunactivatedpoolskilllist;
</pre>
Same, but only unactivated pool skills.

=== poolskill ===
<pre>
poolskill skill_id;
</pre>
Activate a poolable skill.

=== unpoolskill ===
<pre>
unpoolskill skill_id;
</pre>
Deactivate a poolable skill.

=== checkpoolskill ===
<pre>
checkpoolskill(skill_id)
</pre>
Check if a pool skill is activated

=== misceffect ===
<pre>
misceffect type, "player_name";
misceffect type, being_id;
misceffect type;
</pre>
Display a miscellaneous effect on a being.

In the third form, it will use the OID if possible, and fallback to the RID.

=== getlook ===
<pre>
getlook(type)
</pre>
Return part of the player's appearance:
val==1: hair
val==2: weapon
val==3: bottom
val==4: middle
val==5: top
val==6: hair color
val==8: shield
val==9: shoes

On failure, return -1.

=== getsavepoint ===
<pre>
getsavepoint(type)
</pre>
type==0: Return savepoint map
type==1: Return savepoint x
type==2: Return savepoint y

This is believed to be the only function (other than callfunc and callsub of course) that returns a different type depending on its arguments.

=== shop ===
<pre>
shop "npcname";
</pre>
Close the script and open the given NPC's shop.

=== isdead ===
<pre>
isdead()
</pre>
Return 1 if the attached player is dead, else 0.

=== fakenpcname ===
<pre>
fakenpcname "name", "newname", new_sprite_id;
</pre>
Change the appearance of an NPC.

== Location Commands ==
These are commands that have to do with the location of players

=== warp ===
<pre>
warp "mapname", x, y;
</pre>
Warp the attached player to the given location. "mapname" may have the special values "Random", "SavePoint", and "Save" (case-sensitive), but x and y are still required.

=== isat ===
<pre>
isat("mapname", x, y)
</pre>
Return 1 if the attached player is at the given location, 0 otherwise.

=== areawarp ===
<pre>
areawarp "src_map", x0, y0, x1, y1, "dst_map", x, y;
</pre>
Warp all players in the given area to the given location.

=== getusers ===
<pre>
getusers(type)
</pre>
Count users.

If flag & 0x8, base on OID instead of RID.
If (flag & 0x7) == 0, return users on the map.
If (flag & 0x7) == 1, return users on the server.

=== getmapusers ===
<pre>
getmapusers("mapname")
</pre>
Count users on a given map.

=== getareausers ===
<pre>
getareausers("mapname", x0, y0, x1, y1)
</pre>
Count users in an area.

=== mapwarp ===
<pre>
mapwarp "src_map", "dst_map", x, y;
</pre>
Warp all players from source map to destination location.

=== npcwarp ===
<pre>
npcwarp x, y, "npcname";
</pre>
Move an NPC to a different location on the same map.

=== isin ===
<pre>
isin("mapname", x0, y0, x1, y1)
</pre>
Check if the player is in the area.

=== getx ===
<pre>
getx()
</pre>
Return attached player's x coordinate.

=== gety ===
<pre>
gety()
</pre>
Return attached player's y coordinate.

=== getmap ===
<pre>
getmap()
</pre>
Return attached player's current map.

== Item Commands ==
These have to do with items or inventory.

=== getitem ===
<pre>
getitem "itemname", count[, unused_argument[, playerid]];
getitem itemid, count[, unused_argument[, playerid]];
"ii**"
</pre>
Grant the attached player (or the given player) "count" copies of an item.

If itemname is unrecognized you get an iten (727) instead.

=== makeitem ===
<pre>
makeitem "itemname", count, "mapname", x, y;
makeitem itemid, count, "mapname", x, y;
</pre>
Drop items on the ground.

The special "mapname" value "this" means the map of the attached player.

=== delitem ===
<pre>
delitem "itemname", count;
delitem itemid, count;
</pre>
Remove items from the attached player's inventory.

This command is buggy if the player does not have enough of the item.

=== countitem ===
<pre>
countitem("itemname")
countitem(itemid)
</pre>
Return the number of the given item in the player's inventory.

=== checkweight ===
<pre>
checkweight("itemname", count)
checkweight(itemid, count)
</pre>
Return 0 if adding "count" of the item would put player above max weight, 1 if it would still be less than max weight.
Also returns 0 if item does not exist.

=== getequipid ===
<pre>
getequipid(equip_point)
</pre>
Return the ID of the item in the given equip slot.

equip_point is one of the equip_* constants

=== getequipname ===
<pre>
getequipname(equip_point)
</pre>
Return the name of the item in the given equip slot.

equip_point is one of the equip_* constants

=== getequipisequiped ===
<pre>
getequipisequiped(num)
</pre>
Return 1 if the player currently has an item equipped in the slot.

=== statusup ===
<pre>
statusup bType;
</pre>
Permanently increase a stat by one point.

=== statusup2 ===
<pre>
statusup2 bType, delta;
</pre>
Permanently increase or decrease a stat.

=== bonus ===
<pre>
bonus bType, delta
</pre>
Temporarily increase a stat. For use in item scripts only.

=== skill ===
<pre>
skill id, level[, flag = 1];
</pre>
Grant a skill.

flag==0: permanent skill
flag==1: temporary skill (item scripts only)

(Untested)

=== setskill ===
<pre>
setskill id, level;
</pre>
Grant a skill permanently.

=== getskilllv ===
<pre>
getskilllv(skill)
</pre>
Return the player's level of the given skill.

=== getgmlevel ===
<pre>
getgmlevel()
</pre>
Return the player's GM level.

=== getopt2 ===
<pre>
getopt2()
</pre>
Return the player's opt2 flags.

=== setopt2 ===
<pre>
setopt2 flags;
</pre>
Set the player's opt2 flags.

=== checkoption ===
<pre>
checkoption(type)
</pre>
Return 1 if the player has any of the given (XOR'ed) option bits. Usually only one is given.

=== setoption ===
<pre>
setoption type
</pre>
Set the player's option flags exactly (not OR'ing).

=== savepoint ===
<pre>
savepoint "mapname", x, y;
</pre>
Set the player's save point. Used e.g. by Soul Menhirs, and during the time travel quest.

=== openstorage ===
<pre>
openstorage;
</pre>
Open the player's storage.

=== getitemname ===
<pre>
getitemname("itemname")
getitemname(itemid)
</pre>
Return the name of the item, or "Unknown Item".

=== clearitem ===
<pre>
clearitem;
</pre>
Remove all items from a player's inventory.

=== nude ===
<pre>
nude;
</pre>
Unequip all items.

=== hasitems ===
<pre>
hasitems()
</pre>
Return 1 if the player has any inventory, 0 otherwise.

=== unequipbyid ===
<pre>
unequipbyid slot_id;
</pre>
Unequip whatever is in the slot

=== getareadropitem ===
<pre>
getareadropitem("mapname", x0, y0, x1, y1, "itemname"[, delitems = 0]);
getareadropitem("mapname", x0, y0, x1, y1, itemid[, delitems = 0]);
</pre>
Count items on the floor in an area. If delitems, the items will be deleted as well.

== Common Functions ==
These are not mostly not related to the RPG or the scripting language.

=== rand ===
<pre>
rand(range)
rand(min, max)
</pre>
In the first form, return a random number between 0 (inclusive) and range (exclusive). Return 0 if range is not positive.
In the second form, return a random number between min and max, inclusive. Min and max may be swapped.

=== gettimetick ===
<pre>
gettimetick(type)
</pre>
Return one of the ticks

type==0 (or other): milliseconds since some point in time, wraps every 50 days.
type==1: time since midnight, UTC.
type==2: seconds since the epoch.

You should almost always use type 2.

=== gettime ===
<pre>
gettime(type)
</pre>
Get a component of the time (UTC).

1: second (0-59)
2: minute (0-59)
3: hour (0-23)
4: day of week (0-6)
5: day of month (1-31)
6: month (1-12)
7: year (1902-2038)

=== gettimestr ===
<pre>
gettimestr("format", length)
</pre>
Frontend for strftime(3).

This function may be removed for technical reasons, please construct the string manually using gettime().

There is a script function that does this: callfunct "time_stamp";

== Timers and Events ==
These have to do with transfering control in ways that are not immediately obvious.

The most common ones are initnpctimer or startnpctimer, stopnpctimer, and setnpctimer.

=== doevent ===
<pre>
doevent "event";
</pre>
Manually invoke an NPC event.

=== donpcevent ===
<pre>
donpcevent "event";
</pre>
Manually invoke an NPC event.

=== addtimer ===
<pre>
addtimer tick, "event";
</pre>
Invoke an NPC event after a delay, for the attached NPC.

This command does the same thing as areatimer, but for only the attached player.

=== deltimer ===
<pre>
deltimer "event";
</pre>
This command is untested and might freeze the server.

=== initnpctimer ===
<pre>
initnpctimer;
</pre>
Set the NPC's attached timer to tick 0 and start it.

This is equivalent to setnpctimer, 0; startnpctimer;

=== stopnpctimer ===
<pre>
stopnpctimer;
</pre>
Stop the NPC's attached timer.

This DOES NOT do anything about the tick. But that's okay, you should normally be starting it with initnpctimer.

=== startnpctimer ===
<pre>
startnpctimer;
</pre>
Start the NPC's attached timer, without setting the tick.

=== setnpctimer ===
<pre>
setnpctimer tick;
</pre>
Set the NPC's timer to a specific tick. Generally, this is only useful for tick 0.

=== getnpctimer ===
<pre>
getnpctimer(type)
</pre>
Get the current tick of an NPC's timer.

type==0: timer event tick (like setnpctimer)
type==1: bool if it has a next timer.
type==2: timer amount

=== cmdothernpc ===
<pre>
cmdothernpc "npc", "Foo";
</pre>
Invoke ::OnCommandFoo

=== mobcount ===
<pre>
mobcount("mapname", "event")
</pre>
Count the remaining mobs from the spawn with the given event. Has an offset of -1.

=== areatimer ===
<pre>
areatimer "mapname", x0, y0, x1, y1, tick, "event";
</pre>
Add a PC event timer to all players in the area.

After "tick" milliseconds, the given NPC event will fire with each player as the RID.

== Unsorted Commands ==
These are commands that still need sorting, please edit this page, see talk page for category (and subcategory?) suggestions.

=== monster ===
<pre>
monster "mapname", x, y, "string", class, count[, "event"];
</pre>
Spawn monsters at a point. If you define an OnDead event using a trigger area then the event is shot only inside that area, hence the event is ignored when the monster is killed outside the trigger area.

=== areamonster ===
<pre>
areamonster "mapname", x0, y0, x1, y1, "string", class, count[, "event"];
</pre>
Spawn monsters in an area. If you define an OnDead event using a trigger area then the event is shot only inside that area, hence the event is ignored when the monster is killed outside the trigger area.

=== killmonster ===
<pre>
killmonster "mapname", "event";
</pre>
Kill monsters on a map.

Unless it is "All", "event" must match the one used at spawn time.

If "All" is given, this function properly preserves permanently respawning monsters.

=== killmonsterall ===
<pre>
killmonsterall "mapname";
</pre>
Kill all monsters unconditionally.

This command might prevent monsters from respawning. Instead use "killmonster" with "event" == "All".

=== enablenpc ===
<pre>
enablenpc "name";
</pre>
Enable an NPC.

=== disablenpc ===
<pre>
disablenpc "name";
</pre>
Disable an NPC.

=== hideoffnpc ===
<pre>
hideoffnpc "name";
</pre>
What does this do?

=== hideonnpc ===
<pre>
hideonnpc "name";
</pre>
What does this do?

=== setmapflagnosave ===
<pre>
setmapflagnosave "mapname", "savemap", x, y;
</pre>
Set the nosave flag and respawn location.

=== setmapflag ===
<pre>
setmapflag "mapname", flag;
</pre>
Set an arbitrary mapflag.

=== removemapflag ===
<pre>
removemapflag "mapname", flag;
</pre>
Unset an arbitrary mapflag.

=== getmapflag ===
<pre>
getmapflag("mapname", flag);
</pre>
Check an arbitrary mapflag.

=== pvpon ===
<pre>
pvpon "mapname";
</pre>
Allow PvP on a map.

=== pvpoff ===
<pre>
pvpoff "mapname";
</pre>
Deny PvP on a map.

=== emotion ===
<pre>
emotion emote_index;
</pre>
Show a smiley above the OID.

=== getspellinvocation ===
<pre>
getspellinvocation("spell-identifier")
</pre>
Return the #invocation used for a spell, or "...".

=== getanchorinvocation ===
<pre>
getanchorinvocation "anchor-identifier"
</pre>
Return the invocation used for a teleport anchor (?)

=== strmobinfo ===
<pre>
strmobinfo(num, class)
</pre>
Info about a type of mob:
num==1: name
num==2: jname
num==3: lv
num==4: maxhp
num==5: maxsp
num==6: base_exp
num==7: job_exp

Note that only types 1 and 2 actually return strings, the rest return integers

=== specialeffect ===
<pre>
specialeffect type;
</pre>
Display a special effect on the OID.

Same as "misceffect", but does not fallback when there is no OID.

=== specialeffect2 ===
<pre>
specialeffect2 type;
</pre>
Same as "misceffect", but works when there is an OID.

=== gmcommand ===
<pre>
gmcommand "@command maybe with arguments";
</pre>
Run a GM command, at level 99.

Archive:Setting up tmwAthena on Windows

2013-02-17T11:27:31Z

Jenalya: /* The Setup */ Update server-repo url from gitorious to github.

[[category:reference]]
Last updated By DJDrift2222 on 3/3/2012
==The Setup==
This article describes how to set up eAthena on a Windows system. There is also an article about [[setting up eAthena on Linux]].

# Download Cygwin from http://www.cygwin.com/
# Find something to keep you busy, because the next step will take a while
# Install Cygwin. Select "install from Internet" as download source. When you are on the component select screen make sure the component category "devel" is installed. You technically need not everything from this group but a lot. So just install the whole group.
# Start Cygwin
# Enter '''ln -s flex /usr/bin/lex''' This is to get the Flex commands ready for use they are not active at first...
# Browse to the directory where you would like to have eAthena. When you want it in c:/tmw, for example, the command would be '''cd /cygdrive/c/tmw/''' (directory must exist. when it does not you can create it with '''mkdir /cygdrive/c/tmw/''')
# Enter '''git clone git://github.com/themanaworld/tmwa.git eathena''' to download the most recent sourcecode of the server.
[http://i95.photobucket.com/albums/l122/silentdimes/step1.jpg What you should have so far]
# Enter '''git clone --recursive git://github.com/themanaworld/tmwa-server-data.git eathena-data''' to download the most recent game content for the server.
[http://i95.photobucket.com/albums/l122/silentdimes/step2.jpg Image for this step]
# Enter '''cd eathena''' to browse into the newly created eathena directory
# Enter '''make''' to compile the sourcecode.
[http://i95.photobucket.com/albums/l122/silentdimes/step3.jpg Step 1 of Make]
[http://i95.photobucket.com/albums/l122/silentdimes/step4.jpg Step 2 of Make]
[http://i95.photobucket.com/albums/l122/silentdimes/step5.jpg Step 3 of Make]
[http://i95.photobucket.com/albums/l122/silentdimes/step6.jpg Step 4 of Make]
[http://i95.photobucket.com/albums/l122/silentdimes/step7.jpg Step 5 of Make]
# Enter '''cp login-server char-server map-server ladmin /usr/local/bin/'''
# Enter '''cd ../eathena-data'''
# Enter '''ln -s ../../git/hooks/post-merge .git/hooks/'''
# Enter '''ln -s ../../../git/hooks/post-merge client-data/.git/hooks/'''
[http://i95.photobucket.com/albums/l122/silentdimes/step8.jpg Up to this point]
# Enter '''make conf'''
# Enter '''cd client-data'''
[http://i95.photobucket.com/albums/l122/silentdimes/step9.jpg what you should have up to this point]
# Enter '''git checkout master'''
# Enter '''cd music'''
# Enter '''git checkout master'''
[http://i95.photobucket.com/albums/l122/silentdimes/step10.jpg Last Image for these Steps]
# Copy cygwin1.dll and cygz.dll into the eathena directory. You find them in the subdirectory /bin of your cygwin installation.

==Testing your server==
Now you can close that terminal and open a new one
# Open a terminal
# Enter '''cd ~/tmw-ea/eathena-data/'''
# Enter '''./char-server& ./login-server& ./map-server&'''
When one of them closes immediately after you start it you should try to start it from the command prompt to see the error messages before the window closes.

You should now be able to connect to your server by starting your TMW client and entering "127.0.0.1" as server. Before you announce your server publically for others to play on you should change the server account passwords in accounts.txt, conf/char_local.conf and conf/map_local.conf to avoid abuse. Register a new character through your client to confirm if everything is working properly.

Classic:TmwAthena Scripting Standards

2013-02-12T21:22:32Z

Jenalya: /* Labels and Subfunctions */

This is an attempt to standardize the eAthena coding. Any suggestions are welcome to be posted on the discussion page before editing.
=Code Formatting=
== Indentation ==
* Code is indented with four spaces.
* Code in the same block should have the same indentation.
* Labels have no indentation.
* Menu options are on their own lines and are indented further.
Example:
menu
"Yes.", L_Yes,
"No.", L_No;
* When using an if-statement, there should be a line break after the condition and the conditional command should be indented further. An exception to this is a series of if-statements at the beginning of a major code block which use gotos to jump to the correct position in the script. In this case the goto should be in the same line as the if-statement.
Example:
// if-statement and conditional command in the same line, gotos aligned
if (@quest >= 3) goto L_Done;
if (@quest == 2) goto L_Progress;
if (@quest == 1) goto L_Question;

// conditional command in the next line and indented further
if (BaseLevel < 40)
set @cost, 100;

== Whitespaces==
In many places whitespaces can increase readability. Examples are
* When concatenating text and variables:
mes "\"Hello " + strcharinfo(0) + "!\"";
instead of
mes "\"Hello "+strcharinfo(0)+"!\"";
* When assigning values to variables:
set @var, 3;
instead of
set @var,3;
* In menus:
menu
"Yes.", L_Yes,
"No.", L_No;
instead of
menu
"Yes.",L_Yes,
"No.",L_No;

== Code Blocks ==
* Code blocks should be separated from the others in a dinstinct way: insert a blank line between code blocks.
* Individual blocks should be together No blank lines within a block.
* The opening brackets should be at the end of the parent line, not in a new line; the closing ones should be in a line of their own.

==Labels and Subfunctions==
* Labels should be named in this way: L_CamelCase
* Subfunctions should be named in this way: S_CamelCase
* Labels should always start with L_, except those that act as a subfunction, which should start with S_
* Newline before every label
* No newline after a label
* There must not be a fallthrough or goto to a subfunction label.
* A subfunction label must not goto a normal label. It may, however, goto another label that is specific to that subfunction, and eventually reach a return.

==Comments==
At the beginning of a script file there should be documented
* who is the author
* the purpose of the script
* which variables are used and what's their purpose
* any additional information that can help to understand the script
Example:
// Author: devxy
// This file contains the NPC John, who is part of the Example quest.
// Quest states are saved in Quest_Example.
// State 1: started the quest
// State 2: did the next step
[...]

Within the script there should be comments if there are parts which might be difficult to understand.

In some of the older scripts there are boxed comments used like this:
//#################################################################################
//# NPC John - By Smith #
//# #
//# ... #
//#################################################################################
Don't use them in new scripts.

=Variables=
==Document Variables==
in every file, document every variable as one of:

* # account variable (prefix #) (note that there are also ## variable which didn't work in the stable version of the server)
* permanent player variable (no prefix)
* @ temporary player variable (prefix @) - used after the script close;s or end;s.
* @ dynamic player variable (prefix @) - passed into or out of callsub or callfunc
* @ lexical (local) player variable (prefix @) - used only within the function (scripthelp.txt documents that ".@" means this but I don't know if that works)
* @ local constant (prefix @) - not dependent on the player, used only within the function. e.g. lots of @QUEST_FOO_{SHIFT,MASK}
* $ global permanent variable (prefix $) (I'm not sure if we have any of these right now)
* $ npc permanent variable (prefix $) same as above but only used by one NPC
* $ global temporary variable (prefix $@)
* $@ npc temporary variable (prefix $@) same as above but only used by one NPC, scripthelp.txt mentions prefix "." but I don't know if that works
* special variable (in db/const.txt with a 1 following)
* global constant (in const.txt)

'''If we use a consistent method of documenting these, we can then generate a list of all variables by type.'''

==Variables initialization==
Check for troublesome arrays:
A troublesome array is defined as an array that is not
*initialized all at once
*initialized by appending elements to the end, for use in a menu
Nothing needs to be done, merely document them. I want this information at hand when I design the new scripting language to minimize conversion pains.
I wouldn't be surprised if there were no troublesome arrays at all. If there are only a couple it might be worth refactoring the code to remove them, but that might be a high-level decision which is beyond the scope of this proposal.

Set dynamic and local @variables to 0 before close;
==Naming Variables==

==Using as little variables as you need==
So there are some quests, which require lots of variables.
Think of monster oil quest, Oric and Warum quest etc.

This can often be done by bitmasking:
One variable has 32 bits. So a variabe can store 2^32 different numbers: 4294967296

But sometimes you only need numbers from 0 to 15, but more of these variables.
but numbers in range 0 to 15 can be stored in 4 bits ( 2^4 = 16 different numbers)

Here is an example how to use bitmasking:
[[Media:Tester.txt]]
== Defining Map Objects ==

These sections describe how to define map objects.

=== Warp Definitions ===
'''Shouldn't be done manually.'''
Warps are what move players between maps. They can also be used to move players around a single map, if needed. Warps are defined like this:

map1,startX,startY|warp|name|width,height,map2,endX,endY

Key:
{|
|map1 ||the starting map
|-
|startX||the x-coordinate of the starting warp tile
|-
|startY||the y-coordinate of the starting warp tile
|-
|name ||the name of the warp, unused but must be defined
|-
|width ||the width of the warp
|-
|height||the height of the warp
|-
|map2 ||the ending map
|-
|endX ||the x-coordinate of the tile the player will end up on
|-
|endY ||the y-coordinate of the tile the player will end up on
|}

Width and height are described in detail here: [[EAthena Scripting Standards/Warp Details|Warp Details]].

=== Monster Definitions ===
'''Shouldn't be done manually.'''
Monsters are defined like this:

<map name>,<x>,<y>,<width>,<height>|monster|<name>|<mobID>,<count>,<spawn1>,<spawn2>,{<eventcode>}

{|
|map name ||the map the monsters should appear on
|-
|x ||the x-coordinate of the spawn tile
|-
|y ||the y-coordinate of the spawn tile
|-
|width ||the tile width of the spawn area
|-
|height ||the tile height of the spawn area
|-
|name ||the name of the mob, unused but must be defined. '''DO NOT''' use the keywords such as "spawn" in this name to avoid conflict with other game systems (magic for example)
|-
|mobID ||the mob identifier of the desired monster (in the monster db)the number to spawn
|-
|count ||the number to spawn
|-
|spawn1 ||the minimum delay between successive spawns (per individual)
|-
|spawn2 ||the minimum delay between death and respawn (per individual)
|-
|eventcode ||the script event to fire upon death
|}
A detailed description of position and area can be found here: [[EAthena Scripting Standards/Mob Details|Mob Details]].

=== NPC Definitions ===
<map name>,<x>,<y>,<facing>|script|<Name>|<spriteID>,<nowiki>{<code>}</nowiki>
<map name>,<x>,<y>,<facing>|script|<Name>|<spriteID>,<triggerX>,<triggerY>,<nowiki>{<code>}</nowiki>

{|
|map name ||the map the monsters should appear on
|-
|x ||the x-coordinate of the spawn tile
|-
|y ||the y-coordinate of the spawn tile
|-
|facing ||Direction the NPC faces to. '''It must be set to 0''' in TMW
|-
|height ||the tile height of the spawn area
|-
|Name ||the name of the NPC
|-
|spriteID ||the mob identifier of the desired NPC. Sprite ID
|-
|triggerX ||
|-
|triggerY ||
|-
|eventcode ||the script event to fire upon death
|}
* Server side :
::NPC definitions (script) are usually stored as : (tmwa-server-data/)world/map/npc/<map name>/<NPC Name>.txt or in the file : (tmwa-server-data/)world/map/npc/<map name>/npc.txt
* Client side :
::The NPC is associated with a sprite (the image that will appear in the game), and a XML file which tells the client some display parameters. (tmwa-client-data/)graphics/sprites/npcs/npc-<Name>.png (tmwa-client-data/)graphics/sprites/npcs/npc-<Name>.xml The NPC spriteID is linked to graphic files and XML in the file : (tmwa-client-data/)npcs.xml



== Script Functions ==
function|script|<function name>|<nowiki>{<code>}</nowiki>
Actual script functions are stored or imported in the files : (tmwa-server-data/)world/map/npc/functions/<function name>.txt, regardless rhey are called from a Map, NPC, Mob or item.

==Script Loading==
The main script import file is:[https://github.com/themanaworld/tmwa-server-data/blob/master/world/map/npc/scripts.conf (tmwa-server-data/)world/map/npc/scripts.conf] 
It loads [https://github.com/themanaworld/tmwa-server-data/blob/master/world/map/npc/_import.txt (tmwa-server-data/)world/map/npc/_import.txt] which imports all NPC scripts wich are stored under the respective map name folders, usually under NPC name.

=Examples=
== Open a chest and get reward ==
An example is given by a quest to get a key for a chest (in fact 3 keys):

{| style="width:850px;" border=0 cellspacing="10"
|-valign="Top"
|<pre>
// A treasure chest. You need three keys to open it.
//
// TMW_Quest (document variable here)
//

002-4.gat,93,37,0|script|Treasure|111,{

if (TMW_Quest >= 38) goto L_Finished;

mes "There is a chest here.";
mes "Do you want to try to open it?";
next;
menu
"Yes.", L_Yes,
"No.", -;
close;

L_Yes:
if(countitem("TreasureKey") < 3)
goto L_Not_Enough;
getinventorylist;
if (@inventorylist_count == 100 && countitem("TreasureKey") > 3)
goto L_TooMany;
mes "You opened the chest and found a short bow!";
delitem "TreasureKey", 3;
getitem "ShortBow", 1;
set TMW_Quest, 38;
close;

L_Not_Enough:
mes "It seems that you do not have the right key for this chest yet...";
close;

L_Finished:
mes "You have already opened this chest.";
close;

L_TooMany:
mes "You do not have enough room to loot this chest. Maybe you should try again later.";
close;
}
</pre>
|}
This script starts with describing the NPC (the chest, NPC sprite 111) and its location (map 002-4 X=93, Y=37, in tiles from top left of the map). Then follows what happens on activation:
First, the variable ''"TMW_Quest"'' is checked to know if the player already accomplished the quest '''(the variable should be documented)''', If he has the script continues at label ''L_Finished'', the player is reminded fe alredy accomplished the task and script finishes, if not the scrip continues. A message is shown (mes), then an option dialog (menu) is displayed with two possible answers : "Yes." or "No.". If the player answers "No." the script stops (close;); if he answers "Yes." the script continues at label ''L_Yes''. Now player is checked to know if he has at least 3 keys, if not script branches to label ''L_Not_Enough'' tells the player he "has not the right key" and script closes. If he has keys enough, his inventory list is retrieved by the built-in function "getinventorylist" and it's content is checked to know if the player will have room enough to store the reward after the 3 keys use. If not, script goes to label ''L_TooMany'' and script close after a warning message, If yes 3 keys are deleted in player's inventory, he gets the reward: a Short Bow and the variable TMW_Quest is set to 38.

For more examples of the current system, check out the current scripts in use by the server. Beware though, this could affect your enjoyment of the game as it does spoil some of the mystery. Here's a link to git so you can view them in your browser:

https://github.com/themanaworld/tmwa-server-data/tree/master/world/map/npc

Note that anything said by an NPC should be put in double quotes ("). You can do that like this: "'''\"'''Hello!'''\"''' she said."
=References=
* [[EAthena Scripting Basics]]
* [[EAthena Scripting Reference]]
* [http://forums.themanaworld.org/viewtopic.php?f=13&t=13653 script cleanup/scripting standards proposal]

Development:Guidelines

2013-01-26T09:36:17Z

Jenalya: /* General */ Remove the request to use Mantis, as it isn't in use anymore.

{{Status_green}}
When creating pixel art for TMW, please make sure to follow these guidelines. Pixel art which does not will have a much-lessened chance of getting into the game.

=== General ===
* All graphics '''must''' be released under the GNU General Public License or a compatible license.
* Try to hang around in our development IRC channel #tmw-dev on [irc://irc.themanaworld.org irc.themanaworld.org] whenever possible.
* Do not be afraid to show us your pixel art, we are here to guide and help you. Pixel art being worked on (Usually tagged with [WIP], for work in progress) can be posted on the [http://forums.themanaworld.org/viewforum.php?f=8 forums].
* The pixel art '''must''' be made by you or derived from TMW's existing graphics. We will never accept pixel art ripped from other games nor from undisclosed sources.
* The following games can be used as inspiration:
**Secret of Mana 2
**Final Fantasy VI (Named Final Fantasy III in North America)
**Chrono Trigger
**Ragnarok Online

=== General Guidelines ===
* Light Source: Above, from South-West. For tilesets, this roughly means from the bottom-left corner; for items, the top-left. ([[:Image:Lightdirection.png|Example]])
* Perspective: top-down 45° view angle. ([[:Image:Perspective_Reference.png|Example]])
* Dyeable Images: Images can be dyed, see [[Image dyeing]] for more information
* Outlines: 1px, coloured. We use 3 kinds of different outlines:
**Ground level: should have the dullest colors (no outlines everything blends into each other) ([[:Image:Outlines_ground.png|Example]])
**Objects level: stands out from the ground level (with more contrast and maybe even a light outline)
**Sprites (characters, monsters etc.) and item icons level: stands out the most (heavily saturated with dark outlines)
** Objects should be fully lit ([[:Image:Lighting fill.png|Example]])
* Wind Direction: From West to East
* Proportions: A character is approximately one tile wide (32px) and two tiles high (64px) ([[:Image:Size.png|Example]])
* Drop Shadows:
**Large objects on outdoor tilesets have a drop shadow to the northeast
**Flying creatures have a drop shadow ([[:Image:Dropshadow.png|Example]])
**Shadows should be pure black (#000000), and have a opacity of 30%, the edges have a opacity of 15%
* Anti-aliasing: Only if it does not look smooth without it
* Blood: May only be used if it spice up certain environments that needs to be extra creepy. ([[:Image:No_blood_new.png|Example]])

=== Creatures ===
[[Monsterset development]]
* Mirroring the shape of a sprite is acceptable, provided the shading is correct on each frame.
* There is no size restriction, although the "attackable" area of a monster is only 1*1 tile.

=== Icons ===
[[User:EJlol/Guidelines/Icon examples|Icon Development]]
* Use other icons as examples if possible ([[:Image:Icons.png|Example]])

=== NPCs ===
* NPCs must be in the same style as the player sprites.
** NPCs do not and should not be constrained by player pose and body shape.
** Shadows should NOT be used for NPCs, shadows are reserved for large objects or flying creatures.

=== Tilesets ===
[[Tileset development]]
* All tilesets should have the same amount of texture. Use the [http://gitorious.org/tmwdata/mainline/blobs/master/graphics/tiles/Forest.png New Forest Tileset] as reference
* Do not use visible outlines
* Do not use vanishing point projection. All objects have to be drawn in zero-point perspective ([[:Image:Vanishing point perspective.png|Example]])
* Use pure black (#000000) for "nothing"; eg, the tiles surrounding indoor or dungeon areas.
* Try to match the brightness and contrast of the reference tileset
** Outdoor: Woodland tileset
** Indoor: Woodland Indoor tileset
** Dungeons: Cave tileset
* All tiles on a single tileset should have the same warmth to them, unless it should specifically be otherwise.
* When adding to an existing tileset, try to use the same colours as much as possible to get the same feeling

== How to get your content in to the game ==

*Start a thread in the [http://forums.themanaworld.org/viewforum.php?f=18 forum], with a subject line beginning [WIP] (work in progress).
*Discuss it and edit it a few times until it's ready.
*Change the [WIP] thread's title to [WIP]>[FND] (finished), and make it clear which is the final version.
*Wait for the thread to marked [RC] (release candidate) by a developer and then pushed and marked [GIT] by another. Your work will then be included in the next update.

== Tutorials ==
If you are not very experienced at creating pixel art, you should take a look at the following tutorials. You can learn many interesting tricks from them.

*[http://www.petesqbsite.com/sections/tutorials/tuts/tsugumo/ So You Want To Be A Pixel Artist by Tsugumo].
*[http://www.natomic.com/hosted/marks/mpat/ Mark's Pixel Art Tutorial]
*[http://www.derekyu.com/?page_id=218 Derek Yu's Pixel Art Tutorial]
*[http://pixel-zone.rpgdx.net/shtml/tutorials.shtml Pixel-Zone Tutorials]
*[http://www.pixeljoint.com/pixels/links.asp?id=2192 Pixel Art Links]
*[http://mruk.wordpress.com/2008/04/06/the-mana-world-pixelart-tutorial-desert-well/ Mruk's Desert Well Tutorial]
* [http://mruk.wordpress.com/2009/03/12/the-mana-world-tutorial-challanging-an-imposible-shape/ Mruk's Impossible Shape Design Tutorial]

Classic:TmwAthena Scripting Standards

2013-01-04T16:06:03Z

Jenalya:

This is an attempt to standardize the eAthena coding. Any suggestions are welcome to be posted on the discussion page before editing.
=Code Formatting=
== Indentation ==
* Code is indented with four spaces.
* Code in the same block should have the same indentation.
* Labels have no indentation.
* Menu options are on their own lines and are indented further.
Example:
menu
"Yes.", L_Yes,
"No.", L_No;
* When using an if-statement, there should be a line break after the condition and the conditional command should be indented further. An exception to this is a series of if-statements at the beginning of a major code block which use gotos to jump to the correct position in the script. In this case the goto should be in the same line as the if-statement.
Example:
// if-statement and conditional command in the same line, gotos aligned
if (@quest >= 3) goto L_Done;
if (@quest == 2) goto L_Progress;
if (@quest == 1) goto L_Question;

// conditional command in the next line and indented further
if (BaseLevel < 40)
set @cost, 100;

== Whitespaces==
In many places whitespaces can increase readability. Examples are
* When concatenating text and variables:
mes "\"Hello " + strcharinfo(0) + "!\"";
instead of
mes "\"Hello "+strcharinfo(0)+"!\"";
* When assigning values to variables:
set @var, 3;
instead of
set @var,3;
* In menus:
menu
"Yes.", L_Yes,
"No.", L_No;
instead of
menu
"Yes.",L_Yes,
"No.",L_No;

== Code Blocks ==
* Code blocks should be separated from the others in a dinstinct way: insert a blank line between code blocks.
* Individual blocks should be together No blank lines within a block.
* The opening brackets should be at the end of the parent line, not in a new line; the closing ones should be in a line of their own.

==Labels and Subfunctions==
* Newline before every label
* No newline after a label
* Labels should always start with L_, except those that act as a subfunction, which should start with S_. There must not be a fallthrough or goto to a subfunction label.
* Lables should be named in this way: L_CamelCase
* Subfunctions should be named in this way: S_CamelCase

==Comments==
At the beginning of a script file there should be documented
* who is the author
* the purpose of the script
* which variables are used and what's their purpose
* any additional information that can help to understand the script
Example:
// Author: devxy
// This file contains the NPC John, who is part of the Example quest.
// Quest states are saved in Quest_Example.
// State 1: started the quest
// State 2: did the next step
[...]

Within the script there should be comments if there are parts which might be difficult to understand.

In some of the older scripts there are boxed comments used like this:
//#################################################################################
//# NPC John - By Smith #
//# #
//# ... #
//#################################################################################
Don't use them in new scripts.

=Variables=
==Document Variables==
in every file, document every variable as one of:

* # account variable (prefix #) (note that there are also ## variable which didn't work in the stable version of the server)
* permanent player variable (no prefix)
* @ temporary player variable (prefix @) - used after the script close;s or end;s.
* @ dynamic player variable (prefix @) - passed into or out of callsub or callfunc
* @ lexical (local) player variable (prefix @) - used only within the function (scripthelp.txt documents that ".@" means this but I don't know if that works)
* @ local constant (prefix @) - not dependent on the player, used only within the function. e.g. lots of @QUEST_FOO_{SHIFT,MASK}
* $ global permanent variable (prefix $) (I'm not sure if we have any of these right now)
* $ npc permanent variable (prefix $) same as above but only used by one NPC
* $ global temporary variable (prefix $@)
* $@ npc temporary variable (prefix $@) same as above but only used by one NPC, scripthelp.txt mentions prefix "." but I don't know if that works
* special variable (in db/const.txt with a 1 following)
* global constant (in const.txt)

'''If we use a consistent method of documenting these, we can then generate a list of all variables by type.'''

==Variables initialization==
Check for troublesome arrays:
A troublesome array is defined as an array that is not
*initialized all at once
*initialized by appending elements to the end, for use in a menu
Nothing needs to be done, merely document them. I want this information at hand when I design the new scripting language to minimize conversion pains.
I wouldn't be surprised if there were no troublesome arrays at all. If there are only a couple it might be worth refactoring the code to remove them, but that might be a high-level decision which is beyond the scope of this proposal.

Set dynamic and local @variables to 0 before close;
==Naming Variables==

==Using as little variables as you need==
So there are some quests, which require lots of variables.
Think of monster oil quest, Oric and Warum quest etc.

This can often be done by bitmasking:
One variable has 32 bits. So a variabe can store 2^32 different numbers: 4294967296

But sometimes you only need numbers from 0 to 15, but more of these variables.
but numbers in range 0 to 15 can be stored in 4 bits ( 2^4 = 16 different numbers)

Here is an example how to use bitmasking:
[[Media:Tester.txt]]
== Defining Map Objects ==

These sections describe how to define map objects.

=== Warp Definitions ===
'''Shouldn't be done manually.'''
Warps are what move players between maps. They can also be used to move players around a single map, if needed. Warps are defined like this:

map1,startX,startY|warp|name|width,height,map2,endX,endY

Key:
{|
|map1 ||the starting map
|-
|startX||the x-coordinate of the starting warp tile
|-
|startY||the y-coordinate of the starting warp tile
|-
|name ||the name of the warp, unused but must be defined
|-
|width ||the width of the warp
|-
|height||the height of the warp
|-
|map2 ||the ending map
|-
|endX ||the x-coordinate of the tile the player will end up on
|-
|endY ||the y-coordinate of the tile the player will end up on
|}

Width and height are described in detail here: [[EAthena Scripting Standards/Warp Details|Warp Details]].

=== Monster Definitions ===
'''Shouldn't be done manually.'''
Monsters are defined like this:

<map name>,<x>,<y>,<width>,<height>|monster|<name>|<mobID>,<count>,<spawn1>,<spawn2>,{<eventcode>}

{|
|map name ||the map the monsters should appear on
|-
|x ||the x-coordinate of the spawn tile
|-
|y ||the y-coordinate of the spawn tile
|-
|width ||the tile width of the spawn area
|-
|height ||the tile height of the spawn area
|-
|name ||the name of the mob, unused but must be defined. '''DO NOT''' use the keywords such as "spawn" in this name to avoid conflict with other game systems (magic for example)
|-
|mobID ||the mob identifier of the desired monster (in the monster db)the number to spawn
|-
|count ||the number to spawn
|-
|spawn1 ||the minimum delay between successive spawns (per individual)
|-
|spawn2 ||the minimum delay between death and respawn (per individual)
|-
|eventcode ||the script event to fire upon death
|}
A detailed description of position and area can be found here: [[EAthena Scripting Standards/Mob Details|Mob Details]].

=== NPC Definitions ===
<map name>,<x>,<y>,<facing>|script|<Name>|<spriteID>,<nowiki>{<code>}</nowiki>
<map name>,<x>,<y>,<facing>|script|<Name>|<spriteID>,<triggerX>,<triggerY>,<nowiki>{<code>}</nowiki>

{|
|map name ||the map the monsters should appear on
|-
|x ||the x-coordinate of the spawn tile
|-
|y ||the y-coordinate of the spawn tile
|-
|facing ||Direction the NPC faces to. '''It must be set to 0''' in TMW
|-
|height ||the tile height of the spawn area
|-
|Name ||the name of the NPC
|-
|spriteID ||the mob identifier of the desired NPC. Sprite ID
|-
|triggerX ||
|-
|triggerY ||
|-
|eventcode ||the script event to fire upon death
|}
* Server side :
::NPC definitions (script) are usually stored as : (tmwa-server-data/)world/map/npc/<map name>/<NPC Name>.txt or in the file : (tmwa-server-data/)world/map/npc/<map name>/npc.txt
* Client side :
::The NPC is associated with a sprite (the image that will appear in the game), and a XML file which tells the client some display parameters. (tmwa-client-data/)graphics/sprites/npcs/npc-<Name>.png (tmwa-client-data/)graphics/sprites/npcs/npc-<Name>.xml The NPC spriteID is linked to graphic files and XML in the file : (tmwa-client-data/)npcs.xml



== Script Functions ==
function|script|<function name>|<nowiki>{<code>}</nowiki>
Actual script functions are stored or imported in the files : (tmwa-server-data/)world/map/npc/functions/<function name>.txt, regardless rhey are called from a Map, NPC, Mob or item.

==Script Loading==
The main script import file is:[https://github.com/themanaworld/tmwa-server-data/blob/master/world/map/npc/scripts.conf (tmwa-server-data/)world/map/npc/scripts.conf] 
It loads [https://github.com/themanaworld/tmwa-server-data/blob/master/world/map/npc/_import.txt (tmwa-server-data/)world/map/npc/_import.txt] which imports all NPC scripts wich are stored under the respective map name folders, usually under NPC name.

=Examples=
== Open a chest and get reward ==
An example is given by a quest to get a key for a chest (in fact 3 keys):

{| style="width:850px;" border=0 cellspacing="10"
|-valign="Top"
|<pre>
// A treasure chest. You need three keys to open it.
//
// TMW_Quest (document variable here)
//

002-4.gat,93,37,0|script|Treasure|111,{

if (TMW_Quest >= 38) goto L_Finished;

mes "There is a chest here.";
mes "Do you want to try to open it?";
next;
menu
"Yes.", L_Yes,
"No.", -;
close;

L_Yes:
if(countitem("TreasureKey") < 3)
goto L_Not_Enough;
getinventorylist;
if (@inventorylist_count == 100 && countitem("TreasureKey") > 3)
goto L_TooMany;
mes "You opened the chest and found a short bow!";
delitem "TreasureKey", 3;
getitem "ShortBow", 1;
set TMW_Quest, 38;
close;

L_Not_Enough:
mes "It seems that you do not have the right key for this chest yet...";
close;

L_Finished:
mes "You have already opened this chest.";
close;

L_TooMany:
mes "You do not have enough room to loot this chest. Maybe you should try again later.";
close;
}
</pre>
|}
This script starts with describing the NPC (the chest, NPC sprite 111) and its location (map 002-4 X=93, Y=37, in tiles from top left of the map). Then follows what happens on activation:
First, the variable ''"TMW_Quest"'' is checked to know if the player already accomplished the quest '''(the variable should be documented)''', If he has the script continues at label ''L_Finished'', the player is reminded fe alredy accomplished the task and script finishes, if not the scrip continues. A message is shown (mes), then an option dialog (menu) is displayed with two possible answers : "Yes." or "No.". If the player answers "No." the script stops (close;); if he answers "Yes." the script continues at label ''L_Yes''. Now player is checked to know if he has at least 3 keys, if not script branches to label ''L_Not_Enough'' tells the player he "has not the right key" and script closes. If he has keys enough, his inventory list is retrieved by the built-in function "getinventorylist" and it's content is checked to know if the player will have room enough to store the reward after the 3 keys use. If not, script goes to label ''L_TooMany'' and script close after a warning message, If yes 3 keys are deleted in player's inventory, he gets the reward: a Short Bow and the variable TMW_Quest is set to 38.

For more examples of the current system, check out the current scripts in use by the server. Beware though, this could affect your enjoyment of the game as it does spoil some of the mystery. Here's a link to git so you can view them in your browser:

https://github.com/themanaworld/tmwa-server-data/tree/master/world/map/npc

Note that anything said by an NPC should be put in double quotes ("). You can do that like this: "'''\"'''Hello!'''\"''' she said."
=References=
* [[EAthena Scripting Basics]]
* [[EAthena Scripting Reference]]
* [http://forums.themanaworld.org/viewtopic.php?f=13&t=13653 script cleanup/scripting standards proposal]

Classic:TmwAthena Scripting Standards

2013-01-03T21:19:57Z

Jenalya: Remove marks about the article being outdated and under construction.

This is an attempt to standardize the eAthena coding. Any suggestions are welcome to be posted on the discussion page before editing.
=Code Formatting=
== Indentation ==
* Code is indented with four spaces.
* Code in the same block should have the same indentation.
* Labels have no indentation.
* Menu options are on their own lines and are indented further.
Example:
menu
"Yes.", L_Yes,
"No.", L_No;
* When using an if-statement, there should be a line break after the condition and the conditional command should be indented further. An exception to this is a series of if-statements at the beginning of a major code block which use gotos to jump to the correct position in the script. In this case the goto should be in the same line as the if-statement.
Example:
// if-statement and conditional command in the same line, gotos aligned
if (@quest >= 3) goto L_Done;
if (@quest == 2) goto L_Progress;
if (@quest == 1) goto L_Question;

// conditional command in the next line and indented further
if (BaseLevel < 40)
set @cost, 100;

== Whitespaces==
In many places whitespaces can increase readability. Examples are
* When concatenating text and variables:
mes "\"Hello " + strcharinfo(0) + "!\"";
instead of
mes "\"Hello "+strcharinfo(0)+"!\"";
* When assigning values to variables:
set @var, 3;
instead of
set @var,3;
* In menus:
menu
"Yes.", L_Yes,
"No.", L_No;
instead of
menu
"Yes.",L_Yes,
"No.",L_No;

== Code Blocks ==
* Code blocks should be separated from the others in a dinstinct way: insert a blank line between code blocks.
* Individual blocks should be together No blank lines within a block.
* The opening brackets should be at the end of the parent line, not in a new line; the closing ones should be in a line of their own.

==Labels and Subfunctions==
* Newline before every label
* No newline after a label
* Labels should always start with L_, except those that act as a subfunction, which should start with S_. There must not be a fallthrough or goto to a subfunction label.
* Lables should be named in this way: L_CamelCase
* Subfunctions should be named in this way: S_CamelCase

==Comments==
At the beginning of a script file there should be documented
* who is the author
* the purpose of the script
* which variables are used and what's their purpose
* any additional information that can help to understand the script
Example:
// Author: devxy
// This file contains the NPC John, who is part of the Example quest.
// Quest states are saved in Quest_Example.
// State 1: started the quest
// State 2: did the next step
[...]

Within the script there should be comments if there are parts which might be difficult to understand.

In some of the older scripts there are boxed comments used like this:
//#################################################################################
//# NPC John - By Smith #
//# #
//# ... #
//#################################################################################
Don't use them in new scripts.

=Variables=
==Document Variables==
in every file, document every variable as one of:

* # account variable (prefix #) (note that there are also ## variable which didn't work in the stable version of the server)
* permanent player variable (no prefix)
* @ temporary player variable (prefix @) - used after the script close;s or end;s.
* @ dynamic player variable (prefix @) - passed into or out of callsub or callfunc
* @ lexical (local) player variable (prefix @) - used only within the function (scripthelp.txt documents that ".@" means this but I don't know if that works)
* @ local constant (prefix @) - not dependent on the player, used only within the function. e.g. lots of @QUEST_FOO_{SHIFT,MASK}
* $ global permanent variable (prefix $) (I'm not sure if we have any of these right now)
* $ npc permanent variable (prefix $) same as above but only used by one NPC
* $ global temporary variable (prefix $@)
* $@ npc temporary variable (prefix $@) same as above but only used by one NPC, scripthelp.txt mentions prefix "." but I don't know if that works
* special variable (in db/const.txt with a 1 following)
* global constant (in const.txt)

'''If we use a consistent method of documenting these, we can then generate a list of all variables by type.'''

==Variables initialization==
Check for troublesome arrays:
A troublesome array is defined as an array that is not
*initialized all at once
*initialized by appending elements to the end, for use in a menu
Nothing needs to be done, merely document them. I want this information at hand when I design the new scripting language to minimize conversion pains.
I wouldn't be surprised if there were no troublesome arrays at all. If there are only a couple it might be worth refactoring the code to remove them, but that might be a high-level decision which is beyond the scope of this proposal.

Set dynamic and local @variables to 0 before close;
==Naming Variables==

==Using as little variables as you need==
So there are some quests, which require lots of variables.
Think of monster oil quest, Oric and Warum quest etc.

This can often be done by bitmasking:
One variable has 32 bits. So a variabe can store 2^32 different numbers: 4294967296

But sometimes you only need numbers from 0 to 15, but more of these variables.
but numbers in range 0 to 15 can be stored in 4 bits ( 2^4 = 16 different numbers)

Here is an example how to use bitmasking:
[[Media:Tester.txt]]
== Defining Map Objects ==

These sections describe how to define map objects.

=== Warp Definitions ===
'''Shouldn't be done manually.'''
Warps are what move players between maps. They can also be used to move players around a single map, if needed. Warps are defined like this:

map1,startX,startY|warp|name|width,height,map2,endX,endY

Key:
{|
|map1 ||the starting map
|-
|startX||the x-coordinate of the starting warp tile
|-
|startY||the y-coordinate of the starting warp tile
|-
|name ||the name of the warp, unused but must be defined
|-
|width ||the width of the warp
|-
|height||the height of the warp
|-
|map2 ||the ending map
|-
|endX ||the x-coordinate of the tile the player will end up on
|-
|endY ||the y-coordinate of the tile the player will end up on
|}

Width and height are described in detail here: [[EAthena Scripting Standards/Warp Details|Warp Details]].

=== Monster Definitions ===
'''Shouldn't be done manually.'''
Monsters are defined like this:

<map name>,<x>,<y>,<width>,<height>|monster|<name>|<mobID>,<count>,<spawn1>,<spawn2>,{<eventcode>}

{|
|map name ||the map the monsters should appear on
|-
|x ||the x-coordinate of the spawn tile
|-
|y ||the y-coordinate of the spawn tile
|-
|width ||the tile width of the spawn area
|-
|height ||the tile height of the spawn area
|-
|name ||the name of the mob, unused but must be defined. '''DO NOT''' use the keywords such as "spawn" in this name to avoid conflict with other game systems (magic for example)
|-
|mobID ||the mob identifier of the desired monster (in the monster db)the number to spawn
|-
|count ||the number to spawn
|-
|spawn1 ||the minimum delay between successive spawns (per individual)
|-
|spawn2 ||the minimum delay between death and respawn (per individual)
|-
|eventcode ||the script event to fire upon death
|}
A detailed description of position and area can be found here: [[EAthena Scripting Standards/Mob Details|Mob Details]].

=== NPC Definitions ===
<map name>,<x>,<y>,<facing>|script|<Name>|<spriteID>,<nowiki>{<code>}</nowiki>
<map name>,<x>,<y>,<facing>|script|<Name>|<spriteID>,<triggerX>,<triggerY>,<nowiki>{<code>}</nowiki>

{|
|map name ||the map the monsters should appear on
|-
|x ||the x-coordinate of the spawn tile
|-
|y ||the y-coordinate of the spawn tile
|-
|facing ||Direction the NPC faces to. '''It must be set to 0''' in TMW
|-
|height ||the tile height of the spawn area
|-
|Name ||the name of the NPC
|-
|spriteID ||the mob identifier of the desired NPC. Sprite ID
|-
|triggerX ||
|-
|triggerY ||
|-
|eventcode ||the script event to fire upon death
|}
* Server side :
::NPC definitions (script) are usually stored as : (tmwa-server-data/)world/map/npc/<map name>/<NPC Name>.txt or in the file : (tmwa-server-data/)world/map/npc/<map name>/npc.txt
* Client side :
::The NPC is associated with a sprite (the image that will appear in the game), and a XML file which tells the client some display parameters. (tmwa-client-data/)graphics/sprites/npcs/npc-<Name>.png (tmwa-client-data/)graphics/sprites/npcs/npc-<Name>.xml The NPC spriteID is linked to graphic files and XML in the file : (tmwa-client-data/)npcs.xml



== Script Functions ==
function|script|<function name>|<nowiki>{<code>}</nowiki>
Actual script functions are stored or imported in the files : (tmwa-server-data/)world/map/npc/functions/<function name>.txt, regardless rhey are called from a Map, NPC, Mob or item.

==Script Loading==
The main script import file is:[https://github.com/themanaworld/tmwa-server-data/blob/master/world/map/npc/scripts.conf (tmwa-server-data/)world/map/npc/scripts.conf] 
It loads [https://github.com/themanaworld/tmwa-server-data/blob/master/world/map/npc/_import.txt (tmwa-server-data/)world/map/npc/_import.txt] which imports all NPC scripts wich are stored under the respective map name folders, usually under NPC name.

=Examples=
== Open a chest and get reward ==
An example is given by a quest to get a key for a chest (in fact 3 keys):

{| style="width:850px;" border=0 cellspacing="10"
|-valign="Top"
|<pre>
// A treasure chest. You need three keys to open it.
//
// TMW_Quest (document variable here)
//

002-4.gat,93,37,0|script|Treasure|111,{

if (TMW_Quest >= 38) goto L_Finished;

mes "There is a chest here.";
mes "Do you want to try to open it?";
next;
menu
"Yes.", L_Yes,
"No.", -;
close;

L_Yes:
if(countitem("TreasureKey") < 3)
goto L_Not_Enough;
getinventorylist;
if (@inventorylist_count == 100 && countitem("TreasureKey") > 3)
goto L_TooMany;
mes "You opened the chest and found a short bow!";
delitem "TreasureKey", 3;
getitem "ShortBow", 1;
set TMW_Quest, 38;
close;

L_Not_Enough:
mes "It seems that you do not have the right key for this chest yet...";
close;

L_Finished:
mes "You have already opened this chest.";
close;

L_TooMany:
mes "You do not have enough room to loot this chest. Maybe you should try again later.";
close;
}
</pre>
|}
This script starts with describing the NPC (the chest, NPC sprite 111) and its location (map 002-4 X=93, Y=37, in tiles from top left of the map). Then follows what happens on activation:
First, the variable ''"TMW_Quest"'' is checked to know if the player already accomplished the quest '''(the variable should be documented)''', If he has the script continues at label ''L_Finished'', the player is reminded fe alredy accomplished the task and script finishes, if not the scrip continues. A message is shown (mes), then an option dialog (menu) is displayed with two possible answers : "Yes." or "No.". If the player answers "No." the script stops (close;); if he answers "Yes." the script continues at label ''L_Yes''. Now player is checked to know if he has at least 3 keys, if not script branches to label ''L_Not_Enough'' tells the player he "has not the right key" and script closes. If he has keys enough, his inventory list is retrieved by the built-in function "getinventorylist" and it's content is checked to know if the player will have room enough to store the reward after the 3 keys use. If not, script goes to label ''L_TooMany'' and script close after a warning message, If yes 3 keys are deleted in player's inventory, he gets the reward: a Short Bow and the variable TMW_Quest is set to 38.

For more examples of the current system, check out the current scripts in use by the server. Beware though, this could affect your enjoyment of the game as it does spoil some of the mystery. Here's a link to git so you can view them in your browser:

https://github.com/themanaworld/tmwa-server-data/tree/master/world/map/npc

Note that anything said by an NPC should be put in double quotes ("). You can do that like this: "'''\"'''Hello!'''\"''' she said."
=References=
* [[EAthena Scripting Basics]]
* [[EAthena Scripting Reference]]
* [http://forums.themanaworld.org/viewtopic.php?f=13&t=13653 script cleanup/scripting standards proposal]

Classic:TmwAthena Scripting Standards

2013-01-03T21:18:48Z

Jenalya: Mark the sections about Warps and Monsters with the note that this shouldn't be done manually.

{{Status_construction}}
{{Status_outdated}}
{{Gaps|Needs to be updated with {{ForumThread|13653}} and {{ForumThread|13672}}, which are generally accepted but there might be more discussion}}

This is an attempt to standardize the eAthena coding. Any suggestions are welcome to be posted on the discussion page before editing.
=Code Formatting=
== Indentation ==
* Code is indented with four spaces.
* Code in the same block should have the same indentation.
* Labels have no indentation.
* Menu options are on their own lines and are indented further.
Example:
menu
"Yes.", L_Yes,
"No.", L_No;
* When using an if-statement, there should be a line break after the condition and the conditional command should be indented further. An exception to this is a series of if-statements at the beginning of a major code block which use gotos to jump to the correct position in the script. In this case the goto should be in the same line as the if-statement.
Example:
// if-statement and conditional command in the same line, gotos aligned
if (@quest >= 3) goto L_Done;
if (@quest == 2) goto L_Progress;
if (@quest == 1) goto L_Question;

// conditional command in the next line and indented further
if (BaseLevel < 40)
set @cost, 100;

== Whitespaces==
In many places whitespaces can increase readability. Examples are
* When concatenating text and variables:
mes "\"Hello " + strcharinfo(0) + "!\"";
instead of
mes "\"Hello "+strcharinfo(0)+"!\"";
* When assigning values to variables:
set @var, 3;
instead of
set @var,3;
* In menus:
menu
"Yes.", L_Yes,
"No.", L_No;
instead of
menu
"Yes.",L_Yes,
"No.",L_No;

== Code Blocks ==
* Code blocks should be separated from the others in a dinstinct way: insert a blank line between code blocks.
* Individual blocks should be together No blank lines within a block.
* The opening brackets should be at the end of the parent line, not in a new line; the closing ones should be in a line of their own.

==Labels and Subfunctions==
* Newline before every label
* No newline after a label
* Labels should always start with L_, except those that act as a subfunction, which should start with S_. There must not be a fallthrough or goto to a subfunction label.
* Lables should be named in this way: L_CamelCase
* Subfunctions should be named in this way: S_CamelCase

==Comments==
At the beginning of a script file there should be documented
* who is the author
* the purpose of the script
* which variables are used and what's their purpose
* any additional information that can help to understand the script
Example:
// Author: devxy
// This file contains the NPC John, who is part of the Example quest.
// Quest states are saved in Quest_Example.
// State 1: started the quest
// State 2: did the next step
[...]

Within the script there should be comments if there are parts which might be difficult to understand.

In some of the older scripts there are boxed comments used like this:
//#################################################################################
//# NPC John - By Smith #
//# #
//# ... #
//#################################################################################
Don't use them in new scripts.

=Variables=
==Document Variables==
in every file, document every variable as one of:

* # account variable (prefix #) (note that there are also ## variable which didn't work in the stable version of the server)
* permanent player variable (no prefix)
* @ temporary player variable (prefix @) - used after the script close;s or end;s.
* @ dynamic player variable (prefix @) - passed into or out of callsub or callfunc
* @ lexical (local) player variable (prefix @) - used only within the function (scripthelp.txt documents that ".@" means this but I don't know if that works)
* @ local constant (prefix @) - not dependent on the player, used only within the function. e.g. lots of @QUEST_FOO_{SHIFT,MASK}
* $ global permanent variable (prefix $) (I'm not sure if we have any of these right now)
* $ npc permanent variable (prefix $) same as above but only used by one NPC
* $ global temporary variable (prefix $@)
* $@ npc temporary variable (prefix $@) same as above but only used by one NPC, scripthelp.txt mentions prefix "." but I don't know if that works
* special variable (in db/const.txt with a 1 following)
* global constant (in const.txt)

'''If we use a consistent method of documenting these, we can then generate a list of all variables by type.'''

==Variables initialization==
Check for troublesome arrays:
A troublesome array is defined as an array that is not
*initialized all at once
*initialized by appending elements to the end, for use in a menu
Nothing needs to be done, merely document them. I want this information at hand when I design the new scripting language to minimize conversion pains.
I wouldn't be surprised if there were no troublesome arrays at all. If there are only a couple it might be worth refactoring the code to remove them, but that might be a high-level decision which is beyond the scope of this proposal.

Set dynamic and local @variables to 0 before close;
==Naming Variables==

==Using as little variables as you need==
So there are some quests, which require lots of variables.
Think of monster oil quest, Oric and Warum quest etc.

This can often be done by bitmasking:
One variable has 32 bits. So a variabe can store 2^32 different numbers: 4294967296

But sometimes you only need numbers from 0 to 15, but more of these variables.
but numbers in range 0 to 15 can be stored in 4 bits ( 2^4 = 16 different numbers)

Here is an example how to use bitmasking:
[[Media:Tester.txt]]
== Defining Map Objects ==

These sections describe how to define map objects.

=== Warp Definitions ===
'''Shouldn't be done manually.'''
Warps are what move players between maps. They can also be used to move players around a single map, if needed. Warps are defined like this:

map1,startX,startY|warp|name|width,height,map2,endX,endY

Key:
{|
|map1 ||the starting map
|-
|startX||the x-coordinate of the starting warp tile
|-
|startY||the y-coordinate of the starting warp tile
|-
|name ||the name of the warp, unused but must be defined
|-
|width ||the width of the warp
|-
|height||the height of the warp
|-
|map2 ||the ending map
|-
|endX ||the x-coordinate of the tile the player will end up on
|-
|endY ||the y-coordinate of the tile the player will end up on
|}

Width and height are described in detail here: [[EAthena Scripting Standards/Warp Details|Warp Details]].

=== Monster Definitions ===
'''Shouldn't be done manually.'''
Monsters are defined like this:

<map name>,<x>,<y>,<width>,<height>|monster|<name>|<mobID>,<count>,<spawn1>,<spawn2>,{<eventcode>}

{|
|map name ||the map the monsters should appear on
|-
|x ||the x-coordinate of the spawn tile
|-
|y ||the y-coordinate of the spawn tile
|-
|width ||the tile width of the spawn area
|-
|height ||the tile height of the spawn area
|-
|name ||the name of the mob, unused but must be defined. '''DO NOT''' use the keywords such as "spawn" in this name to avoid conflict with other game systems (magic for example)
|-
|mobID ||the mob identifier of the desired monster (in the monster db)the number to spawn
|-
|count ||the number to spawn
|-
|spawn1 ||the minimum delay between successive spawns (per individual)
|-
|spawn2 ||the minimum delay between death and respawn (per individual)
|-
|eventcode ||the script event to fire upon death
|}
A detailed description of position and area can be found here: [[EAthena Scripting Standards/Mob Details|Mob Details]].

=== NPC Definitions ===
<map name>,<x>,<y>,<facing>|script|<Name>|<spriteID>,<nowiki>{<code>}</nowiki>
<map name>,<x>,<y>,<facing>|script|<Name>|<spriteID>,<triggerX>,<triggerY>,<nowiki>{<code>}</nowiki>

{|
|map name ||the map the monsters should appear on
|-
|x ||the x-coordinate of the spawn tile
|-
|y ||the y-coordinate of the spawn tile
|-
|facing ||Direction the NPC faces to. '''It must be set to 0''' in TMW
|-
|height ||the tile height of the spawn area
|-
|Name ||the name of the NPC
|-
|spriteID ||the mob identifier of the desired NPC. Sprite ID
|-
|triggerX ||
|-
|triggerY ||
|-
|eventcode ||the script event to fire upon death
|}
* Server side :
::NPC definitions (script) are usually stored as : (tmwa-server-data/)world/map/npc/<map name>/<NPC Name>.txt or in the file : (tmwa-server-data/)world/map/npc/<map name>/npc.txt
* Client side :
::The NPC is associated with a sprite (the image that will appear in the game), and a XML file which tells the client some display parameters. (tmwa-client-data/)graphics/sprites/npcs/npc-<Name>.png (tmwa-client-data/)graphics/sprites/npcs/npc-<Name>.xml The NPC spriteID is linked to graphic files and XML in the file : (tmwa-client-data/)npcs.xml



== Script Functions ==
function|script|<function name>|<nowiki>{<code>}</nowiki>
Actual script functions are stored or imported in the files : (tmwa-server-data/)world/map/npc/functions/<function name>.txt, regardless rhey are called from a Map, NPC, Mob or item.

==Script Loading==
The main script import file is:[https://github.com/themanaworld/tmwa-server-data/blob/master/world/map/npc/scripts.conf (tmwa-server-data/)world/map/npc/scripts.conf] 
It loads [https://github.com/themanaworld/tmwa-server-data/blob/master/world/map/npc/_import.txt (tmwa-server-data/)world/map/npc/_import.txt] which imports all NPC scripts wich are stored under the respective map name folders, usually under NPC name.

=Examples=
== Open a chest and get reward ==
An example is given by a quest to get a key for a chest (in fact 3 keys):

{| style="width:850px;" border=0 cellspacing="10"
|-valign="Top"
|<pre>
// A treasure chest. You need three keys to open it.
//
// TMW_Quest (document variable here)
//

002-4.gat,93,37,0|script|Treasure|111,{

if (TMW_Quest >= 38) goto L_Finished;

mes "There is a chest here.";
mes "Do you want to try to open it?";
next;
menu
"Yes.", L_Yes,
"No.", -;
close;

L_Yes:
if(countitem("TreasureKey") < 3)
goto L_Not_Enough;
getinventorylist;
if (@inventorylist_count == 100 && countitem("TreasureKey") > 3)
goto L_TooMany;
mes "You opened the chest and found a short bow!";
delitem "TreasureKey", 3;
getitem "ShortBow", 1;
set TMW_Quest, 38;
close;

L_Not_Enough:
mes "It seems that you do not have the right key for this chest yet...";
close;

L_Finished:
mes "You have already opened this chest.";
close;

L_TooMany:
mes "You do not have enough room to loot this chest. Maybe you should try again later.";
close;
}
</pre>
|}
This script starts with describing the NPC (the chest, NPC sprite 111) and its location (map 002-4 X=93, Y=37, in tiles from top left of the map). Then follows what happens on activation:
First, the variable ''"TMW_Quest"'' is checked to know if the player already accomplished the quest '''(the variable should be documented)''', If he has the script continues at label ''L_Finished'', the player is reminded fe alredy accomplished the task and script finishes, if not the scrip continues. A message is shown (mes), then an option dialog (menu) is displayed with two possible answers : "Yes." or "No.". If the player answers "No." the script stops (close;); if he answers "Yes." the script continues at label ''L_Yes''. Now player is checked to know if he has at least 3 keys, if not script branches to label ''L_Not_Enough'' tells the player he "has not the right key" and script closes. If he has keys enough, his inventory list is retrieved by the built-in function "getinventorylist" and it's content is checked to know if the player will have room enough to store the reward after the 3 keys use. If not, script goes to label ''L_TooMany'' and script close after a warning message, If yes 3 keys are deleted in player's inventory, he gets the reward: a Short Bow and the variable TMW_Quest is set to 38.

For more examples of the current system, check out the current scripts in use by the server. Beware though, this could affect your enjoyment of the game as it does spoil some of the mystery. Here's a link to git so you can view them in your browser:

https://github.com/themanaworld/tmwa-server-data/tree/master/world/map/npc

Note that anything said by an NPC should be put in double quotes ("). You can do that like this: "'''\"'''Hello!'''\"''' she said."
=References=
* [[EAthena Scripting Basics]]
* [[EAthena Scripting Reference]]
* [http://forums.themanaworld.org/viewtopic.php?f=13&t=13653 script cleanup/scripting standards proposal]

Classic:TmwAthena Scripting Standards

2013-01-03T21:15:01Z

Jenalya: Fix indentation of if-statements in example script.

{{Status_construction}}
{{Status_outdated}}
{{Gaps|Needs to be updated with {{ForumThread|13653}} and {{ForumThread|13672}}, which are generally accepted but there might be more discussion}}

This is an attempt to standardize the eAthena coding. Any suggestions are welcome to be posted on the discussion page before editing.
=Code Formatting=
== Indentation ==
* Code is indented with four spaces.
* Code in the same block should have the same indentation.
* Labels have no indentation.
* Menu options are on their own lines and are indented further.
Example:
menu
"Yes.", L_Yes,
"No.", L_No;
* When using an if-statement, there should be a line break after the condition and the conditional command should be indented further. An exception to this is a series of if-statements at the beginning of a major code block which use gotos to jump to the correct position in the script. In this case the goto should be in the same line as the if-statement.
Example:
// if-statement and conditional command in the same line, gotos aligned
if (@quest >= 3) goto L_Done;
if (@quest == 2) goto L_Progress;
if (@quest == 1) goto L_Question;

// conditional command in the next line and indented further
if (BaseLevel < 40)
set @cost, 100;

== Whitespaces==
In many places whitespaces can increase readability. Examples are
* When concatenating text and variables:
mes "\"Hello " + strcharinfo(0) + "!\"";
instead of
mes "\"Hello "+strcharinfo(0)+"!\"";
* When assigning values to variables:
set @var, 3;
instead of
set @var,3;
* In menus:
menu
"Yes.", L_Yes,
"No.", L_No;
instead of
menu
"Yes.",L_Yes,
"No.",L_No;

== Code Blocks ==
* Code blocks should be separated from the others in a dinstinct way: insert a blank line between code blocks.
* Individual blocks should be together No blank lines within a block.
* The opening brackets should be at the end of the parent line, not in a new line; the closing ones should be in a line of their own.

==Labels and Subfunctions==
* Newline before every label
* No newline after a label
* Labels should always start with L_, except those that act as a subfunction, which should start with S_. There must not be a fallthrough or goto to a subfunction label.
* Lables should be named in this way: L_CamelCase
* Subfunctions should be named in this way: S_CamelCase

==Comments==
At the beginning of a script file there should be documented
* who is the author
* the purpose of the script
* which variables are used and what's their purpose
* any additional information that can help to understand the script
Example:
// Author: devxy
// This file contains the NPC John, who is part of the Example quest.
// Quest states are saved in Quest_Example.
// State 1: started the quest
// State 2: did the next step
[...]

Within the script there should be comments if there are parts which might be difficult to understand.

In some of the older scripts there are boxed comments used like this:
//#################################################################################
//# NPC John - By Smith #
//# #
//# ... #
//#################################################################################
Don't use them in new scripts.

=Variables=
==Document Variables==
in every file, document every variable as one of:

* # account variable (prefix #) (note that there are also ## variable which didn't work in the stable version of the server)
* permanent player variable (no prefix)
* @ temporary player variable (prefix @) - used after the script close;s or end;s.
* @ dynamic player variable (prefix @) - passed into or out of callsub or callfunc
* @ lexical (local) player variable (prefix @) - used only within the function (scripthelp.txt documents that ".@" means this but I don't know if that works)
* @ local constant (prefix @) - not dependent on the player, used only within the function. e.g. lots of @QUEST_FOO_{SHIFT,MASK}
* $ global permanent variable (prefix $) (I'm not sure if we have any of these right now)
* $ npc permanent variable (prefix $) same as above but only used by one NPC
* $ global temporary variable (prefix $@)
* $@ npc temporary variable (prefix $@) same as above but only used by one NPC, scripthelp.txt mentions prefix "." but I don't know if that works
* special variable (in db/const.txt with a 1 following)
* global constant (in const.txt)

'''If we use a consistent method of documenting these, we can then generate a list of all variables by type.'''

==Variables initialization==
Check for troublesome arrays:
A troublesome array is defined as an array that is not
*initialized all at once
*initialized by appending elements to the end, for use in a menu
Nothing needs to be done, merely document them. I want this information at hand when I design the new scripting language to minimize conversion pains.
I wouldn't be surprised if there were no troublesome arrays at all. If there are only a couple it might be worth refactoring the code to remove them, but that might be a high-level decision which is beyond the scope of this proposal.

Set dynamic and local @variables to 0 before close;
==Naming Variables==

==Using as little variables as you need==
So there are some quests, which require lots of variables.
Think of monster oil quest, Oric and Warum quest etc.

This can often be done by bitmasking:
One variable has 32 bits. So a variabe can store 2^32 different numbers: 4294967296

But sometimes you only need numbers from 0 to 15, but more of these variables.
but numbers in range 0 to 15 can be stored in 4 bits ( 2^4 = 16 different numbers)

Here is an example how to use bitmasking:
[[Media:Tester.txt]]
== Defining Map Objects ==

These sections describe how to define map objects.

=== Warp Definitions ===
Warps are what move players between maps. They can also be used to move players around a single map, if needed. Warps are defined like this:

map1,startX,startY|warp|name|width,height,map2,endX,endY

Key:
{|
|map1 ||the starting map
|-
|startX||the x-coordinate of the starting warp tile
|-
|startY||the y-coordinate of the starting warp tile
|-
|name ||the name of the warp, unused but must be defined
|-
|width ||the width of the warp
|-
|height||the height of the warp
|-
|map2 ||the ending map
|-
|endX ||the x-coordinate of the tile the player will end up on
|-
|endY ||the y-coordinate of the tile the player will end up on
|}

Width and height are described in detail here: [[EAthena Scripting Standards/Warp Details|Warp Details]].

=== Monster Definitions ===
Monsters are defined like this:

<map name>,<x>,<y>,<width>,<height>|monster|<name>|<mobID>,<count>,<spawn1>,<spawn2>,{<eventcode>}

{|
|map name ||the map the monsters should appear on
|-
|x ||the x-coordinate of the spawn tile
|-
|y ||the y-coordinate of the spawn tile
|-
|width ||the tile width of the spawn area
|-
|height ||the tile height of the spawn area
|-
|name ||the name of the mob, unused but must be defined. '''DO NOT''' use the keywords such as "spawn" in this name to avoid conflict with other game systems (magic for example)
|-
|mobID ||the mob identifier of the desired monster (in the monster db)the number to spawn
|-
|count ||the number to spawn
|-
|spawn1 ||the minimum delay between successive spawns (per individual)
|-
|spawn2 ||the minimum delay between death and respawn (per individual)
|-
|eventcode ||the script event to fire upon death
|}
A detailed description of position and area can be found here: [[EAthena Scripting Standards/Mob Details|Mob Details]].

=== NPC Definitions ===
<map name>,<x>,<y>,<facing>|script|<Name>|<spriteID>,<nowiki>{<code>}</nowiki>
<map name>,<x>,<y>,<facing>|script|<Name>|<spriteID>,<triggerX>,<triggerY>,<nowiki>{<code>}</nowiki>

{|
|map name ||the map the monsters should appear on
|-
|x ||the x-coordinate of the spawn tile
|-
|y ||the y-coordinate of the spawn tile
|-
|facing ||Direction the NPC faces to. '''It must be set to 0''' in TMW
|-
|height ||the tile height of the spawn area
|-
|Name ||the name of the NPC
|-
|spriteID ||the mob identifier of the desired NPC. Sprite ID
|-
|triggerX ||
|-
|triggerY ||
|-
|eventcode ||the script event to fire upon death
|}
* Server side :
::NPC definitions (script) are usually stored as : (tmwa-server-data/)world/map/npc/<map name>/<NPC Name>.txt or in the file : (tmwa-server-data/)world/map/npc/<map name>/npc.txt
* Client side :
::The NPC is associated with a sprite (the image that will appear in the game), and a XML file which tells the client some display parameters. (tmwa-client-data/)graphics/sprites/npcs/npc-<Name>.png (tmwa-client-data/)graphics/sprites/npcs/npc-<Name>.xml The NPC spriteID is linked to graphic files and XML in the file : (tmwa-client-data/)npcs.xml



== Script Functions ==
function|script|<function name>|<nowiki>{<code>}</nowiki>
Actual script functions are stored or imported in the files : (tmwa-server-data/)world/map/npc/functions/<function name>.txt, regardless rhey are called from a Map, NPC, Mob or item.

==Script Loading==
The main script import file is:[https://github.com/themanaworld/tmwa-server-data/blob/master/world/map/npc/scripts.conf (tmwa-server-data/)world/map/npc/scripts.conf] 
It loads [https://github.com/themanaworld/tmwa-server-data/blob/master/world/map/npc/_import.txt (tmwa-server-data/)world/map/npc/_import.txt] which imports all NPC scripts wich are stored under the respective map name folders, usually under NPC name.

=Examples=
== Open a chest and get reward ==
An example is given by a quest to get a key for a chest (in fact 3 keys):

{| style="width:850px;" border=0 cellspacing="10"
|-valign="Top"
|<pre>
// A treasure chest. You need three keys to open it.
//
// TMW_Quest (document variable here)
//

002-4.gat,93,37,0|script|Treasure|111,{

if (TMW_Quest >= 38) goto L_Finished;

mes "There is a chest here.";
mes "Do you want to try to open it?";
next;
menu
"Yes.", L_Yes,
"No.", -;
close;

L_Yes:
if(countitem("TreasureKey") < 3)
goto L_Not_Enough;
getinventorylist;
if (@inventorylist_count == 100 && countitem("TreasureKey") > 3)
goto L_TooMany;
mes "You opened the chest and found a short bow!";
delitem "TreasureKey", 3;
getitem "ShortBow", 1;
set TMW_Quest, 38;
close;

L_Not_Enough:
mes "It seems that you do not have the right key for this chest yet...";
close;

L_Finished:
mes "You have already opened this chest.";
close;

L_TooMany:
mes "You do not have enough room to loot this chest. Maybe you should try again later.";
close;
}
</pre>
|}
This script starts with describing the NPC (the chest, NPC sprite 111) and its location (map 002-4 X=93, Y=37, in tiles from top left of the map). Then follows what happens on activation:
First, the variable ''"TMW_Quest"'' is checked to know if the player already accomplished the quest '''(the variable should be documented)''', If he has the script continues at label ''L_Finished'', the player is reminded fe alredy accomplished the task and script finishes, if not the scrip continues. A message is shown (mes), then an option dialog (menu) is displayed with two possible answers : "Yes." or "No.". If the player answers "No." the script stops (close;); if he answers "Yes." the script continues at label ''L_Yes''. Now player is checked to know if he has at least 3 keys, if not script branches to label ''L_Not_Enough'' tells the player he "has not the right key" and script closes. If he has keys enough, his inventory list is retrieved by the built-in function "getinventorylist" and it's content is checked to know if the player will have room enough to store the reward after the 3 keys use. If not, script goes to label ''L_TooMany'' and script close after a warning message, If yes 3 keys are deleted in player's inventory, he gets the reward: a Short Bow and the variable TMW_Quest is set to 38.

For more examples of the current system, check out the current scripts in use by the server. Beware though, this could affect your enjoyment of the game as it does spoil some of the mystery. Here's a link to git so you can view them in your browser:

https://github.com/themanaworld/tmwa-server-data/tree/master/world/map/npc

Note that anything said by an NPC should be put in double quotes ("). You can do that like this: "'''\"'''Hello!'''\"''' she said."
=References=
* [[EAthena Scripting Basics]]
* [[EAthena Scripting Reference]]
* [http://forums.themanaworld.org/viewtopic.php?f=13&t=13653 script cleanup/scripting standards proposal]

Classic:TmwAthena Scripting Standards

2013-01-03T21:05:14Z

Jenalya: Reworking the section about Labels and Subfunctions.

{{Status_construction}}
{{Status_outdated}}
{{Gaps|Needs to be updated with {{ForumThread|13653}} and {{ForumThread|13672}}, which are generally accepted but there might be more discussion}}

This is an attempt to standardize the eAthena coding. Any suggestions are welcome to be posted on the discussion page before editing.
=Code Formatting=
== Indentation ==
* Code is indented with four spaces.
* Code in the same block should have the same indentation.
* Labels have no indentation.
* Menu options are on their own lines and are indented further.
Example:
menu
"Yes.", L_Yes,
"No.", L_No;
* When using an if-statement, there should be a line break after the condition and the conditional command should be indented further. An exception to this is a series of if-statements at the beginning of a major code block which use gotos to jump to the correct position in the script. In this case the goto should be in the same line as the if-statement.
Example:
// if-statement and conditional command in the same line, gotos aligned
if (@quest >= 3) goto L_Done;
if (@quest == 2) goto L_Progress;
if (@quest == 1) goto L_Question;

// conditional command in the next line and indented further
if (BaseLevel < 40)
set @cost, 100;

== Whitespaces==
In many places whitespaces can increase readability. Examples are
* When concatenating text and variables:
mes "\"Hello " + strcharinfo(0) + "!\"";
instead of
mes "\"Hello "+strcharinfo(0)+"!\"";
* When assigning values to variables:
set @var, 3;
instead of
set @var,3;
* In menus:
menu
"Yes.", L_Yes,
"No.", L_No;
instead of
menu
"Yes.",L_Yes,
"No.",L_No;

== Code Blocks ==
* Code blocks should be separated from the others in a dinstinct way: insert a blank line between code blocks.
* Individual blocks should be together No blank lines within a block.
* The opening brackets should be at the end of the parent line, not in a new line; the closing ones should be in a line of their own.

==Labels and Subfunctions==
* Newline before every label
* No newline after a label
* Labels should always start with L_, except those that act as a subfunction, which should start with S_. There must not be a fallthrough or goto to a subfunction label.
* Lables should be named in this way: L_CamelCase
* Subfunctions should be named in this way: S_CamelCase

==Comments==
At the beginning of a script file there should be documented
* who is the author
* the purpose of the script
* which variables are used and what's their purpose
* any additional information that can help to understand the script
Example:
// Author: devxy
// This file contains the NPC John, who is part of the Example quest.
// Quest states are saved in Quest_Example.
// State 1: started the quest
// State 2: did the next step
[...]

Within the script there should be comments if there are parts which might be difficult to understand.

In some of the older scripts there are boxed comments used like this:
//#################################################################################
//# NPC John - By Smith #
//# #
//# ... #
//#################################################################################
Don't use them in new scripts.

=Variables=
==Document Variables==
in every file, document every variable as one of:

* # account variable (prefix #) (note that there are also ## variable which didn't work in the stable version of the server)
* permanent player variable (no prefix)
* @ temporary player variable (prefix @) - used after the script close;s or end;s.
* @ dynamic player variable (prefix @) - passed into or out of callsub or callfunc
* @ lexical (local) player variable (prefix @) - used only within the function (scripthelp.txt documents that ".@" means this but I don't know if that works)
* @ local constant (prefix @) - not dependent on the player, used only within the function. e.g. lots of @QUEST_FOO_{SHIFT,MASK}
* $ global permanent variable (prefix $) (I'm not sure if we have any of these right now)
* $ npc permanent variable (prefix $) same as above but only used by one NPC
* $ global temporary variable (prefix $@)
* $@ npc temporary variable (prefix $@) same as above but only used by one NPC, scripthelp.txt mentions prefix "." but I don't know if that works
* special variable (in db/const.txt with a 1 following)
* global constant (in const.txt)

'''If we use a consistent method of documenting these, we can then generate a list of all variables by type.'''

==Variables initialization==
Check for troublesome arrays:
A troublesome array is defined as an array that is not
*initialized all at once
*initialized by appending elements to the end, for use in a menu
Nothing needs to be done, merely document them. I want this information at hand when I design the new scripting language to minimize conversion pains.
I wouldn't be surprised if there were no troublesome arrays at all. If there are only a couple it might be worth refactoring the code to remove them, but that might be a high-level decision which is beyond the scope of this proposal.

Set dynamic and local @variables to 0 before close;
==Naming Variables==

==Using as little variables as you need==
So there are some quests, which require lots of variables.
Think of monster oil quest, Oric and Warum quest etc.

This can often be done by bitmasking:
One variable has 32 bits. So a variabe can store 2^32 different numbers: 4294967296

But sometimes you only need numbers from 0 to 15, but more of these variables.
but numbers in range 0 to 15 can be stored in 4 bits ( 2^4 = 16 different numbers)

Here is an example how to use bitmasking:
[[Media:Tester.txt]]
== Defining Map Objects ==

These sections describe how to define map objects.

=== Warp Definitions ===
Warps are what move players between maps. They can also be used to move players around a single map, if needed. Warps are defined like this:

map1,startX,startY|warp|name|width,height,map2,endX,endY

Key:
{|
|map1 ||the starting map
|-
|startX||the x-coordinate of the starting warp tile
|-
|startY||the y-coordinate of the starting warp tile
|-
|name ||the name of the warp, unused but must be defined
|-
|width ||the width of the warp
|-
|height||the height of the warp
|-
|map2 ||the ending map
|-
|endX ||the x-coordinate of the tile the player will end up on
|-
|endY ||the y-coordinate of the tile the player will end up on
|}

Width and height are described in detail here: [[EAthena Scripting Standards/Warp Details|Warp Details]].

=== Monster Definitions ===
Monsters are defined like this:

<map name>,<x>,<y>,<width>,<height>|monster|<name>|<mobID>,<count>,<spawn1>,<spawn2>,{<eventcode>}

{|
|map name ||the map the monsters should appear on
|-
|x ||the x-coordinate of the spawn tile
|-
|y ||the y-coordinate of the spawn tile
|-
|width ||the tile width of the spawn area
|-
|height ||the tile height of the spawn area
|-
|name ||the name of the mob, unused but must be defined. '''DO NOT''' use the keywords such as "spawn" in this name to avoid conflict with other game systems (magic for example)
|-
|mobID ||the mob identifier of the desired monster (in the monster db)the number to spawn
|-
|count ||the number to spawn
|-
|spawn1 ||the minimum delay between successive spawns (per individual)
|-
|spawn2 ||the minimum delay between death and respawn (per individual)
|-
|eventcode ||the script event to fire upon death
|}
A detailed description of position and area can be found here: [[EAthena Scripting Standards/Mob Details|Mob Details]].

=== NPC Definitions ===
<map name>,<x>,<y>,<facing>|script|<Name>|<spriteID>,<nowiki>{<code>}</nowiki>
<map name>,<x>,<y>,<facing>|script|<Name>|<spriteID>,<triggerX>,<triggerY>,<nowiki>{<code>}</nowiki>

{|
|map name ||the map the monsters should appear on
|-
|x ||the x-coordinate of the spawn tile
|-
|y ||the y-coordinate of the spawn tile
|-
|facing ||Direction the NPC faces to. '''It must be set to 0''' in TMW
|-
|height ||the tile height of the spawn area
|-
|Name ||the name of the NPC
|-
|spriteID ||the mob identifier of the desired NPC. Sprite ID
|-
|triggerX ||
|-
|triggerY ||
|-
|eventcode ||the script event to fire upon death
|}
* Server side :
::NPC definitions (script) are usually stored as : (tmwa-server-data/)world/map/npc/<map name>/<NPC Name>.txt or in the file : (tmwa-server-data/)world/map/npc/<map name>/npc.txt
* Client side :
::The NPC is associated with a sprite (the image that will appear in the game), and a XML file which tells the client some display parameters. (tmwa-client-data/)graphics/sprites/npcs/npc-<Name>.png (tmwa-client-data/)graphics/sprites/npcs/npc-<Name>.xml The NPC spriteID is linked to graphic files and XML in the file : (tmwa-client-data/)npcs.xml



== Script Functions ==
function|script|<function name>|<nowiki>{<code>}</nowiki>
Actual script functions are stored or imported in the files : (tmwa-server-data/)world/map/npc/functions/<function name>.txt, regardless rhey are called from a Map, NPC, Mob or item.

==Script Loading==
The main script import file is:[https://github.com/themanaworld/tmwa-server-data/blob/master/world/map/npc/scripts.conf (tmwa-server-data/)world/map/npc/scripts.conf] 
It loads [https://github.com/themanaworld/tmwa-server-data/blob/master/world/map/npc/_import.txt (tmwa-server-data/)world/map/npc/_import.txt] which imports all NPC scripts wich are stored under the respective map name folders, usually under NPC name.

=Examples=
== Open a chest and get reward ==
An example is given by a quest to get a key for a chest (in fact 3 keys):

{| style="width:850px;" border=0 cellspacing="10"
|-valign="Top"
|<pre>
// A treasure chest. You need three keys to open it.
//
// TMW_Quest (document variable here)
//

002-4.gat,93,37,0|script|Treasure|111,{

if (TMW_Quest >= 38) goto L_Finished;

mes "There is a chest here.";
mes "Do you want to try to open it?";
next;
menu
"Yes.", L_Yes,
"No.", -;
close;

L_Yes:
if(countitem("TreasureKey") < 3) goto L_Not_Enough;
getinventorylist;
if (@inventorylist_count == 100 && countitem("TreasureKey") > 3) goto L_TooMany;
mes "You opened the chest and found a short bow!";
delitem "TreasureKey", 3;
getitem "ShortBow", 1;
set TMW_Quest, 38;
close;

L_Not_Enough:
mes "It seems that you do not have the right key for this chest yet...";
close;

L_Finished:
mes "You have already opened this chest.";
close;

L_TooMany:
mes "You do not have enough room to loot this chest. Maybe you should try again later.";
close;
}
</pre>
|}
This script starts with describing the NPC (the chest, NPC sprite 111) and its location (map 002-4 X=93, Y=37, in tiles from top left of the map). Then follows what happens on activation:
First, the variable ''"TMW_Quest"'' is checked to know if the player already accomplished the quest '''(the variable should be documented)''', If he has the script continues at label ''L_Finished'', the player is reminded fe alredy accomplished the task and script finishes, if not the scrip continues. A message is shown (mes), then an option dialog (menu) is displayed with two possible answers : "Yes." or "No.". If the player answers "No." the script stops (close;); if he answers "Yes." the script continues at label ''L_Yes''. Now player is checked to know if he has at least 3 keys, if not script branches to label ''L_Not_Enough'' tells the player he "has not the right key" and script closes. If he has keys enough, his inventory list is retrieved by the built-in function "getinventorylist" and it's content is checked to know if the player will have room enough to store the reward after the 3 keys use. If not, script goes to label ''L_TooMany'' and script close after a warning message, If yes 3 keys are deleted in player's inventory, he gets the reward: a Short Bow and the variable TMW_Quest is set to 38.

For more examples of the current system, check out the current scripts in use by the server. Beware though, this could affect your enjoyment of the game as it does spoil some of the mystery. Here's a link to git so you can view them in your browser:

https://github.com/themanaworld/tmwa-server-data/tree/master/world/map/npc

Note that anything said by an NPC should be put in double quotes ("). You can do that like this: "'''\"'''Hello!'''\"''' she said."
=References=
* [[EAthena Scripting Basics]]
* [[EAthena Scripting Reference]]
* [http://forums.themanaworld.org/viewtopic.php?f=13&t=13653 script cleanup/scripting standards proposal]

Classic:TmwAthena Scripting Standards

2013-01-03T20:55:34Z

Jenalya: Remove some notes that aren't relevant anymore.

{{Status_construction}}
{{Status_outdated}}
{{Gaps|Needs to be updated with {{ForumThread|13653}} and {{ForumThread|13672}}, which are generally accepted but there might be more discussion}}

This is an attempt to standardize the eAthena coding. Any suggestions are welcome to be posted on the discussion page before editing.
=Code Formatting=
== Indentation ==
* Code is indented with four spaces.
* Code in the same block should have the same indentation.
* Labels have no indentation.
* Menu options are on their own lines and are indented further.
Example:
menu
"Yes.", L_Yes,
"No.", L_No;
* When using an if-statement, there should be a line break after the condition and the conditional command should be indented further. An exception to this is a series of if-statements at the beginning of a major code block which use gotos to jump to the correct position in the script. In this case the goto should be in the same line as the if-statement.
Example:
// if-statement and conditional command in the same line, gotos aligned
if (@quest >= 3) goto L_Done;
if (@quest == 2) goto L_Progress;
if (@quest == 1) goto L_Question;

// conditional command in the next line and indented further
if (BaseLevel < 40)
set @cost, 100;

== Whitespaces==
In many places whitespaces can increase readability. Examples are
* When concatenating text and variables:
mes "\"Hello " + strcharinfo(0) + "!\"";
instead of
mes "\"Hello "+strcharinfo(0)+"!\"";
* When assigning values to variables:
set @var, 3;
instead of
set @var,3;
* In menus:
menu
"Yes.", L_Yes,
"No.", L_No;
instead of
menu
"Yes.",L_Yes,
"No.",L_No;

== Code Blocks ==
* Code blocks should be separated from the others in a dinstinct way: insert a blank line between code blocks.
* Individual blocks should be together No blank lines within a block.
* The opening brackets should be at the end of the parent line, not in a new line; the closing ones should be in a line of their own.

==Labels and Subfunctions==
* newline before every label
* no newline after a label
* Labels should always start with L_, except those that act as a subfunction, which should start with S_. There must not be a fallthrough or goto to a subfunction label.
'''decision pending'''
L_CamelCase: Current practice for labels and I don't think that is worth changing,
L_lower_case:, o11c prefers, especially for things like L_close:
* '''Subfunctions''':'''to be discussed'''
"[...]except those that act as a subfunction, which should start with S_"
Also, what should labels within a subfunction label use? I was thinking LS_ or SL_; loratay currently uses L_SUB_ ... or perhaps this should be refactored out into a standalone function?
''summary'': S_, LS_, SL_, L_SUB_, Sub_, refactor out into a standalone function.
==Comments==
At the beginning of a script file there should be documented
* who is the author
* the purpose of the script
* which variables are used and what's their purpose
* any additional information that can help to understand the script
Example:
// Author: devxy
// This file contains the NPC John, who is part of the Example quest.
// Quest states are saved in Quest_Example.
// State 1: started the quest
// State 2: did the next step
[...]

Within the script there should be comments if there are parts which might be difficult to understand.

In some of the older scripts there are boxed comments used like this:
//#################################################################################
//# NPC John - By Smith #
//# #
//# ... #
//#################################################################################
Don't use them in new scripts.

=Variables=
==Document Variables==
in every file, document every variable as one of:

* # account variable (prefix #) (note that there are also ## variable which didn't work in the stable version of the server)
* permanent player variable (no prefix)
* @ temporary player variable (prefix @) - used after the script close;s or end;s.
* @ dynamic player variable (prefix @) - passed into or out of callsub or callfunc
* @ lexical (local) player variable (prefix @) - used only within the function (scripthelp.txt documents that ".@" means this but I don't know if that works)
* @ local constant (prefix @) - not dependent on the player, used only within the function. e.g. lots of @QUEST_FOO_{SHIFT,MASK}
* $ global permanent variable (prefix $) (I'm not sure if we have any of these right now)
* $ npc permanent variable (prefix $) same as above but only used by one NPC
* $ global temporary variable (prefix $@)
* $@ npc temporary variable (prefix $@) same as above but only used by one NPC, scripthelp.txt mentions prefix "." but I don't know if that works
* special variable (in db/const.txt with a 1 following)
* global constant (in const.txt)

'''If we use a consistent method of documenting these, we can then generate a list of all variables by type.'''

==Variables initialization==
Check for troublesome arrays:
A troublesome array is defined as an array that is not
*initialized all at once
*initialized by appending elements to the end, for use in a menu
Nothing needs to be done, merely document them. I want this information at hand when I design the new scripting language to minimize conversion pains.
I wouldn't be surprised if there were no troublesome arrays at all. If there are only a couple it might be worth refactoring the code to remove them, but that might be a high-level decision which is beyond the scope of this proposal.

Set dynamic and local @variables to 0 before close;
==Naming Variables==

==Using as little variables as you need==
So there are some quests, which require lots of variables.
Think of monster oil quest, Oric and Warum quest etc.

This can often be done by bitmasking:
One variable has 32 bits. So a variabe can store 2^32 different numbers: 4294967296

But sometimes you only need numbers from 0 to 15, but more of these variables.
but numbers in range 0 to 15 can be stored in 4 bits ( 2^4 = 16 different numbers)

Here is an example how to use bitmasking:
[[Media:Tester.txt]]
== Defining Map Objects ==

These sections describe how to define map objects.

=== Warp Definitions ===
Warps are what move players between maps. They can also be used to move players around a single map, if needed. Warps are defined like this:

map1,startX,startY|warp|name|width,height,map2,endX,endY

Key:
{|
|map1 ||the starting map
|-
|startX||the x-coordinate of the starting warp tile
|-
|startY||the y-coordinate of the starting warp tile
|-
|name ||the name of the warp, unused but must be defined
|-
|width ||the width of the warp
|-
|height||the height of the warp
|-
|map2 ||the ending map
|-
|endX ||the x-coordinate of the tile the player will end up on
|-
|endY ||the y-coordinate of the tile the player will end up on
|}

Width and height are described in detail here: [[EAthena Scripting Standards/Warp Details|Warp Details]].

=== Monster Definitions ===
Monsters are defined like this:

<map name>,<x>,<y>,<width>,<height>|monster|<name>|<mobID>,<count>,<spawn1>,<spawn2>,{<eventcode>}

{|
|map name ||the map the monsters should appear on
|-
|x ||the x-coordinate of the spawn tile
|-
|y ||the y-coordinate of the spawn tile
|-
|width ||the tile width of the spawn area
|-
|height ||the tile height of the spawn area
|-
|name ||the name of the mob, unused but must be defined. '''DO NOT''' use the keywords such as "spawn" in this name to avoid conflict with other game systems (magic for example)
|-
|mobID ||the mob identifier of the desired monster (in the monster db)the number to spawn
|-
|count ||the number to spawn
|-
|spawn1 ||the minimum delay between successive spawns (per individual)
|-
|spawn2 ||the minimum delay between death and respawn (per individual)
|-
|eventcode ||the script event to fire upon death
|}
A detailed description of position and area can be found here: [[EAthena Scripting Standards/Mob Details|Mob Details]].

=== NPC Definitions ===
<map name>,<x>,<y>,<facing>|script|<Name>|<spriteID>,<nowiki>{<code>}</nowiki>
<map name>,<x>,<y>,<facing>|script|<Name>|<spriteID>,<triggerX>,<triggerY>,<nowiki>{<code>}</nowiki>

{|
|map name ||the map the monsters should appear on
|-
|x ||the x-coordinate of the spawn tile
|-
|y ||the y-coordinate of the spawn tile
|-
|facing ||Direction the NPC faces to. '''It must be set to 0''' in TMW
|-
|height ||the tile height of the spawn area
|-
|Name ||the name of the NPC
|-
|spriteID ||the mob identifier of the desired NPC. Sprite ID
|-
|triggerX ||
|-
|triggerY ||
|-
|eventcode ||the script event to fire upon death
|}
* Server side :
::NPC definitions (script) are usually stored as : (tmwa-server-data/)world/map/npc/<map name>/<NPC Name>.txt or in the file : (tmwa-server-data/)world/map/npc/<map name>/npc.txt
* Client side :
::The NPC is associated with a sprite (the image that will appear in the game), and a XML file which tells the client some display parameters. (tmwa-client-data/)graphics/sprites/npcs/npc-<Name>.png (tmwa-client-data/)graphics/sprites/npcs/npc-<Name>.xml The NPC spriteID is linked to graphic files and XML in the file : (tmwa-client-data/)npcs.xml



== Script Functions ==
function|script|<function name>|<nowiki>{<code>}</nowiki>
Actual script functions are stored or imported in the files : (tmwa-server-data/)world/map/npc/functions/<function name>.txt, regardless rhey are called from a Map, NPC, Mob or item.

==Script Loading==
The main script import file is:[https://github.com/themanaworld/tmwa-server-data/blob/master/world/map/npc/scripts.conf (tmwa-server-data/)world/map/npc/scripts.conf] 
It loads [https://github.com/themanaworld/tmwa-server-data/blob/master/world/map/npc/_import.txt (tmwa-server-data/)world/map/npc/_import.txt] which imports all NPC scripts wich are stored under the respective map name folders, usually under NPC name.

=Examples=
== Open a chest and get reward ==
An example is given by a quest to get a key for a chest (in fact 3 keys):

{| style="width:850px;" border=0 cellspacing="10"
|-valign="Top"
|<pre>
// A treasure chest. You need three keys to open it.
//
// TMW_Quest (document variable here)
//

002-4.gat,93,37,0|script|Treasure|111,{

if (TMW_Quest >= 38) goto L_Finished;

mes "There is a chest here.";
mes "Do you want to try to open it?";
next;
menu
"Yes.", L_Yes,
"No.", -;
close;

L_Yes:
if(countitem("TreasureKey") < 3) goto L_Not_Enough;
getinventorylist;
if (@inventorylist_count == 100 && countitem("TreasureKey") > 3) goto L_TooMany;
mes "You opened the chest and found a short bow!";
delitem "TreasureKey", 3;
getitem "ShortBow", 1;
set TMW_Quest, 38;
close;

L_Not_Enough:
mes "It seems that you do not have the right key for this chest yet...";
close;

L_Finished:
mes "You have already opened this chest.";
close;

L_TooMany:
mes "You do not have enough room to loot this chest. Maybe you should try again later.";
close;
}
</pre>
|}
This script starts with describing the NPC (the chest, NPC sprite 111) and its location (map 002-4 X=93, Y=37, in tiles from top left of the map). Then follows what happens on activation:
First, the variable ''"TMW_Quest"'' is checked to know if the player already accomplished the quest '''(the variable should be documented)''', If he has the script continues at label ''L_Finished'', the player is reminded fe alredy accomplished the task and script finishes, if not the scrip continues. A message is shown (mes), then an option dialog (menu) is displayed with two possible answers : "Yes." or "No.". If the player answers "No." the script stops (close;); if he answers "Yes." the script continues at label ''L_Yes''. Now player is checked to know if he has at least 3 keys, if not script branches to label ''L_Not_Enough'' tells the player he "has not the right key" and script closes. If he has keys enough, his inventory list is retrieved by the built-in function "getinventorylist" and it's content is checked to know if the player will have room enough to store the reward after the 3 keys use. If not, script goes to label ''L_TooMany'' and script close after a warning message, If yes 3 keys are deleted in player's inventory, he gets the reward: a Short Bow and the variable TMW_Quest is set to 38.

For more examples of the current system, check out the current scripts in use by the server. Beware though, this could affect your enjoyment of the game as it does spoil some of the mystery. Here's a link to git so you can view them in your browser:

https://github.com/themanaworld/tmwa-server-data/tree/master/world/map/npc

Note that anything said by an NPC should be put in double quotes ("). You can do that like this: "'''\"'''Hello!'''\"''' she said."
=References=
* [[EAthena Scripting Basics]]
* [[EAthena Scripting Reference]]
* [http://forums.themanaworld.org/viewtopic.php?f=13&t=13653 script cleanup/scripting standards proposal]

Classic:TmwAthena Scripting Standards

2013-01-03T20:53:21Z

Jenalya: Remove point about if-statements from section Code Blocks, since it is already mentioned in Indentation.

{{Status_construction}}
{{Status_outdated}}
{{Gaps|Needs to be updated with {{ForumThread|13653}} and {{ForumThread|13672}}, which are generally accepted but there might be more discussion}}

This is an attempt to standardize the eAthena coding. Any suggestions are welcome to be posted on the discussion page before editing.
=Code Formatting=
== Indentation ==
* Code is indented with four spaces.
* Code in the same block should have the same indentation.
* Labels have no indentation.
* Menu options are on their own lines and are indented further.
Example:
menu
"Yes.", L_Yes,
"No.", L_No;
* When using an if-statement, there should be a line break after the condition and the conditional command should be indented further. An exception to this is a series of if-statements at the beginning of a major code block which use gotos to jump to the correct position in the script. In this case the goto should be in the same line as the if-statement.
Example:
// if-statement and conditional command in the same line, gotos aligned
if (@quest >= 3) goto L_Done;
if (@quest == 2) goto L_Progress;
if (@quest == 1) goto L_Question;

// conditional command in the next line and indented further
if (BaseLevel < 40)
set @cost, 100;

== Whitespaces==
In many places whitespaces can increase readability. Examples are
* When concatenating text and variables:
mes "\"Hello " + strcharinfo(0) + "!\"";
instead of
mes "\"Hello "+strcharinfo(0)+"!\"";
* When assigning values to variables:
set @var, 3;
instead of
set @var,3;
* In menus:
menu
"Yes.", L_Yes,
"No.", L_No;
instead of
menu
"Yes.",L_Yes,
"No.",L_No;

== Code Blocks ==
* Code blocks should be separated from the others in a dinstinct way: insert a blank line between code blocks.
* Individual blocks should be together No blank lines within a block.
* The opening brackets should be at the end of the parent line, not in a new line; the closing ones should be in a line of their own.

Remove unnecessary next;
Remove redundant code such as end; after close;
remove break; instead use end; (requires changing the java converter)
Replace monsters.txt with _mobs.txt except in special cases.
A standard for whitespace and comments.

?
limit line length? (break long strings using + concatentation)
==Labels and Subfunctions==
* newline before every label
* no newline after a label
* Labels should always start with L_, except those that act as a subfunction, which should start with S_. There must not be a fallthrough or goto to a subfunction label.
'''decision pending'''
L_CamelCase: Current practice for labels and I don't think that is worth changing,
L_lower_case:, o11c prefers, especially for things like L_close:
* '''Subfunctions''':'''to be discussed'''
"[...]except those that act as a subfunction, which should start with S_"
Also, what should labels within a subfunction label use? I was thinking LS_ or SL_; loratay currently uses L_SUB_ ... or perhaps this should be refactored out into a standalone function?
''summary'': S_, LS_, SL_, L_SUB_, Sub_, refactor out into a standalone function.
==Comments==
At the beginning of a script file there should be documented
* who is the author
* the purpose of the script
* which variables are used and what's their purpose
* any additional information that can help to understand the script
Example:
// Author: devxy
// This file contains the NPC John, who is part of the Example quest.
// Quest states are saved in Quest_Example.
// State 1: started the quest
// State 2: did the next step
[...]

Within the script there should be comments if there are parts which might be difficult to understand.

In some of the older scripts there are boxed comments used like this:
//#################################################################################
//# NPC John - By Smith #
//# #
//# ... #
//#################################################################################
Don't use them in new scripts.

=Variables=
==Document Variables==
in every file, document every variable as one of:

* # account variable (prefix #) (note that there are also ## variable which didn't work in the stable version of the server)
* permanent player variable (no prefix)
* @ temporary player variable (prefix @) - used after the script close;s or end;s.
* @ dynamic player variable (prefix @) - passed into or out of callsub or callfunc
* @ lexical (local) player variable (prefix @) - used only within the function (scripthelp.txt documents that ".@" means this but I don't know if that works)
* @ local constant (prefix @) - not dependent on the player, used only within the function. e.g. lots of @QUEST_FOO_{SHIFT,MASK}
* $ global permanent variable (prefix $) (I'm not sure if we have any of these right now)
* $ npc permanent variable (prefix $) same as above but only used by one NPC
* $ global temporary variable (prefix $@)
* $@ npc temporary variable (prefix $@) same as above but only used by one NPC, scripthelp.txt mentions prefix "." but I don't know if that works
* special variable (in db/const.txt with a 1 following)
* global constant (in const.txt)

'''If we use a consistent method of documenting these, we can then generate a list of all variables by type.'''

==Variables initialization==
Check for troublesome arrays:
A troublesome array is defined as an array that is not
*initialized all at once
*initialized by appending elements to the end, for use in a menu
Nothing needs to be done, merely document them. I want this information at hand when I design the new scripting language to minimize conversion pains.
I wouldn't be surprised if there were no troublesome arrays at all. If there are only a couple it might be worth refactoring the code to remove them, but that might be a high-level decision which is beyond the scope of this proposal.

Set dynamic and local @variables to 0 before close;
==Naming Variables==

==Using as little variables as you need==
So there are some quests, which require lots of variables.
Think of monster oil quest, Oric and Warum quest etc.

This can often be done by bitmasking:
One variable has 32 bits. So a variabe can store 2^32 different numbers: 4294967296

But sometimes you only need numbers from 0 to 15, but more of these variables.
but numbers in range 0 to 15 can be stored in 4 bits ( 2^4 = 16 different numbers)

Here is an example how to use bitmasking:
[[Media:Tester.txt]]
== Defining Map Objects ==

These sections describe how to define map objects.

=== Warp Definitions ===
Warps are what move players between maps. They can also be used to move players around a single map, if needed. Warps are defined like this:

map1,startX,startY|warp|name|width,height,map2,endX,endY

Key:
{|
|map1 ||the starting map
|-
|startX||the x-coordinate of the starting warp tile
|-
|startY||the y-coordinate of the starting warp tile
|-
|name ||the name of the warp, unused but must be defined
|-
|width ||the width of the warp
|-
|height||the height of the warp
|-
|map2 ||the ending map
|-
|endX ||the x-coordinate of the tile the player will end up on
|-
|endY ||the y-coordinate of the tile the player will end up on
|}

Width and height are described in detail here: [[EAthena Scripting Standards/Warp Details|Warp Details]].

=== Monster Definitions ===
Monsters are defined like this:

<map name>,<x>,<y>,<width>,<height>|monster|<name>|<mobID>,<count>,<spawn1>,<spawn2>,{<eventcode>}

{|
|map name ||the map the monsters should appear on
|-
|x ||the x-coordinate of the spawn tile
|-
|y ||the y-coordinate of the spawn tile
|-
|width ||the tile width of the spawn area
|-
|height ||the tile height of the spawn area
|-
|name ||the name of the mob, unused but must be defined. '''DO NOT''' use the keywords such as "spawn" in this name to avoid conflict with other game systems (magic for example)
|-
|mobID ||the mob identifier of the desired monster (in the monster db)the number to spawn
|-
|count ||the number to spawn
|-
|spawn1 ||the minimum delay between successive spawns (per individual)
|-
|spawn2 ||the minimum delay between death and respawn (per individual)
|-
|eventcode ||the script event to fire upon death
|}
A detailed description of position and area can be found here: [[EAthena Scripting Standards/Mob Details|Mob Details]].

=== NPC Definitions ===
<map name>,<x>,<y>,<facing>|script|<Name>|<spriteID>,<nowiki>{<code>}</nowiki>
<map name>,<x>,<y>,<facing>|script|<Name>|<spriteID>,<triggerX>,<triggerY>,<nowiki>{<code>}</nowiki>

{|
|map name ||the map the monsters should appear on
|-
|x ||the x-coordinate of the spawn tile
|-
|y ||the y-coordinate of the spawn tile
|-
|facing ||Direction the NPC faces to. '''It must be set to 0''' in TMW
|-
|height ||the tile height of the spawn area
|-
|Name ||the name of the NPC
|-
|spriteID ||the mob identifier of the desired NPC. Sprite ID
|-
|triggerX ||
|-
|triggerY ||
|-
|eventcode ||the script event to fire upon death
|}
* Server side :
::NPC definitions (script) are usually stored as : (tmwa-server-data/)world/map/npc/<map name>/<NPC Name>.txt or in the file : (tmwa-server-data/)world/map/npc/<map name>/npc.txt
* Client side :
::The NPC is associated with a sprite (the image that will appear in the game), and a XML file which tells the client some display parameters. (tmwa-client-data/)graphics/sprites/npcs/npc-<Name>.png (tmwa-client-data/)graphics/sprites/npcs/npc-<Name>.xml The NPC spriteID is linked to graphic files and XML in the file : (tmwa-client-data/)npcs.xml



== Script Functions ==
function|script|<function name>|<nowiki>{<code>}</nowiki>
Actual script functions are stored or imported in the files : (tmwa-server-data/)world/map/npc/functions/<function name>.txt, regardless rhey are called from a Map, NPC, Mob or item.

==Script Loading==
The main script import file is:[https://github.com/themanaworld/tmwa-server-data/blob/master/world/map/npc/scripts.conf (tmwa-server-data/)world/map/npc/scripts.conf] 
It loads [https://github.com/themanaworld/tmwa-server-data/blob/master/world/map/npc/_import.txt (tmwa-server-data/)world/map/npc/_import.txt] which imports all NPC scripts wich are stored under the respective map name folders, usually under NPC name.

=Examples=
== Open a chest and get reward ==
An example is given by a quest to get a key for a chest (in fact 3 keys):

{| style="width:850px;" border=0 cellspacing="10"
|-valign="Top"
|<pre>
// A treasure chest. You need three keys to open it.
//
// TMW_Quest (document variable here)
//

002-4.gat,93,37,0|script|Treasure|111,{

if (TMW_Quest >= 38) goto L_Finished;

mes "There is a chest here.";
mes "Do you want to try to open it?";
next;
menu
"Yes.", L_Yes,
"No.", -;
close;

L_Yes:
if(countitem("TreasureKey") < 3) goto L_Not_Enough;
getinventorylist;
if (@inventorylist_count == 100 && countitem("TreasureKey") > 3) goto L_TooMany;
mes "You opened the chest and found a short bow!";
delitem "TreasureKey", 3;
getitem "ShortBow", 1;
set TMW_Quest, 38;
close;

L_Not_Enough:
mes "It seems that you do not have the right key for this chest yet...";
close;

L_Finished:
mes "You have already opened this chest.";
close;

L_TooMany:
mes "You do not have enough room to loot this chest. Maybe you should try again later.";
close;
}
</pre>
|}
This script starts with describing the NPC (the chest, NPC sprite 111) and its location (map 002-4 X=93, Y=37, in tiles from top left of the map). Then follows what happens on activation:
First, the variable ''"TMW_Quest"'' is checked to know if the player already accomplished the quest '''(the variable should be documented)''', If he has the script continues at label ''L_Finished'', the player is reminded fe alredy accomplished the task and script finishes, if not the scrip continues. A message is shown (mes), then an option dialog (menu) is displayed with two possible answers : "Yes." or "No.". If the player answers "No." the script stops (close;); if he answers "Yes." the script continues at label ''L_Yes''. Now player is checked to know if he has at least 3 keys, if not script branches to label ''L_Not_Enough'' tells the player he "has not the right key" and script closes. If he has keys enough, his inventory list is retrieved by the built-in function "getinventorylist" and it's content is checked to know if the player will have room enough to store the reward after the 3 keys use. If not, script goes to label ''L_TooMany'' and script close after a warning message, If yes 3 keys are deleted in player's inventory, he gets the reward: a Short Bow and the variable TMW_Quest is set to 38.

For more examples of the current system, check out the current scripts in use by the server. Beware though, this could affect your enjoyment of the game as it does spoil some of the mystery. Here's a link to git so you can view them in your browser:

https://github.com/themanaworld/tmwa-server-data/tree/master/world/map/npc

Note that anything said by an NPC should be put in double quotes ("). You can do that like this: "'''\"'''Hello!'''\"''' she said."
=References=
* [[EAthena Scripting Basics]]
* [[EAthena Scripting Reference]]
* [http://forums.themanaworld.org/viewtopic.php?f=13&t=13653 script cleanup/scripting standards proposal]

Classic:TmwAthena Scripting Standards

2013-01-03T20:51:51Z

Jenalya: Updating the section about comments and adding some examples.

{{Status_construction}}
{{Status_outdated}}
{{Gaps|Needs to be updated with {{ForumThread|13653}} and {{ForumThread|13672}}, which are generally accepted but there might be more discussion}}

This is an attempt to standardize the eAthena coding. Any suggestions are welcome to be posted on the discussion page before editing.
=Code Formatting=
== Indentation ==
* Code is indented with four spaces.
* Code in the same block should have the same indentation.
* Labels have no indentation.
* Menu options are on their own lines and are indented further.
Example:
menu
"Yes.", L_Yes,
"No.", L_No;
* When using an if-statement, there should be a line break after the condition and the conditional command should be indented further. An exception to this is a series of if-statements at the beginning of a major code block which use gotos to jump to the correct position in the script. In this case the goto should be in the same line as the if-statement.
Example:
// if-statement and conditional command in the same line, gotos aligned
if (@quest >= 3) goto L_Done;
if (@quest == 2) goto L_Progress;
if (@quest == 1) goto L_Question;

// conditional command in the next line and indented further
if (BaseLevel < 40)
set @cost, 100;

== Whitespaces==
In many places whitespaces can increase readability. Examples are
* When concatenating text and variables:
mes "\"Hello " + strcharinfo(0) + "!\"";
instead of
mes "\"Hello "+strcharinfo(0)+"!\"";
* When assigning values to variables:
set @var, 3;
instead of
set @var,3;
* In menus:
menu
"Yes.", L_Yes,
"No.", L_No;
instead of
menu
"Yes.",L_Yes,
"No.",L_No;

== Code Blocks ==
* Code blocks should be separated from the others in a dinstinct way: insert a blank line between code blocks.
* Individual blocks should be together No blank lines within a block.
* The opening brackets should be at the end of the parent line, not in a new line; the closing ones should be in a line of their own.
* newline between if (condition) and conditional_command, except when conditional_command is a goto at the beginning of a major script block (usually only at the beginning of a script), in which case if there are multiple if statements on adjacent lines, the gotos shall be aligned
'''provide an example'''

Remove unnecessary next;
Remove redundant code such as end; after close;
remove break; instead use end; (requires changing the java converter)
Replace monsters.txt with _mobs.txt except in special cases.
A standard for whitespace and comments.

?
limit line length? (break long strings using + concatentation)
==Labels and Subfunctions==
* newline before every label
* no newline after a label
* Labels should always start with L_, except those that act as a subfunction, which should start with S_. There must not be a fallthrough or goto to a subfunction label.
'''decision pending'''
L_CamelCase: Current practice for labels and I don't think that is worth changing,
L_lower_case:, o11c prefers, especially for things like L_close:
* '''Subfunctions''':'''to be discussed'''
"[...]except those that act as a subfunction, which should start with S_"
Also, what should labels within a subfunction label use? I was thinking LS_ or SL_; loratay currently uses L_SUB_ ... or perhaps this should be refactored out into a standalone function?
''summary'': S_, LS_, SL_, L_SUB_, Sub_, refactor out into a standalone function.
==Comments==
At the beginning of a script file there should be documented
* who is the author
* the purpose of the script
* which variables are used and what's their purpose
* any additional information that can help to understand the script
Example:
// Author: devxy
// This file contains the NPC John, who is part of the Example quest.
// Quest states are saved in Quest_Example.
// State 1: started the quest
// State 2: did the next step
[...]

Within the script there should be comments if there are parts which might be difficult to understand.

In some of the older scripts there are boxed comments used like this:
//#################################################################################
//# NPC John - By Smith #
//# #
//# ... #
//#################################################################################
Don't use them in new scripts.

=Variables=
==Document Variables==
in every file, document every variable as one of:

* # account variable (prefix #) (note that there are also ## variable which didn't work in the stable version of the server)
* permanent player variable (no prefix)
* @ temporary player variable (prefix @) - used after the script close;s or end;s.
* @ dynamic player variable (prefix @) - passed into or out of callsub or callfunc
* @ lexical (local) player variable (prefix @) - used only within the function (scripthelp.txt documents that ".@" means this but I don't know if that works)
* @ local constant (prefix @) - not dependent on the player, used only within the function. e.g. lots of @QUEST_FOO_{SHIFT,MASK}
* $ global permanent variable (prefix $) (I'm not sure if we have any of these right now)
* $ npc permanent variable (prefix $) same as above but only used by one NPC
* $ global temporary variable (prefix $@)
* $@ npc temporary variable (prefix $@) same as above but only used by one NPC, scripthelp.txt mentions prefix "." but I don't know if that works
* special variable (in db/const.txt with a 1 following)
* global constant (in const.txt)

'''If we use a consistent method of documenting these, we can then generate a list of all variables by type.'''

==Variables initialization==
Check for troublesome arrays:
A troublesome array is defined as an array that is not
*initialized all at once
*initialized by appending elements to the end, for use in a menu
Nothing needs to be done, merely document them. I want this information at hand when I design the new scripting language to minimize conversion pains.
I wouldn't be surprised if there were no troublesome arrays at all. If there are only a couple it might be worth refactoring the code to remove them, but that might be a high-level decision which is beyond the scope of this proposal.

Set dynamic and local @variables to 0 before close;
==Naming Variables==

==Using as little variables as you need==
So there are some quests, which require lots of variables.
Think of monster oil quest, Oric and Warum quest etc.

This can often be done by bitmasking:
One variable has 32 bits. So a variabe can store 2^32 different numbers: 4294967296

But sometimes you only need numbers from 0 to 15, but more of these variables.
but numbers in range 0 to 15 can be stored in 4 bits ( 2^4 = 16 different numbers)

Here is an example how to use bitmasking:
[[Media:Tester.txt]]
== Defining Map Objects ==

These sections describe how to define map objects.

=== Warp Definitions ===
Warps are what move players between maps. They can also be used to move players around a single map, if needed. Warps are defined like this:

map1,startX,startY|warp|name|width,height,map2,endX,endY

Key:
{|
|map1 ||the starting map
|-
|startX||the x-coordinate of the starting warp tile
|-
|startY||the y-coordinate of the starting warp tile
|-
|name ||the name of the warp, unused but must be defined
|-
|width ||the width of the warp
|-
|height||the height of the warp
|-
|map2 ||the ending map
|-
|endX ||the x-coordinate of the tile the player will end up on
|-
|endY ||the y-coordinate of the tile the player will end up on
|}

Width and height are described in detail here: [[EAthena Scripting Standards/Warp Details|Warp Details]].

=== Monster Definitions ===
Monsters are defined like this:

<map name>,<x>,<y>,<width>,<height>|monster|<name>|<mobID>,<count>,<spawn1>,<spawn2>,{<eventcode>}

{|
|map name ||the map the monsters should appear on
|-
|x ||the x-coordinate of the spawn tile
|-
|y ||the y-coordinate of the spawn tile
|-
|width ||the tile width of the spawn area
|-
|height ||the tile height of the spawn area
|-
|name ||the name of the mob, unused but must be defined. '''DO NOT''' use the keywords such as "spawn" in this name to avoid conflict with other game systems (magic for example)
|-
|mobID ||the mob identifier of the desired monster (in the monster db)the number to spawn
|-
|count ||the number to spawn
|-
|spawn1 ||the minimum delay between successive spawns (per individual)
|-
|spawn2 ||the minimum delay between death and respawn (per individual)
|-
|eventcode ||the script event to fire upon death
|}
A detailed description of position and area can be found here: [[EAthena Scripting Standards/Mob Details|Mob Details]].

=== NPC Definitions ===
<map name>,<x>,<y>,<facing>|script|<Name>|<spriteID>,<nowiki>{<code>}</nowiki>
<map name>,<x>,<y>,<facing>|script|<Name>|<spriteID>,<triggerX>,<triggerY>,<nowiki>{<code>}</nowiki>

{|
|map name ||the map the monsters should appear on
|-
|x ||the x-coordinate of the spawn tile
|-
|y ||the y-coordinate of the spawn tile
|-
|facing ||Direction the NPC faces to. '''It must be set to 0''' in TMW
|-
|height ||the tile height of the spawn area
|-
|Name ||the name of the NPC
|-
|spriteID ||the mob identifier of the desired NPC. Sprite ID
|-
|triggerX ||
|-
|triggerY ||
|-
|eventcode ||the script event to fire upon death
|}
* Server side :
::NPC definitions (script) are usually stored as : (tmwa-server-data/)world/map/npc/<map name>/<NPC Name>.txt or in the file : (tmwa-server-data/)world/map/npc/<map name>/npc.txt
* Client side :
::The NPC is associated with a sprite (the image that will appear in the game), and a XML file which tells the client some display parameters. (tmwa-client-data/)graphics/sprites/npcs/npc-<Name>.png (tmwa-client-data/)graphics/sprites/npcs/npc-<Name>.xml The NPC spriteID is linked to graphic files and XML in the file : (tmwa-client-data/)npcs.xml



== Script Functions ==
function|script|<function name>|<nowiki>{<code>}</nowiki>
Actual script functions are stored or imported in the files : (tmwa-server-data/)world/map/npc/functions/<function name>.txt, regardless rhey are called from a Map, NPC, Mob or item.

==Script Loading==
The main script import file is:[https://github.com/themanaworld/tmwa-server-data/blob/master/world/map/npc/scripts.conf (tmwa-server-data/)world/map/npc/scripts.conf] 
It loads [https://github.com/themanaworld/tmwa-server-data/blob/master/world/map/npc/_import.txt (tmwa-server-data/)world/map/npc/_import.txt] which imports all NPC scripts wich are stored under the respective map name folders, usually under NPC name.

=Examples=
== Open a chest and get reward ==
An example is given by a quest to get a key for a chest (in fact 3 keys):

{| style="width:850px;" border=0 cellspacing="10"
|-valign="Top"
|<pre>
// A treasure chest. You need three keys to open it.
//
// TMW_Quest (document variable here)
//

002-4.gat,93,37,0|script|Treasure|111,{

if (TMW_Quest >= 38) goto L_Finished;

mes "There is a chest here.";
mes "Do you want to try to open it?";
next;
menu
"Yes.", L_Yes,
"No.", -;
close;

L_Yes:
if(countitem("TreasureKey") < 3) goto L_Not_Enough;
getinventorylist;
if (@inventorylist_count == 100 && countitem("TreasureKey") > 3) goto L_TooMany;
mes "You opened the chest and found a short bow!";
delitem "TreasureKey", 3;
getitem "ShortBow", 1;
set TMW_Quest, 38;
close;

L_Not_Enough:
mes "It seems that you do not have the right key for this chest yet...";
close;

L_Finished:
mes "You have already opened this chest.";
close;

L_TooMany:
mes "You do not have enough room to loot this chest. Maybe you should try again later.";
close;
}
</pre>
|}
This script starts with describing the NPC (the chest, NPC sprite 111) and its location (map 002-4 X=93, Y=37, in tiles from top left of the map). Then follows what happens on activation:
First, the variable ''"TMW_Quest"'' is checked to know if the player already accomplished the quest '''(the variable should be documented)''', If he has the script continues at label ''L_Finished'', the player is reminded fe alredy accomplished the task and script finishes, if not the scrip continues. A message is shown (mes), then an option dialog (menu) is displayed with two possible answers : "Yes." or "No.". If the player answers "No." the script stops (close;); if he answers "Yes." the script continues at label ''L_Yes''. Now player is checked to know if he has at least 3 keys, if not script branches to label ''L_Not_Enough'' tells the player he "has not the right key" and script closes. If he has keys enough, his inventory list is retrieved by the built-in function "getinventorylist" and it's content is checked to know if the player will have room enough to store the reward after the 3 keys use. If not, script goes to label ''L_TooMany'' and script close after a warning message, If yes 3 keys are deleted in player's inventory, he gets the reward: a Short Bow and the variable TMW_Quest is set to 38.

For more examples of the current system, check out the current scripts in use by the server. Beware though, this could affect your enjoyment of the game as it does spoil some of the mystery. Here's a link to git so you can view them in your browser:

https://github.com/themanaworld/tmwa-server-data/tree/master/world/map/npc

Note that anything said by an NPC should be put in double quotes ("). You can do that like this: "'''\"'''Hello!'''\"''' she said."
=References=
* [[EAthena Scripting Basics]]
* [[EAthena Scripting Reference]]
* [http://forums.themanaworld.org/viewtopic.php?f=13&t=13653 script cleanup/scripting standards proposal]

Classic:TmwAthena Scripting Standards

2013-01-03T20:26:42Z

Jenalya: Add an example of how menus should be indented.

{{Status_construction}}
{{Status_outdated}}
{{Gaps|Needs to be updated with {{ForumThread|13653}} and {{ForumThread|13672}}, which are generally accepted but there might be more discussion}}

This is an attempt to standardize the eAthena coding. Any suggestions are welcome to be posted on the discussion page before editing.
=Code Formatting=
== Indentation ==
* Code is indented with four spaces.
* Code in the same block should have the same indentation.
* Labels have no indentation.
* Menu options are on their own lines and are indented further.
Example:
menu
"Yes.", L_Yes,
"No.", L_No;
* When using an if-statement, there should be a line break after the condition and the conditional command should be indented further. An exception to this is a series of if-statements at the beginning of a major code block which use gotos to jump to the correct position in the script. In this case the goto should be in the same line as the if-statement.
Example:
// if-statement and conditional command in the same line, gotos aligned
if (@quest >= 3) goto L_Done;
if (@quest == 2) goto L_Progress;
if (@quest == 1) goto L_Question;

// conditional command in the next line and indented further
if (BaseLevel < 40)
set @cost, 100;

== Whitespaces==
In many places whitespaces can increase readability. Examples are
* When concatenating text and variables:
mes "\"Hello " + strcharinfo(0) + "!\"";
instead of
mes "\"Hello "+strcharinfo(0)+"!\"";
* When assigning values to variables:
set @var, 3;
instead of
set @var,3;
* In menus:
menu
"Yes.", L_Yes,
"No.", L_No;
instead of
menu
"Yes.",L_Yes,
"No.",L_No;

== Code Blocks ==
* Code blocks should be separated from the others in a dinstinct way: insert a blank line between code blocks.
* Individual blocks should be together No blank lines within a block.
* The opening brackets should be at the end of the parent line, not in a new line; the closing ones should be in a line of their own.
* newline between if (condition) and conditional_command, except when conditional_command is a goto at the beginning of a major script block (usually only at the beginning of a script), in which case if there are multiple if statements on adjacent lines, the gotos shall be aligned
'''provide an example'''

Remove unnecessary next;
Remove redundant code such as end; after close;
remove break; instead use end; (requires changing the java converter)
Replace monsters.txt with _mobs.txt except in special cases.
A standard for whitespace and comments.

?
limit line length? (break long strings using + concatentation)
==Labels and Subfunctions==
* newline before every label
* no newline after a label
* Labels should always start with L_, except those that act as a subfunction, which should start with S_. There must not be a fallthrough or goto to a subfunction label.
'''decision pending'''
L_CamelCase: Current practice for labels and I don't think that is worth changing,
L_lower_case:, o11c prefers, especially for things like L_close:
* '''Subfunctions''':'''to be discussed'''
"[...]except those that act as a subfunction, which should start with S_"
Also, what should labels within a subfunction label use? I was thinking LS_ or SL_; loratay currently uses L_SUB_ ... or perhaps this should be refactored out into a standalone function?
''summary'': S_, LS_, SL_, L_SUB_, Sub_, refactor out into a standalone function.
==Comments==
'''to be discussed'''
* o11c suggests:
"^///" lines for documentation
"^// " lines to be commented out code (because that is what my editor uses automatically to disable code)
"^//[^ /]" for "other".
Documentation should maybe have doxygen-like tags?
Dislikes boxed comments.
* Actual
// Yellow dog quests
// author: Saturn
// see bluesageConfig for detailed quest description
// NPC Arthur will not make the code for you...
// uses global vars ... f
// calls global function funkbeat () located at ... f

//#################################################################################
//# bla blabla - By Smith, reviewed by john #
//# GPL v.2 #
//# ... #
//#################################################################################
=Variables=
==Document Variables==
in every file, document every variable as one of:

* # account variable (prefix #) (note that there are also ## variable which didn't work in the stable version of the server)
* permanent player variable (no prefix)
* @ temporary player variable (prefix @) - used after the script close;s or end;s.
* @ dynamic player variable (prefix @) - passed into or out of callsub or callfunc
* @ lexical (local) player variable (prefix @) - used only within the function (scripthelp.txt documents that ".@" means this but I don't know if that works)
* @ local constant (prefix @) - not dependent on the player, used only within the function. e.g. lots of @QUEST_FOO_{SHIFT,MASK}
* $ global permanent variable (prefix $) (I'm not sure if we have any of these right now)
* $ npc permanent variable (prefix $) same as above but only used by one NPC
* $ global temporary variable (prefix $@)
* $@ npc temporary variable (prefix $@) same as above but only used by one NPC, scripthelp.txt mentions prefix "." but I don't know if that works
* special variable (in db/const.txt with a 1 following)
* global constant (in const.txt)

'''If we use a consistent method of documenting these, we can then generate a list of all variables by type.'''

==Variables initialization==
Check for troublesome arrays:
A troublesome array is defined as an array that is not
*initialized all at once
*initialized by appending elements to the end, for use in a menu
Nothing needs to be done, merely document them. I want this information at hand when I design the new scripting language to minimize conversion pains.
I wouldn't be surprised if there were no troublesome arrays at all. If there are only a couple it might be worth refactoring the code to remove them, but that might be a high-level decision which is beyond the scope of this proposal.

Set dynamic and local @variables to 0 before close;
==Naming Variables==

==Using as little variables as you need==
So there are some quests, which require lots of variables.
Think of monster oil quest, Oric and Warum quest etc.

This can often be done by bitmasking:
One variable has 32 bits. So a variabe can store 2^32 different numbers: 4294967296

But sometimes you only need numbers from 0 to 15, but more of these variables.
but numbers in range 0 to 15 can be stored in 4 bits ( 2^4 = 16 different numbers)

Here is an example how to use bitmasking:
[[Media:Tester.txt]]
== Defining Map Objects ==

These sections describe how to define map objects.

=== Warp Definitions ===
Warps are what move players between maps. They can also be used to move players around a single map, if needed. Warps are defined like this:

map1,startX,startY|warp|name|width,height,map2,endX,endY

Key:
{|
|map1 ||the starting map
|-
|startX||the x-coordinate of the starting warp tile
|-
|startY||the y-coordinate of the starting warp tile
|-
|name ||the name of the warp, unused but must be defined
|-
|width ||the width of the warp
|-
|height||the height of the warp
|-
|map2 ||the ending map
|-
|endX ||the x-coordinate of the tile the player will end up on
|-
|endY ||the y-coordinate of the tile the player will end up on
|}

Width and height are described in detail here: [[EAthena Scripting Standards/Warp Details|Warp Details]].

=== Monster Definitions ===
Monsters are defined like this:

<map name>,<x>,<y>,<width>,<height>|monster|<name>|<mobID>,<count>,<spawn1>,<spawn2>,{<eventcode>}

{|
|map name ||the map the monsters should appear on
|-
|x ||the x-coordinate of the spawn tile
|-
|y ||the y-coordinate of the spawn tile
|-
|width ||the tile width of the spawn area
|-
|height ||the tile height of the spawn area
|-
|name ||the name of the mob, unused but must be defined. '''DO NOT''' use the keywords such as "spawn" in this name to avoid conflict with other game systems (magic for example)
|-
|mobID ||the mob identifier of the desired monster (in the monster db)the number to spawn
|-
|count ||the number to spawn
|-
|spawn1 ||the minimum delay between successive spawns (per individual)
|-
|spawn2 ||the minimum delay between death and respawn (per individual)
|-
|eventcode ||the script event to fire upon death
|}
A detailed description of position and area can be found here: [[EAthena Scripting Standards/Mob Details|Mob Details]].

=== NPC Definitions ===
<map name>,<x>,<y>,<facing>|script|<Name>|<spriteID>,<nowiki>{<code>}</nowiki>
<map name>,<x>,<y>,<facing>|script|<Name>|<spriteID>,<triggerX>,<triggerY>,<nowiki>{<code>}</nowiki>

{|
|map name ||the map the monsters should appear on
|-
|x ||the x-coordinate of the spawn tile
|-
|y ||the y-coordinate of the spawn tile
|-
|facing ||Direction the NPC faces to. '''It must be set to 0''' in TMW
|-
|height ||the tile height of the spawn area
|-
|Name ||the name of the NPC
|-
|spriteID ||the mob identifier of the desired NPC. Sprite ID
|-
|triggerX ||
|-
|triggerY ||
|-
|eventcode ||the script event to fire upon death
|}
* Server side :
::NPC definitions (script) are usually stored as : (tmwa-server-data/)world/map/npc/<map name>/<NPC Name>.txt or in the file : (tmwa-server-data/)world/map/npc/<map name>/npc.txt
* Client side :
::The NPC is associated with a sprite (the image that will appear in the game), and a XML file which tells the client some display parameters. (tmwa-client-data/)graphics/sprites/npcs/npc-<Name>.png (tmwa-client-data/)graphics/sprites/npcs/npc-<Name>.xml The NPC spriteID is linked to graphic files and XML in the file : (tmwa-client-data/)npcs.xml



== Script Functions ==
function|script|<function name>|<nowiki>{<code>}</nowiki>
Actual script functions are stored or imported in the files : (tmwa-server-data/)world/map/npc/functions/<function name>.txt, regardless rhey are called from a Map, NPC, Mob or item.

==Script Loading==
The main script import file is:[https://github.com/themanaworld/tmwa-server-data/blob/master/world/map/npc/scripts.conf (tmwa-server-data/)world/map/npc/scripts.conf] 
It loads [https://github.com/themanaworld/tmwa-server-data/blob/master/world/map/npc/_import.txt (tmwa-server-data/)world/map/npc/_import.txt] which imports all NPC scripts wich are stored under the respective map name folders, usually under NPC name.

=Examples=
== Open a chest and get reward ==
An example is given by a quest to get a key for a chest (in fact 3 keys):

{| style="width:850px;" border=0 cellspacing="10"
|-valign="Top"
|<pre>
// A treasure chest. You need three keys to open it.
//
// TMW_Quest (document variable here)
//

002-4.gat,93,37,0|script|Treasure|111,{

if (TMW_Quest >= 38) goto L_Finished;

mes "There is a chest here.";
mes "Do you want to try to open it?";
next;
menu
"Yes.", L_Yes,
"No.", -;
close;

L_Yes:
if(countitem("TreasureKey") < 3) goto L_Not_Enough;
getinventorylist;
if (@inventorylist_count == 100 && countitem("TreasureKey") > 3) goto L_TooMany;
mes "You opened the chest and found a short bow!";
delitem "TreasureKey", 3;
getitem "ShortBow", 1;
set TMW_Quest, 38;
close;

L_Not_Enough:
mes "It seems that you do not have the right key for this chest yet...";
close;

L_Finished:
mes "You have already opened this chest.";
close;

L_TooMany:
mes "You do not have enough room to loot this chest. Maybe you should try again later.";
close;
}
</pre>
|}
This script starts with describing the NPC (the chest, NPC sprite 111) and its location (map 002-4 X=93, Y=37, in tiles from top left of the map). Then follows what happens on activation:
First, the variable ''"TMW_Quest"'' is checked to know if the player already accomplished the quest '''(the variable should be documented)''', If he has the script continues at label ''L_Finished'', the player is reminded fe alredy accomplished the task and script finishes, if not the scrip continues. A message is shown (mes), then an option dialog (menu) is displayed with two possible answers : "Yes." or "No.". If the player answers "No." the script stops (close;); if he answers "Yes." the script continues at label ''L_Yes''. Now player is checked to know if he has at least 3 keys, if not script branches to label ''L_Not_Enough'' tells the player he "has not the right key" and script closes. If he has keys enough, his inventory list is retrieved by the built-in function "getinventorylist" and it's content is checked to know if the player will have room enough to store the reward after the 3 keys use. If not, script goes to label ''L_TooMany'' and script close after a warning message, If yes 3 keys are deleted in player's inventory, he gets the reward: a Short Bow and the variable TMW_Quest is set to 38.

For more examples of the current system, check out the current scripts in use by the server. Beware though, this could affect your enjoyment of the game as it does spoil some of the mystery. Here's a link to git so you can view them in your browser:

https://github.com/themanaworld/tmwa-server-data/tree/master/world/map/npc

Note that anything said by an NPC should be put in double quotes ("). You can do that like this: "'''\"'''Hello!'''\"''' she said."
=References=
* [[EAthena Scripting Basics]]
* [[EAthena Scripting Reference]]
* [http://forums.themanaworld.org/viewtopic.php?f=13&t=13653 script cleanup/scripting standards proposal]

Classic:TmwAthena Scripting Standards

2013-01-03T20:21:20Z

Jenalya: Add example about how to indent if-statements.

{{Status_construction}}
{{Status_outdated}}
{{Gaps|Needs to be updated with {{ForumThread|13653}} and {{ForumThread|13672}}, which are generally accepted but there might be more discussion}}

This is an attempt to standardize the eAthena coding. Any suggestions are welcome to be posted on the discussion page before editing.
=Code Formatting=
== Indentation ==
* Code is indented with four spaces.
* Code in the same block should have the same indentation.
* Labels have no indentation.
* Menu options are on their own lines and are indented further.
* When using an if-statement, there should be a line break after the condition and the conditional command should be indented further. An exception to this is a series of if-statements at the beginning of a major code block which use gotos to jump to the correct position in the script. In this case the goto should be in the same line as the if-statement.
Example:
// if-statement and conditional command in the same line, gotos aligned
if (@quest >= 3) goto L_Done;
if (@quest == 2) goto L_Progress;
if (@quest == 1) goto L_Question;

// conditional command in the next line and indented further
if (BaseLevel < 40)
set @cost, 100;

== Whitespaces==
In many places whitespaces can increase readability. Examples are
* When concatenating text and variables:
mes "\"Hello " + strcharinfo(0) + "!\"";
instead of
mes "\"Hello "+strcharinfo(0)+"!\"";
* When assigning values to variables:
set @var, 3;
instead of
set @var,3;
* In menus:
menu
"Yes.", L_Yes,
"No.", L_No;
instead of
menu
"Yes.",L_Yes,
"No.",L_No;

== Code Blocks ==
* Code blocks should be separated from the others in a dinstinct way: insert a blank line between code blocks.
* Individual blocks should be together No blank lines within a block.
* The opening brackets should be at the end of the parent line, not in a new line; the closing ones should be in a line of their own.
* newline between if (condition) and conditional_command, except when conditional_command is a goto at the beginning of a major script block (usually only at the beginning of a script), in which case if there are multiple if statements on adjacent lines, the gotos shall be aligned
'''provide an example'''

Remove unnecessary next;
Remove redundant code such as end; after close;
remove break; instead use end; (requires changing the java converter)
Replace monsters.txt with _mobs.txt except in special cases.
A standard for whitespace and comments.

?
limit line length? (break long strings using + concatentation)
==Labels and Subfunctions==
* newline before every label
* no newline after a label
* Labels should always start with L_, except those that act as a subfunction, which should start with S_. There must not be a fallthrough or goto to a subfunction label.
'''decision pending'''
L_CamelCase: Current practice for labels and I don't think that is worth changing,
L_lower_case:, o11c prefers, especially for things like L_close:
* '''Subfunctions''':'''to be discussed'''
"[...]except those that act as a subfunction, which should start with S_"
Also, what should labels within a subfunction label use? I was thinking LS_ or SL_; loratay currently uses L_SUB_ ... or perhaps this should be refactored out into a standalone function?
''summary'': S_, LS_, SL_, L_SUB_, Sub_, refactor out into a standalone function.
==Comments==
'''to be discussed'''
* o11c suggests:
"^///" lines for documentation
"^// " lines to be commented out code (because that is what my editor uses automatically to disable code)
"^//[^ /]" for "other".
Documentation should maybe have doxygen-like tags?
Dislikes boxed comments.
* Actual
// Yellow dog quests
// author: Saturn
// see bluesageConfig for detailed quest description
// NPC Arthur will not make the code for you...
// uses global vars ... f
// calls global function funkbeat () located at ... f

//#################################################################################
//# bla blabla - By Smith, reviewed by john #
//# GPL v.2 #
//# ... #
//#################################################################################
=Variables=
==Document Variables==
in every file, document every variable as one of:

* # account variable (prefix #) (note that there are also ## variable which didn't work in the stable version of the server)
* permanent player variable (no prefix)
* @ temporary player variable (prefix @) - used after the script close;s or end;s.
* @ dynamic player variable (prefix @) - passed into or out of callsub or callfunc
* @ lexical (local) player variable (prefix @) - used only within the function (scripthelp.txt documents that ".@" means this but I don't know if that works)
* @ local constant (prefix @) - not dependent on the player, used only within the function. e.g. lots of @QUEST_FOO_{SHIFT,MASK}
* $ global permanent variable (prefix $) (I'm not sure if we have any of these right now)
* $ npc permanent variable (prefix $) same as above but only used by one NPC
* $ global temporary variable (prefix $@)
* $@ npc temporary variable (prefix $@) same as above but only used by one NPC, scripthelp.txt mentions prefix "." but I don't know if that works
* special variable (in db/const.txt with a 1 following)
* global constant (in const.txt)

'''If we use a consistent method of documenting these, we can then generate a list of all variables by type.'''

==Variables initialization==
Check for troublesome arrays:
A troublesome array is defined as an array that is not
*initialized all at once
*initialized by appending elements to the end, for use in a menu
Nothing needs to be done, merely document them. I want this information at hand when I design the new scripting language to minimize conversion pains.
I wouldn't be surprised if there were no troublesome arrays at all. If there are only a couple it might be worth refactoring the code to remove them, but that might be a high-level decision which is beyond the scope of this proposal.

Set dynamic and local @variables to 0 before close;
==Naming Variables==

==Using as little variables as you need==
So there are some quests, which require lots of variables.
Think of monster oil quest, Oric and Warum quest etc.

This can often be done by bitmasking:
One variable has 32 bits. So a variabe can store 2^32 different numbers: 4294967296

But sometimes you only need numbers from 0 to 15, but more of these variables.
but numbers in range 0 to 15 can be stored in 4 bits ( 2^4 = 16 different numbers)

Here is an example how to use bitmasking:
[[Media:Tester.txt]]
== Defining Map Objects ==

These sections describe how to define map objects.

=== Warp Definitions ===
Warps are what move players between maps. They can also be used to move players around a single map, if needed. Warps are defined like this:

map1,startX,startY|warp|name|width,height,map2,endX,endY

Key:
{|
|map1 ||the starting map
|-
|startX||the x-coordinate of the starting warp tile
|-
|startY||the y-coordinate of the starting warp tile
|-
|name ||the name of the warp, unused but must be defined
|-
|width ||the width of the warp
|-
|height||the height of the warp
|-
|map2 ||the ending map
|-
|endX ||the x-coordinate of the tile the player will end up on
|-
|endY ||the y-coordinate of the tile the player will end up on
|}

Width and height are described in detail here: [[EAthena Scripting Standards/Warp Details|Warp Details]].

=== Monster Definitions ===
Monsters are defined like this:

<map name>,<x>,<y>,<width>,<height>|monster|<name>|<mobID>,<count>,<spawn1>,<spawn2>,{<eventcode>}

{|
|map name ||the map the monsters should appear on
|-
|x ||the x-coordinate of the spawn tile
|-
|y ||the y-coordinate of the spawn tile
|-
|width ||the tile width of the spawn area
|-
|height ||the tile height of the spawn area
|-
|name ||the name of the mob, unused but must be defined. '''DO NOT''' use the keywords such as "spawn" in this name to avoid conflict with other game systems (magic for example)
|-
|mobID ||the mob identifier of the desired monster (in the monster db)the number to spawn
|-
|count ||the number to spawn
|-
|spawn1 ||the minimum delay between successive spawns (per individual)
|-
|spawn2 ||the minimum delay between death and respawn (per individual)
|-
|eventcode ||the script event to fire upon death
|}
A detailed description of position and area can be found here: [[EAthena Scripting Standards/Mob Details|Mob Details]].

=== NPC Definitions ===
<map name>,<x>,<y>,<facing>|script|<Name>|<spriteID>,<nowiki>{<code>}</nowiki>
<map name>,<x>,<y>,<facing>|script|<Name>|<spriteID>,<triggerX>,<triggerY>,<nowiki>{<code>}</nowiki>

{|
|map name ||the map the monsters should appear on
|-
|x ||the x-coordinate of the spawn tile
|-
|y ||the y-coordinate of the spawn tile
|-
|facing ||Direction the NPC faces to. '''It must be set to 0''' in TMW
|-
|height ||the tile height of the spawn area
|-
|Name ||the name of the NPC
|-
|spriteID ||the mob identifier of the desired NPC. Sprite ID
|-
|triggerX ||
|-
|triggerY ||
|-
|eventcode ||the script event to fire upon death
|}
* Server side :
::NPC definitions (script) are usually stored as : (tmwa-server-data/)world/map/npc/<map name>/<NPC Name>.txt or in the file : (tmwa-server-data/)world/map/npc/<map name>/npc.txt
* Client side :
::The NPC is associated with a sprite (the image that will appear in the game), and a XML file which tells the client some display parameters. (tmwa-client-data/)graphics/sprites/npcs/npc-<Name>.png (tmwa-client-data/)graphics/sprites/npcs/npc-<Name>.xml The NPC spriteID is linked to graphic files and XML in the file : (tmwa-client-data/)npcs.xml



== Script Functions ==
function|script|<function name>|<nowiki>{<code>}</nowiki>
Actual script functions are stored or imported in the files : (tmwa-server-data/)world/map/npc/functions/<function name>.txt, regardless rhey are called from a Map, NPC, Mob or item.

==Script Loading==
The main script import file is:[https://github.com/themanaworld/tmwa-server-data/blob/master/world/map/npc/scripts.conf (tmwa-server-data/)world/map/npc/scripts.conf] 
It loads [https://github.com/themanaworld/tmwa-server-data/blob/master/world/map/npc/_import.txt (tmwa-server-data/)world/map/npc/_import.txt] which imports all NPC scripts wich are stored under the respective map name folders, usually under NPC name.

=Examples=
== Open a chest and get reward ==
An example is given by a quest to get a key for a chest (in fact 3 keys):

{| style="width:850px;" border=0 cellspacing="10"
|-valign="Top"
|<pre>
// A treasure chest. You need three keys to open it.
//
// TMW_Quest (document variable here)
//

002-4.gat,93,37,0|script|Treasure|111,{

if (TMW_Quest >= 38) goto L_Finished;

mes "There is a chest here.";
mes "Do you want to try to open it?";
next;
menu
"Yes.", L_Yes,
"No.", -;
close;

L_Yes:
if(countitem("TreasureKey") < 3) goto L_Not_Enough;
getinventorylist;
if (@inventorylist_count == 100 && countitem("TreasureKey") > 3) goto L_TooMany;
mes "You opened the chest and found a short bow!";
delitem "TreasureKey", 3;
getitem "ShortBow", 1;
set TMW_Quest, 38;
close;

L_Not_Enough:
mes "It seems that you do not have the right key for this chest yet...";
close;

L_Finished:
mes "You have already opened this chest.";
close;

L_TooMany:
mes "You do not have enough room to loot this chest. Maybe you should try again later.";
close;
}
</pre>
|}
This script starts with describing the NPC (the chest, NPC sprite 111) and its location (map 002-4 X=93, Y=37, in tiles from top left of the map). Then follows what happens on activation:
First, the variable ''"TMW_Quest"'' is checked to know if the player already accomplished the quest '''(the variable should be documented)''', If he has the script continues at label ''L_Finished'', the player is reminded fe alredy accomplished the task and script finishes, if not the scrip continues. A message is shown (mes), then an option dialog (menu) is displayed with two possible answers : "Yes." or "No.". If the player answers "No." the script stops (close;); if he answers "Yes." the script continues at label ''L_Yes''. Now player is checked to know if he has at least 3 keys, if not script branches to label ''L_Not_Enough'' tells the player he "has not the right key" and script closes. If he has keys enough, his inventory list is retrieved by the built-in function "getinventorylist" and it's content is checked to know if the player will have room enough to store the reward after the 3 keys use. If not, script goes to label ''L_TooMany'' and script close after a warning message, If yes 3 keys are deleted in player's inventory, he gets the reward: a Short Bow and the variable TMW_Quest is set to 38.

For more examples of the current system, check out the current scripts in use by the server. Beware though, this could affect your enjoyment of the game as it does spoil some of the mystery. Here's a link to git so you can view them in your browser:

https://github.com/themanaworld/tmwa-server-data/tree/master/world/map/npc

Note that anything said by an NPC should be put in double quotes ("). You can do that like this: "'''\"'''Hello!'''\"''' she said."
=References=
* [[EAthena Scripting Basics]]
* [[EAthena Scripting Reference]]
* [http://forums.themanaworld.org/viewtopic.php?f=13&t=13653 script cleanup/scripting standards proposal]

Classic:TmwAthena Scripting Standards

2013-01-03T20:12:10Z

Jenalya: Adding a section about where to put whitespaces to increase readability.

{{Status_construction}}
{{Status_outdated}}
{{Gaps|Needs to be updated with {{ForumThread|13653}} and {{ForumThread|13672}}, which are generally accepted but there might be more discussion}}

This is an attempt to standardize the eAthena coding. Any suggestions are welcome to be posted on the discussion page before editing.
=Code Formatting=
== Indentation ==
* Code is indented with four spaces.
* Code in the same block should have the same indentation.
* Labels have no indentation.
* Menu options are on their own lines and are indented further.
* When using an if-statement, there should be a line break after the condition and the conditional command should be indented further.

== Whitespaces==
In many places whitespaces can increase readability. Examples are
* When concatenating text and variables:
mes "\"Hello " + strcharinfo(0) + "!\"";
instead of
mes "\"Hello "+strcharinfo(0)+"!\"";
* When assigning values to variables:
set @var, 3;
instead of
set @var,3;
* In menus:
menu
"Yes.", L_Yes,
"No.", L_No;
instead of
menu
"Yes.",L_Yes,
"No.",L_No;

== Code Blocks ==
* Code blocks should be separated from the others in a dinstinct way: insert a blank line between code blocks.
* Individual blocks should be together No blank lines within a block.
* The opening brackets should be at the end of the parent line, not in a new line; the closing ones should be in a line of their own.
* newline between if (condition) and conditional_command, except when conditional_command is a goto at the beginning of a major script block (usually only at the beginning of a script), in which case if there are multiple if statements on adjacent lines, the gotos shall be aligned
'''provide an example'''

Remove unnecessary next;
Remove redundant code such as end; after close;
remove break; instead use end; (requires changing the java converter)
Replace monsters.txt with _mobs.txt except in special cases.
A standard for whitespace and comments.

?
limit line length? (break long strings using + concatentation)
==Labels and Subfunctions==
* newline before every label
* no newline after a label
* Labels should always start with L_, except those that act as a subfunction, which should start with S_. There must not be a fallthrough or goto to a subfunction label.
'''decision pending'''
L_CamelCase: Current practice for labels and I don't think that is worth changing,
L_lower_case:, o11c prefers, especially for things like L_close:
* '''Subfunctions''':'''to be discussed'''
"[...]except those that act as a subfunction, which should start with S_"
Also, what should labels within a subfunction label use? I was thinking LS_ or SL_; loratay currently uses L_SUB_ ... or perhaps this should be refactored out into a standalone function?
''summary'': S_, LS_, SL_, L_SUB_, Sub_, refactor out into a standalone function.
==Comments==
'''to be discussed'''
* o11c suggests:
"^///" lines for documentation
"^// " lines to be commented out code (because that is what my editor uses automatically to disable code)
"^//[^ /]" for "other".
Documentation should maybe have doxygen-like tags?
Dislikes boxed comments.
* Actual
// Yellow dog quests
// author: Saturn
// see bluesageConfig for detailed quest description
// NPC Arthur will not make the code for you...
// uses global vars ... f
// calls global function funkbeat () located at ... f

//#################################################################################
//# bla blabla - By Smith, reviewed by john #
//# GPL v.2 #
//# ... #
//#################################################################################
=Variables=
==Document Variables==
in every file, document every variable as one of:

* # account variable (prefix #) (note that there are also ## variable which didn't work in the stable version of the server)
* permanent player variable (no prefix)
* @ temporary player variable (prefix @) - used after the script close;s or end;s.
* @ dynamic player variable (prefix @) - passed into or out of callsub or callfunc
* @ lexical (local) player variable (prefix @) - used only within the function (scripthelp.txt documents that ".@" means this but I don't know if that works)
* @ local constant (prefix @) - not dependent on the player, used only within the function. e.g. lots of @QUEST_FOO_{SHIFT,MASK}
* $ global permanent variable (prefix $) (I'm not sure if we have any of these right now)
* $ npc permanent variable (prefix $) same as above but only used by one NPC
* $ global temporary variable (prefix $@)
* $@ npc temporary variable (prefix $@) same as above but only used by one NPC, scripthelp.txt mentions prefix "." but I don't know if that works
* special variable (in db/const.txt with a 1 following)
* global constant (in const.txt)

'''If we use a consistent method of documenting these, we can then generate a list of all variables by type.'''

==Variables initialization==
Check for troublesome arrays:
A troublesome array is defined as an array that is not
*initialized all at once
*initialized by appending elements to the end, for use in a menu
Nothing needs to be done, merely document them. I want this information at hand when I design the new scripting language to minimize conversion pains.
I wouldn't be surprised if there were no troublesome arrays at all. If there are only a couple it might be worth refactoring the code to remove them, but that might be a high-level decision which is beyond the scope of this proposal.

Set dynamic and local @variables to 0 before close;
==Naming Variables==

==Using as little variables as you need==
So there are some quests, which require lots of variables.
Think of monster oil quest, Oric and Warum quest etc.

This can often be done by bitmasking:
One variable has 32 bits. So a variabe can store 2^32 different numbers: 4294967296

But sometimes you only need numbers from 0 to 15, but more of these variables.
but numbers in range 0 to 15 can be stored in 4 bits ( 2^4 = 16 different numbers)

Here is an example how to use bitmasking:
[[Media:Tester.txt]]
== Defining Map Objects ==

These sections describe how to define map objects.

=== Warp Definitions ===
Warps are what move players between maps. They can also be used to move players around a single map, if needed. Warps are defined like this:

map1,startX,startY|warp|name|width,height,map2,endX,endY

Key:
{|
|map1 ||the starting map
|-
|startX||the x-coordinate of the starting warp tile
|-
|startY||the y-coordinate of the starting warp tile
|-
|name ||the name of the warp, unused but must be defined
|-
|width ||the width of the warp
|-
|height||the height of the warp
|-
|map2 ||the ending map
|-
|endX ||the x-coordinate of the tile the player will end up on
|-
|endY ||the y-coordinate of the tile the player will end up on
|}

Width and height are described in detail here: [[EAthena Scripting Standards/Warp Details|Warp Details]].

=== Monster Definitions ===
Monsters are defined like this:

<map name>,<x>,<y>,<width>,<height>|monster|<name>|<mobID>,<count>,<spawn1>,<spawn2>,{<eventcode>}

{|
|map name ||the map the monsters should appear on
|-
|x ||the x-coordinate of the spawn tile
|-
|y ||the y-coordinate of the spawn tile
|-
|width ||the tile width of the spawn area
|-
|height ||the tile height of the spawn area
|-
|name ||the name of the mob, unused but must be defined. '''DO NOT''' use the keywords such as "spawn" in this name to avoid conflict with other game systems (magic for example)
|-
|mobID ||the mob identifier of the desired monster (in the monster db)the number to spawn
|-
|count ||the number to spawn
|-
|spawn1 ||the minimum delay between successive spawns (per individual)
|-
|spawn2 ||the minimum delay between death and respawn (per individual)
|-
|eventcode ||the script event to fire upon death
|}
A detailed description of position and area can be found here: [[EAthena Scripting Standards/Mob Details|Mob Details]].

=== NPC Definitions ===
<map name>,<x>,<y>,<facing>|script|<Name>|<spriteID>,<nowiki>{<code>}</nowiki>
<map name>,<x>,<y>,<facing>|script|<Name>|<spriteID>,<triggerX>,<triggerY>,<nowiki>{<code>}</nowiki>

{|
|map name ||the map the monsters should appear on
|-
|x ||the x-coordinate of the spawn tile
|-
|y ||the y-coordinate of the spawn tile
|-
|facing ||Direction the NPC faces to. '''It must be set to 0''' in TMW
|-
|height ||the tile height of the spawn area
|-
|Name ||the name of the NPC
|-
|spriteID ||the mob identifier of the desired NPC. Sprite ID
|-
|triggerX ||
|-
|triggerY ||
|-
|eventcode ||the script event to fire upon death
|}
* Server side :
::NPC definitions (script) are usually stored as : (tmwa-server-data/)world/map/npc/<map name>/<NPC Name>.txt or in the file : (tmwa-server-data/)world/map/npc/<map name>/npc.txt
* Client side :
::The NPC is associated with a sprite (the image that will appear in the game), and a XML file which tells the client some display parameters. (tmwa-client-data/)graphics/sprites/npcs/npc-<Name>.png (tmwa-client-data/)graphics/sprites/npcs/npc-<Name>.xml The NPC spriteID is linked to graphic files and XML in the file : (tmwa-client-data/)npcs.xml



== Script Functions ==
function|script|<function name>|<nowiki>{<code>}</nowiki>
Actual script functions are stored or imported in the files : (tmwa-server-data/)world/map/npc/functions/<function name>.txt, regardless rhey are called from a Map, NPC, Mob or item.

==Script Loading==
The main script import file is:[https://github.com/themanaworld/tmwa-server-data/blob/master/world/map/npc/scripts.conf (tmwa-server-data/)world/map/npc/scripts.conf] 
It loads [https://github.com/themanaworld/tmwa-server-data/blob/master/world/map/npc/_import.txt (tmwa-server-data/)world/map/npc/_import.txt] which imports all NPC scripts wich are stored under the respective map name folders, usually under NPC name.

=Examples=
== Open a chest and get reward ==
An example is given by a quest to get a key for a chest (in fact 3 keys):

{| style="width:850px;" border=0 cellspacing="10"
|-valign="Top"
|<pre>
// A treasure chest. You need three keys to open it.
//
// TMW_Quest (document variable here)
//

002-4.gat,93,37,0|script|Treasure|111,{

if (TMW_Quest >= 38) goto L_Finished;

mes "There is a chest here.";
mes "Do you want to try to open it?";
next;
menu
"Yes.", L_Yes,
"No.", -;
close;

L_Yes:
if(countitem("TreasureKey") < 3) goto L_Not_Enough;
getinventorylist;
if (@inventorylist_count == 100 && countitem("TreasureKey") > 3) goto L_TooMany;
mes "You opened the chest and found a short bow!";
delitem "TreasureKey", 3;
getitem "ShortBow", 1;
set TMW_Quest, 38;
close;

L_Not_Enough:
mes "It seems that you do not have the right key for this chest yet...";
close;

L_Finished:
mes "You have already opened this chest.";
close;

L_TooMany:
mes "You do not have enough room to loot this chest. Maybe you should try again later.";
close;
}
</pre>
|}
This script starts with describing the NPC (the chest, NPC sprite 111) and its location (map 002-4 X=93, Y=37, in tiles from top left of the map). Then follows what happens on activation:
First, the variable ''"TMW_Quest"'' is checked to know if the player already accomplished the quest '''(the variable should be documented)''', If he has the script continues at label ''L_Finished'', the player is reminded fe alredy accomplished the task and script finishes, if not the scrip continues. A message is shown (mes), then an option dialog (menu) is displayed with two possible answers : "Yes." or "No.". If the player answers "No." the script stops (close;); if he answers "Yes." the script continues at label ''L_Yes''. Now player is checked to know if he has at least 3 keys, if not script branches to label ''L_Not_Enough'' tells the player he "has not the right key" and script closes. If he has keys enough, his inventory list is retrieved by the built-in function "getinventorylist" and it's content is checked to know if the player will have room enough to store the reward after the 3 keys use. If not, script goes to label ''L_TooMany'' and script close after a warning message, If yes 3 keys are deleted in player's inventory, he gets the reward: a Short Bow and the variable TMW_Quest is set to 38.

For more examples of the current system, check out the current scripts in use by the server. Beware though, this could affect your enjoyment of the game as it does spoil some of the mystery. Here's a link to git so you can view them in your browser:

https://github.com/themanaworld/tmwa-server-data/tree/master/world/map/npc

Note that anything said by an NPC should be put in double quotes ("). You can do that like this: "'''\"'''Hello!'''\"''' she said."
=References=
* [[EAthena Scripting Basics]]
* [[EAthena Scripting Reference]]
* [http://forums.themanaworld.org/viewtopic.php?f=13&t=13653 script cleanup/scripting standards proposal]

Development:Projects and Teams

2012-12-22T19:01:31Z

Jenalya: Add reserved NPC ID to the entry about Hetchel.

<div style="font-size:250%" class="center">'''Projects'''</div>

<div class="center">Here is a list of the current projects under development. You can see the list of developers [[Developers|here]].</div>

{| border="1" cellspacing="0" cellpadding="5"
! style="background:#efdead;" | Project
! style="background:#efdead;" | Team
! style="background:#efdead;" | Description
! style="background:#efdead;" | Monster Reservations
! style="background:#efdead;" | Item Reservations
! style="background:#efdead;" | Map Reservations
! style="background:#efdead;" | New NPCs
! style="background:#efdead;" | Status
|-
| '''Trade City [[Argaes]]'''
| [[User:V0id|V0id]]
| Assassin Guild quest (Miriam follow-up) in Trade City
|
| Assassin Set
|
|
| Scenario writing.
|-
| '''New Desert Area ([[Tonori]])'''
| [[User:Yubaba|Yubaba]]
| Creating Desert maps, area further from Tulimshar and new quests.
| Snake Lord, Desert Monsters
| Snake Skin Armour, Desert bow
|
| Desert/Egyptian NPCs
| Mapping and quest writing in progress
|-
|-
| '''East [[Argaes]]'''
| [[User:Jenalya|Jenalya]], [[User:Tux|tux9th]]
| Extension to the east, including farmlands, port-city, waterfall area
| Farmmobs
| TBA
| 057 - 067
| Farm NPCs
| Mapping in progress
|-
| '''Orum and Waric Continuation'''
| [[User:Jenalya|Jenalya]], [[User:Tux|tux9th]], mrgrey
| Continuation of the Orum and Waric quest.
| Evil Woodland monsters
| Rose hat, magical flowers
| 055, 056
|
| Scripting in progress, graphics for magical flowers needed
|-
| '''Barbarian Village ([[Kaizei]]).'''
| [[User:Jenalya|Jenalya]], [[User:Tux|tux9th]]
| A village of barbarians yet to be named.
| TBA
| TBA
| 049, 050, 053, 054
| Barbarian NPCs
| tilesets missing
|-
| '''Lumber Camp ([[Argaes]])'''
| [[User:o11c|o11c]]
| Southern [[Argaes]] expansion. Quests include: Help the Lumberjacks/Save the Dell (a choice); the Naturalist's Studies; ?
|
|
| 035-039
|
| on hold, graphics missing?
|-
| '''[[Thermin]] ([[Kaizei]])'''
| [[User:Jenalya|Jenalya]], [[User:Alastrim|Alastrim]]
| [[Kaizei]] area town. Once a large town that mined the firerock stones beneath the town, it was devastated by a poison gas leak. During the crisis to survive, they collaborated on several new technologies to both defend the town from the rampaging Yeti surrounding the town and to find ways to get back to using the mine, despite the poison gas problem.
|
| GasMask, Monocle
|
| Gasmask steam punk NPC, clockwork armor NPC, barbarian NPCs, [http://forums.themanaworld.org/viewtopic.php?f=8&t=12839 generic pose NPCs]
| tilesets missing
|-
| '''[[Thermin]] ([[Kaizei]]) Poisonous Mine'''
| [[User:Alastrim|Alastrim]]
| Poison gas mine. A constant moving adventure with puzzles and traps to solve and disarm along the way. Suggestions: Barriers of some type, puzzle mini-games (input code words chosen at random, arrange items, push buttons in a certain order, kill a certain monster on the map), a poison map flag, the use of event monster scripting instead of _mobs.txt spawning.
| Ice Skull, Purple Slime, Acid Goblin, Longjohn, Serqet, Fire Lizard
| Firerock,
| 043
|
| tilesets missing
|-
| '''Crypt'''
| Skipy,[[User:Yubaba|Yubaba]]
| Reaper boss quest
| Reaper, scythe, the lost, ball lightning, vampire bat
| Death's Hand, Reaper blade
|
|
| tileset incomplete, art developer inactive.
|-
| '''Ancient Amulets'''
| [[User:Alastrim|Alastrim]]
| Five quests leading to different Four-Leaf Amulets of different strengh.
| Shadow Elemental (1st Quest)
| Four-Leaf Amulets
| 024-3 to 024-8
| Explorer
| on hold, developer inactive
|-
| '''Kageville'''
| [[User:Kage|Kage]]
| TBA
|
|
| 040
|
| on hold, developer inactive
|-
| '''Hetchel the silk weaver [373] ([[Tulimshar]])'''
| [[User:bh28|bh28]]
| Lora Tay says she can sew Silk Robes provided you give her some silk sheets.and that Hetchel in Tulimshar can weave them for you.
|
| Silk Sheet [881], dyed Silk Sheets [2250 to 2259]
| 021-1
| Hetchel (373)
| Lora Tay script mod, 021-2 : add weaver workshop
|}

<div style="font-size:250%" class="center">'''Teams'''</div>

<div class="center">Here is a list of all the different developer teams. You can see the list of developers [[Developers|here]].</div>

{| border="1" cellspacing="0" cellpadding="5"
! style="background:#efdead;" | Name
! style="background:#efdead;" | Member(s)
! style="background:#efdead;" | Role
|-
| '''The Mana World - Athena Leader'''
| [[User:Jenalya|Jenalya]]
| Coordinates tmwA. Network and delegate tasks. Increase participation.
|-
| '''Content Lead'''
| [[User:Jenalya|Jenalya]]
| Coordinates tmwA General Content (non-sound, non-art).
|-
| '''Source Lead'''
| [[User:o11c|o11c]]
| Adjusts and coordinates Athena source code. Meets content team requests for source code adjustments to further content. Research and development of Athena source code and scripting conventions.
|-
| '''Sound Lead'''
| [[User:Yubaba|Yubaba]]
| Determines if sound on the forums is ready for the game. Encourages people to get involved in sound and encourage players to try their hand at sound. Attempts to meet the [REQ]s of content developers as well as creates any sound that may seem to add to the project, from monsters to maps to battle and beyond.
|-
| '''Pixel Artists'''
| Nami, [[User:Salmondine|Salmondine]]
| Determines if art is ready for the game. Helps categorize art topics. Encourage artists contribute to the game and encourage players to try their hand at art. Understand content priorities and attempt to steer art to meeting art deadlines.
|-
| '''Mapping Lead'''
|
| Reviews maps for the game. Check for proper use of black border, collision tiles, and application of tiles onto the correct layers they belong on. Fix mapping errors.
|-
|}

Development:Projects and Teams

2012-12-18T09:09:32Z

Jenalya: Remove Illia from the list since it has been released.

<div style="font-size:250%" class="center">'''Projects'''</div>

<div class="center">Here is a list of the current projects under development. You can see the list of developers [[Developers|here]].</div>

{| border="1" cellspacing="0" cellpadding="5"
! style="background:#efdead;" | Project
! style="background:#efdead;" | Team
! style="background:#efdead;" | Description
! style="background:#efdead;" | Monster Reservations
! style="background:#efdead;" | Item Reservations
! style="background:#efdead;" | Map Reservations
! style="background:#efdead;" | New NPCs
! style="background:#efdead;" | Status
|-
| '''Trade City [[Argaes]]'''
| [[User:V0id|V0id]]
| Assassin Guild quest (Miriam follow-up) in Trade City
|
| Assassin Set
|
|
| Scenario writing.
|-
| '''New Desert Area'''
| [[User:Yubaba|Yubaba]]
| Creating Desert maps, area further from Tulimshar and new quests.
| Snake Lord, Desert Monsters
| Snake Skin Armour, Desert bow
|
| Desert/Egyptian NPCs
| Mapping and quest writing in progress
|-
|-
| '''East [[Argaes]]'''
| [[User:Jenalya|Jenalya]], [[User:Tux|tux9th]]
| Extension to the east, including farmlands, port-city, waterfall area
| Farmmobs
| TBA
| 057 - 067
| Farm NPCs
| Mapping in progress
|-
| '''Orum and Waric Continuation'''
| [[User:Jenalya|Jenalya]], [[User:Tux|tux9th]], mrgrey
| Continuation of the Orum and Waric quest.
| Evil Woodland monsters
| Rose hat, magical flowers
| 055, 056
|
| Scripting in progress, graphics for magical flowers needed
|-
| '''Barbarian Village'''
| [[User:Jenalya|Jenalya]], [[User:Tux|tux9th]]
| A village of barbarians yet to be named.
| TBA
| TBA
| 049, 050, 053, 054
| Barbarian NPCs
| tilesets missing
|-
| '''Lumber Camp ([[Argaes]])'''
| [[User:o11c|o11c]]
| Southern [[Argaes]] expansion. Quests include: Help the Lumberjacks/Save the Dell (a choice); the Naturalist's Studies; ?
|
|
| 035-039
|
| on hold, graphics missing?
|-
| '''[[Thermin]] ([[Kaizei]])'''
| [[User:Jenalya|Jenalya]], [[User:Alastrim|Alastrim]]
| [[Kaizei]] area town. Once a large town that mined the firerock stones beneath the town, it was devastated by a poison gas leak. During the crisis to survive, they collaborated on several new technologies to both defend the town from the rampaging Yeti surrounding the town and to find ways to get back to using the mine, despite the poison gas problem.
|
| GasMask, Monocle
|
| Gasmask steam punk NPC, clockwork armor NPC, barbarian NPCs, [http://forums.themanaworld.org/viewtopic.php?f=8&t=12839 generic pose NPCs]
| tilesets missing
|-
| '''[[Thermin]] ([[Kaizei]]) Poisonous Mine'''
| [[User:Alastrim|Alastrim]]
| Poison gas mine. A constant moving adventure with puzzles and traps to solve and disarm along the way. Suggestions: Barriers of some type, puzzle mini-games (input code words chosen at random, arrange items, push buttons in a certain order, kill a certain monster on the map), a poison map flag, the use of event monster scripting instead of _mobs.txt spawning.
| Ice Skull, Purple Slime, Acid Goblin, Longjohn, Serqet, Fire Lizard
| Firerock,
| 043
|
| tilesets missing
|-
| '''Crypt'''
| Skipy,[[User:Yubaba|Yubaba]]
| Reaper boss quest
| Reaper, scythe, the lost, ball lightning, vampire bat
| Death's Hand, Reaper blade
|
|
| tileset incomplete, art developer inactive.
|-
| '''Ancient Amulets'''
| [[User:Alastrim|Alastrim]]
| Five quests leading to different Four-Leaf Amulets of different strengh.
| Shadow Elemental (1st Quest)
| Four-Leaf Amulets
| 024-3 to 024-8
| Explorer
| on hold, developer inactive
|-
| '''Kageville'''
| [[User:Kage|Kage]]
| TBA
|
|
| 040
|
| on hold, developer inactive
|}

<div style="font-size:250%" class="center">'''Teams'''</div>

<div class="center">Here is a list of all the different developer teams. You can see the list of developers [[Developers|here]].</div>

{| border="1" cellspacing="0" cellpadding="5"
! style="background:#efdead;" | Name
! style="background:#efdead;" | Member(s)
! style="background:#efdead;" | Role
|-
| '''The Mana World - Athena Leader'''
| [[User:Jenalya|Jenalya]]
| Coordinates tmwA. Network and delegate tasks. Increase participation.
|-
| '''Content Lead'''
| [[User:Jenalya|Jenalya]]
| Coordinates tmwA General Content (non-sound, non-art).
|-
| '''Source Lead'''
| [[User:o11c|o11c]]
| Adjusts and coordinates Athena source code. Meets content team requests for source code adjustments to further content. Research and development of Athena source code and scripting conventions.
|-
| '''Sound Lead'''
| [[User:Yubaba|Yubaba]]
| Determines if sound on the forums is ready for the game. Encourages people to get involved in sound and encourage players to try their hand at sound. Attempts to meet the [REQ]s of content developers as well as creates any sound that may seem to add to the project, from monsters to maps to battle and beyond.
|-
| '''Pixel Artists'''
| Nami, [[User:Salmondine|Salmondine]]
| Determines if art is ready for the game. Helps categorize art topics. Encourage artists contribute to the game and encourage players to try their hand at art. Understand content priorities and attempt to steer art to meeting art deadlines.
|-
| '''Mapping Lead'''
|
| Reviews maps for the game. Check for proper use of black border, collision tiles, and application of tiles onto the correct layers they belong on. Fix mapping errors.
|-
|}

Reporting Bugs

2012-12-05T21:17:49Z

Jenalya: Correct the repositories

==Check that your problem hasn't been reported already==

The only supported client is the '''official client'''. If you have an issue which involve your client switch first to the official client and check if the problem persists before reporting.

First use the '''Search''' feature on the forum to check if the issue you are experiencing was not posted before.: http://forums.themanaworld.org/search.php

For server and content bugs, check the '''mantis''' Bug Tracker, maybe someone already posted same issue and it is being worked on: http://mantis.themanaworld.org/, and for bugs concerning the official client: http://bugs.manasource.org/

Optionally, check the repositories on '''Github''':

*server-code: https://github.com/themanaworld/tmwa

*server-data: https://github.com/themanaworld/tmwa-server-data

*client-data: https://github.com/themanaworld/tmwa-client-data

*client-code: https://github.com/mana

==Where to report?==

===Forum===
If you are not sure that your problem is a bug or you are not sure that you can report it correctly, forum moderators, developers and players will help you or do it for you; report in:
''Board index » Community » Player talk'': http://forums.themanaworld.org/viewforum.php?f=12

You have strong reasons to suspect the content, the server or the client; report in the appropriate forum:
''Board index » Support'': http://forums.themanaworld.org/viewforum.php?f=19

be sure to read: ''Board index » Support » General support » Read Me First: How To Report Bugs'': http://forums.themanaworld.org/viewtopic.php?f=3&t=1178

===IRC===
You are not sure that your problem is a bug:
IRC #support channel : [http://irc.themanaworld.org#tmw-support irc.themanaworld.org#tmw-support]

You are almost sure that your problem is a bug:
IRC #development channel : [http://irc.themanaworld.org#tmw-dev irc.themanaworld.org#tmw-dev]

Your problem concerns the Manaplus Client:
IRC #ManaPlus channel: [http://irc.freenode.org#manaplus irc.freenode.org#manaplus]

===Bug Tracker===
Bug tracker is a powerful tool, users need to be a bit aware of the way game works. Anonymous log-in is possible.

*Content and server: Mantis: http://mantis.themanaworld.org/

*Official Client: Manasource: http://bugs.manasource.org/

*If you issue involves the Manaplus Client, report to http://bugs.evolonline.org/

==How to report?==

Here again the information that the developers need to solve the problem must be as complete and precise as possible.

In Client issues, specify your system name, version and architecture, and client version. It is very good idea to include the name of your OS in the topic title, for example: Windows XP: Game is crashing when...
Be verbose, post backtrace, strace, content of tmw.log, versions of dependent software etc. Make sure that all [[Dependencies]] are installed and have correct versions.

Respect the time of developers and helpers - use descriptive topic titles, subjects like "OMFG game isn't working", "WTF HELP!", "GOT PROBLEM!" are not acceptable, and usually indicates that the author is a person not to be treated seriously. Good topic title is eg.: Linux: Can't load map file - unknown error. Posts which contains rude remarks, foul language or are duplicated will be closed without any notice.

Note that in order to fix a bug, a programmer needs an exact way to reproduce the circumstances which lead to it:
"I had Item X and later I hadn't had it anymore" isn't enough information to pinpoint an issue. On the other hand "when you do X and Y while W and Z, and then you take a towel our of storage, you always get an orange instead" would be a bug description a programmer can actually use.

If you have a patch, post in Technical Development or Content Development:http://forums.themanaworld.org/viewforum.php?f=18 (Content and Server) and http://forums.themanaworld.org/viewforum.php?f=19 for client.

When you use a pastebin, make sure to check the longest possible expiration setting.

'''WIKI errors:'''
Errors on the '''wiki''' should be fixed by the one who notices them - that's the point of a wiki. When the documentation is wrong, you should make it correct.

==Testing==

Before developers release game content onto the official server, they'd like feedback from other developers and playtesters.
If you are interested in content testing watch the [[Testing Server]] page in this wiki.

De:Arkim's Brother

2012-11-07T22:02:19Z

Jenalya: Some spelling and grammar fixes.

{{I18n}}

<div style="font-size:250%" class="center">'''Arkim's Bruder'''</div>

{{Category_playerinfo}}

{| style="float: right" border="0" cellpadding="5"
| {{Quest
| Image = [[Image:NPCMirak.png]]
| Start = 056-2, Miraks house (Woods)
| Level = 25 (required)
| Redoable = Einmal pro 24 h.
| Reward = 20 mal Deine Daily Points in Gold und Erfahrung
}}
|-
| {{Quest_dev
| Scenario = ZdlN, [[User:Tux|Tux9th]]
| Programmer = [[User:Tux|Tux9th]]
| Contributors = -
| Maps = [[User:Tux|Tux9th]]
| Tiles =-
| NPCs = Chef Chelios
| Items =-
| Sound_fx =-
| Music =-
| Testers = V0id, Zdln, Jenalya
}}
|-
|}

== Hintergrundgeschichte ==

Arkim hat einen Bruder. Beide lebten lange zusammen im Hause ihrer Eltern.
Arkim, durchgeknallt wie er ist, nervte seinen Bruder immer, wenn er mal wieder in die Höhlen ging, mit seinen "Experimenten" an Fledermäusen.
Sein Bruder ist nach einiger Zeit vom Familienhaus in ein gekauftes Haus in den Wäldern gezogen, um sich vom Rest der Welt zu erholen. Er liebt es zu meditieren und lesen '''in RUHE'''!
Aber Du, lästige Person, kommst in seine Hütte und störst seine gerade gewonnene Freiheit.
Mirak bevorzugt es zu zahlen, um wieder so schnell wie möglich seine Ruhe zu haben.
Sei gewarnt! Übertreib es nicht, denn Mirak wird sehr leicht zornig (Sagt er über sich selbst). Außerdem hat er gelernt "Bei den Magiern in Tulimshar!"...

== Ablauf ==

Dieser Spoiler dient als Referenz. Du solltest es bevorzugen, Hinweise selbst herauszufinden wie in Rollenspielen üblich...

=== Was zu machen ist: ===

* Mirak's Hause befindet sich in den Wäldern nord-östlich. Eintreten und ''lese'' die Notizen
* Finde deinen Weg zu Mirak und sprich mit ihm. Erstmal wird er Dich ignorieren. Sprich ihn nochmal an und frag nach Gold. Schäm Dich!

=== Hinweise ===

* Warnung: Hast Du Mirak wütend gemacht, oder kommst ohne Energie ([[Daily Quests|Daily Points]]) , wirst Du die Welt der Untoten besuchen und 24 Stunden nicht zurück kommen können.
* Nachdem Mirak Dich bezahlt hat, kannst Du (24 Stunden) keine andere [[Daily Quests]] mehr machen.

'''Belohnung:'''

* 20 mal Deine daily points in Exp
* 20 mal Deine daily points als GP

'''Totale Kosten:'''

* Alle Deine Daily points.

[[Category:Quest]]

Classic:TmwAthena Scripting Standards

2012-10-03T22:19:47Z

Jenalya: /* Indentation */ Update with results from forum discussion.

{{Status_outdated}}
{{Gaps|Needs to be updated with {{ForumThread|13653}} and {{ForumThread|13672}}, which are generally accepted but there might be more discussion}}

This is an attempt to standardize the eAthena coding. Any suggestions are welcome to be posted on the discussion page before editing.

== Indentation ==
Code is indented with four spaces. Code in the same block should have the same indentation. Labels have no indentation. Menu options are on their own lines and are indented further. When using an if-statement, there should be a line break after the condition and the conditional command should be indented further.

== Code Blocks ==
* Code blocks should be separated from the others in a dinstinct way; the best way of doing it is to insert a blank line between code blocks.

* Individual blocks should be together (i.e. without blank lines within them).

* The opening brackets should be at the end of the parent line, not in a new line; the closing ones should be in a line of their own.

== Example ==
An example is given by a quest to get a key for a chest:

{| border=0
|
<pre>
// A treasure chest. You need three keys to open it.
new_5-1.gat,93,37,0 script Treasure 111,{
mes "Would you try to open it?";
next;
menu
"Yup", L_Sure,
"Nope", close;

L_Sure:
if (countitem(537) < 3) goto L_WrongKey;
delitem 537, 3;
getitem 536, 1;
mes "You opened it and found a short sword!";
close;

L_WrongKey:
mes "It seems that this is not the right key...";
close;
}
</pre>
|}

The above script starts with describing the NPC (the chest, NPC sprite 111) and its location. Then follows what happens on activation. A message is shown, then an option dialog is displayed. Then, when the player has less than 3 keys (item id 537), he is told not to have the right key. If he does, the player looses three keys and receives a short sword (item id 536). This quest in particular is questionable as the explanation given to the player doesn't match the implemented behavior (possibly to make the quest more challenging), but I've put it here because it is short and shows one basic way to use the scripting system.

For more examples of the current system, check out the current scripts in use by the server. Beware though, this could affect your enjoyment of the game as it does spoil some of the mystery. Here's a link to git so you can view them in your browser:

http://gitorious.org/tmw-eathena-data/mainline/trees/master/npc

Note that anything said by an NPC should be put in double quotes ("). You can do that like this: "'''\"'''Hello!'''\"''' she said."

==Using as little variables as you need==
So there are some quests, which require lots of variables.
Think of monster oil quest, Oric and Warum quest etc.

This can often be done by bitmasking:
One variable has 32 bits. So a variabe can store 2^32 different numbers: 4294967296

But sometimes you only need numbers from 0 to 15, but more of these variables.
but numbers in range 0 to 15 can be stored in 4 bits ( 2^4 = 16 different numbers)

Here is an example how to use bitmasking:
[[Media:Tester.txt]]
== Defining Map Objects ==
{|border="0" cellspacing="0" cellpadding="2" style="float: right;"
!colspan="2"| Key
|-
| <TAB>
| a tab
|-
| text
| text that must be the same
|-
| ''text''
| text to be changed
|}

These sections describe how to define map objects.

=== Warp Definitions ===
Warps are what move players between maps. They can also be used to move players around a single map, if needed. Warps are defined like this:

''map1'',''startX'',''startY''<TAB>warp<TAB>''name''<TAB>''width'',''height'',''map2'',''endX'',''endY''

Key:
;map1
:the starting map
;startX
:the x-coordinate of the starting warp tile
;startY
:the y-coordinate of the starting warp tile
;name
:the name of the warp, unused but must be defined
;width
:the width of the warp
;height
:the height of the warp
;map2
:the ending map
;endX
:the x-coordinate of the tile the player will end up on
;endY
:the y-coordinate of the tile the player will end up on

Width and height are described in detail here: [[EAthena Scripting Standards/Warp Details|Warp Details]].

=== Monster Definitions ===
Monsters are defined like this:

''map'',''x'',''y'',''width'',''height''<TAB>monster<TAB>''name''<TAB>''mobID'',''count'',''spawn1'',''spawn2'',''event''

;map
:the map the monsters should appear on
;x
:the x-coordinate of the spawn tile
;y
:the y-coordinate of the spawn tile
;width
:the tile width of the spawn area
;height
:the tile height of the spawn area
;name
:the name of the mob, unused but must be defined
;mobID
:the mob identifier of the desired monster (in the monster db)
;count
:the number to spawn
;spawn1
:the minimum delay between successive spawns (per individual)
;spawn2
:the minimum delay between death and respawn (per individual)
;event
:the script event to fire upon death

A detailed description of position and area can be found here: [[EAthena Scripting Standards/Mob Details|Mob Details]].

=== NPC Definitions ===

== Script Functions ==

See [[EAthena Scripting Reference]]

Development:Developers

2012-09-08T20:36:28Z

Jenalya: Update my role

{| border="0" cellspacing="0" cellpadding="5" width="100%" style="border-bottom: 2px solid #efdead"
! style="background:#efdead;" width="150px" align="left" | Username(s)
! style="background:#edfead;" width="100px" align="left" | Name
! style="background:#efdead;" width="170px" align="left" | tmwAthena roles
! style="background:#edfead;" width="170px" align="left" | tmw-manaserv roles
! style="background:#efdead;" width="170px" align="left" | Other roles
! style="background:#edfead;" width="150px" align="left" | Location

{{dev1| [[User:Alastrim|Alastrim]] | - | {{Board|Scripting}} | - | - | Brasil }}
{{dev2| [[User:Argul|Argul (PjotrOrial) ]] | Stefan Beller | {{Board|Scripting, Mapping, Programmer}} | - | - | Germany}}
{{dev1| [[User:Axltrozz|Axltrozz]] | - | - | Tileset and Mapping | IRC Channel Operator | - }}
{{dev2| [[User:bcs|bcs]] | - | - | Pixel art | - | - }}
{{dev1| [[User:Bertram|Bertram]] | Yohann Ferreira | - | - | dev.themanaworld.org services administrator, IRC Channel Operator, Programmer | France}}
{{dev2| [[User:Black_Don|Black Don]] | - | - | Pixel Artist | - | - }}
{{dev1| [[User:Blue112|BlueSoul]] | - | - | Programmer | - | - }}
{{dev2| [[User:Cody_Martin|Cody]] | Cody Martin | - | - | IRC Channel Operator, Programmer | - }}
{{dev1| [[User:Crush|Crush]] | Philipp Sehmisch | Advisor | Programmer | Forum Moderator | Germany}}
{{dev3| [[User:Dark_Mage|Dark Mage]] | - | Scripting, XML | - | Translations (Russian) | Russia}}
{{dev2| [[User:Rodrigo|Pluto]] | Arian Asimi | Pixel artist | Pixel artist | Translations (Shqip) | Kosova}}
{{dev1| [[User:Poison_ivy|Enchilado]] | W E Sayers | {{Board|Art Director, Scripting}} | - | - | Australia}}
{{dev2| [[User:Feline Monstrocity|Feline Monstrocity]]| - | - | Soundscape | - | Wales, UK }}
{{dev1| [[User:Freeyorp|Freeyorp]] | - | - | Balance, Mechanics and Systems Lead | server.themanaworld.org and testing.themanaworld.org Services Administrator, IRC Services Administrator, Forums Administrator, Programmer | NZ}}
{{dev2| [[User:Hal9000|Hal9000]] | Francesco Miglietta | Pixel Artist | - | - | Italy}}
{{dev1| [[User:Irukard|Irukard]] | Krzysztof Daszuta | - | Pixel Artist | Translations (Polish), Facebook Community Page Maintainer | Poland}}
{{dev2| [[User:Ivan|Ivan]] | Ivan Morve | - | Pixel Artist | - | - }}
{{dev1| [[User:Jaxad0127|Jaxad0127]] | Jared Adams | - | - | server.themanaworld.org and testing.themanaworld.org Services Administrator, Website Services Administrator, IRC Channel Administrator, Forums Administrator, Wiki Sysop and Bureaucrat, Mantis Administrator, Programmer | USA}}
{{dev2| [[User:John_Pyle|John P]] | John Pyle | - | Story Lead | - | - }}
{{dev1| [[User:Jenalya|Jenalya]] | - | {{Board|Content Lead, Scripting}} | - | - | Germany}}
{{dev2| [[User:Kage|Kage]] | Chuck Miller | {{Board|Scripting, Programmer}} | - | IRC Channel Operator, Forums Global Moderator, Programmer | USA}}
{{dev1| [[User:krazyjakee|krazyjakee]] | - | - | Soundscape | - | - }}
{{dev2| [[User:Lien|Lien]] | - | Pixel artist, Scripting | - | - | France}}
{{dev1| [[User:Lizandra|Lizandra]] | Filipa Serra e Silva | Pixel artist | - | - | Portugal}}
{{dev2| [[User:Hackgrid|Matt]] | - | - | - | Blabbering idiot | Germany}}
{{dev1| [[User:Meway|Meway]] | - | Pixel artist | Pixel Artist | - | USA}}
{{dev2| [[User:Nmaligec|Nmaligec]] | - | Scripting, XML | - | - | USA}}
{{dev1| [[User:o11c|o11c]] | Ben Longbons | {{Board|Source Lead}} | - | - | Western USA}}
{{dev2| [[User:Platyna|Platyna]] | Zuzanna K. Filutowska | - | - | Server and Network Administrator, IRC Network Administrator, Forums Administrator | Poland}}
{{dev1| [[User:Rotonen|Rotonen]] | Joni Orponen | Advisor | Project Lead | IRC Channel Administrator, Forums Administrator | Finland}}
{{dev2| [[User:Salmondine|Salmondine]] | Mark Dunbar | Pixel artist | - | - | USA}}
{{dev1| [[User:Saturn|Saturn]] | - | - | Soundscape Lead | - | - }}
{{dev2| [[User:Skipy|Skipy]] | - | {{Board|Pixel artist}} | - | - | USA}}
{{dev1| [[User:Wombat|Wombat]] | - | {{Board|Leader}} | - | IRC Channel Operator, Forums Global Moderator, Mantis Administrator | USA}}
{{dev2| [[User:Yubaba|Yubaba]] | - | {{Board|Sound Lead}} | - | - | Canada}}
|}
[[Category:reference]]

==See Also==

* [[Projects and Teams]]
* [[Developer Archive]]
* [[Contributors]]

Development:Projects and Teams

2012-09-08T20:28:32Z

Jenalya: Update 'Teams' section

<div style="font-size:250%" class="center">'''Projects'''</div>

<div class="center">Here is a list of the current projects under development. You can see the list of developers [[Developers|here]].</div>

{| border="1" cellspacing="0" cellpadding="5"
! style="background:#efdead;" | Project
! style="background:#efdead;" | Team
! style="background:#efdead;" | Description
! style="background:#efdead;" | Monster Reservations
! style="background:#efdead;" | Item Reservations
! style="background:#efdead;" | Map Reservations
! style="background:#efdead;" | New NPCs
! style="background:#efdead;" | Status
|-
| '''Farmlands'''
| Jenalya, tux9th
| Creating Farmlands north of Woodland Hills
| Farmmobs
| TBA
| 057 - 067
|
| Mapping in progress
|-
| '''Illia'''
| V0id
| Illia sisters dungeon-like quest
| IDs 1098 to 1103
| IDs 871 to 875
| 051, 052
| IDs 367 to 371
|
|-
| '''Orum and Waric Continuation'''
| Jenalya, tux9th, mrgrey
| Continuation of the Orum and Waric quest.
| Evil Woodland monsters
| Rose hat, magical flowers
| 055, 056
|
| Scripting in progress, graphics for magical flowers needed
|-
| '''Barbarian Village'''
| Jenalya, tux9th
| A village of barbarians yet to be named.
| TBA
| TBA
| 049, 050, 053, 054
| Barbarian NPCs
| tilesets missing
|-
| '''Lumber Camp'''
| O11c
| Southern Argaes expansion. Quests include: Help the Lumberjacks/Save the Dell (a choice); the Naturalist's Studies; ?
|
|
| 035-039
|
| on hold, graphics missing?
|-
| '''Thermin'''
| Jenalya, Alastrim
| Kaizei area town. Once a large town that mined the firerock stones beneath the town, it was devastated by a poison gas leak. During the crisis to survive, they collaborated on several new technologies to both defend the town from the rampaging Yeti surrounding the town and to find ways to get back to using the mine, despite the poison gas problem.
|
| GasMask, Monocle
|
| Gasmask steam punk NPC, clockwork armor NPC, barbarian NPCs, [http://forums.themanaworld.org/viewtopic.php?f=8&t=12839 generic pose NPCs]
| tilesets missing
|-
| '''Thermin Poisonous Mine'''
| Alastrim
| Poison gas mine. A constant moving adventure with puzzles and traps to solve and disarm along the way. Suggestions: Barriers of some type, puzzle mini-games (input code words chosen at random, arrange items, push buttons in a certain order, kill a certain monster on the map), a poison map flag, the use of event monster scripting instead of _mobs.txt spawning.
| Ice Skull, Purple Slime, Acid Goblin, Longjohn, Serqet, Fire Lizard
| Firerock,
| 043
|
| tilesets missing
|-
| '''Crypt'''
|
| Reaper boss quest
| Reaper, scythe, the lost, ball lightning, vampire bat
| Death's Hand, Reaper blade
|
|
| tileset incomplete, developer inactive
|-
| '''Ancient Amulets'''
| Alastrim
| Five quests leading to different Four-Leaf Amulets of different strengh.
| Shadow Elemental (1st Quest)
| Four-Leaf Amulets
| 024-3 to 024-8
| Explorer
| on hold, developer inactive
|-
| '''Kageville'''
| Kage
| TBA
|
|
| 040
|
| on hold, developer inactive
|}

<div style="font-size:250%" class="center">'''Teams'''</div>

<div class="center">Here is a list of all the different developer teams. You can see the list of developers [[Developers|here]].</div>

{| border="1" cellspacing="0" cellpadding="5"
! style="background:#efdead;" | Name
! style="background:#efdead;" | Member(s)
! style="background:#efdead;" | Role
|-
| '''The Mana World - Athena Leader'''
| Jenalya
| Coordinates tmwA. Network and delegate tasks. Increase participation.
|-
| '''Content Lead'''
| Jenalya
| Coordinates tmwA General Content (non-sound, non-art).
|-
| '''Source Lead'''
| o11c
| Adjusts and coordinates Athena source code. Meets content team requests for source code adjustments to further content. Research and development of Athena source code and scripting conventions.
|-
| '''Sound Lead'''
| Yubaba
| Determines if sound on the forums is ready for the game. Encourages people to get involved in sound and encourage players to try their hand at sound. Attempts to meet the [REQ]s of content developers as well as creates any sound that may seem to add to the project, from monsters to maps to battle and beyond.
|-
| '''Pixel Artists'''
| Nami, Salmondine
| Determines if art is ready for the game. Helps categorize art topics. Encourage artists contribute to the game and encourage players to try their hand at art. Understand content priorities and attempt to steer art to meeting art deadlines.
|-
| '''Mapping Lead'''
|
| Reviews maps for the game. Check for proper use of black border, collision tiles, and application of tiles onto the correct layers they belong on. Fix mapping errors.
|-
|}

Development:Projects and Teams

2012-09-08T20:16:20Z

Jenalya: Add new column 'Status'

<div style="font-size:250%" class="center">'''Projects'''</div>

<div class="center">Here is a list of the current projects under development. You can see the list of developers [[Developers|here]].</div>

{| border="1" cellspacing="0" cellpadding="5"
! style="background:#efdead;" | Project
! style="background:#efdead;" | Team
! style="background:#efdead;" | Description
! style="background:#efdead;" | Monster Reservations
! style="background:#efdead;" | Item Reservations
! style="background:#efdead;" | Map Reservations
! style="background:#efdead;" | New NPCs
! style="background:#efdead;" | Status
|-
| '''Farmlands'''
| Jenalya, tux9th
| Creating Farmlands north of Woodland Hills
| Farmmobs
| TBA
| 057 - 067
|
| Mapping in progress
|-
| '''Illia'''
| V0id
| Illia sisters dungeon-like quest
| IDs 1098 to 1103
| IDs 871 to 875
| 051, 052
| IDs 367 to 371
|
|-
| '''Orum and Waric Continuation'''
| Jenalya, tux9th, mrgrey
| Continuation of the Orum and Waric quest.
| Evil Woodland monsters
| Rose hat, magical flowers
| 055, 056
|
| Scripting in progress, graphics for magical flowers needed
|-
| '''Barbarian Village'''
| Jenalya, tux9th
| A village of barbarians yet to be named.
| TBA
| TBA
| 049, 050, 053, 054
| Barbarian NPCs
| tilesets missing
|-
| '''Lumber Camp'''
| O11c
| Southern Argaes expansion. Quests include: Help the Lumberjacks/Save the Dell (a choice); the Naturalist's Studies; ?
|
|
| 035-039
|
| on hold, graphics missing?
|-
| '''Thermin'''
| Jenalya, Alastrim
| Kaizei area town. Once a large town that mined the firerock stones beneath the town, it was devastated by a poison gas leak. During the crisis to survive, they collaborated on several new technologies to both defend the town from the rampaging Yeti surrounding the town and to find ways to get back to using the mine, despite the poison gas problem.
|
| GasMask, Monocle
|
| Gasmask steam punk NPC, clockwork armor NPC, barbarian NPCs, [http://forums.themanaworld.org/viewtopic.php?f=8&t=12839 generic pose NPCs]
| tilesets missing
|-
| '''Thermin Poisonous Mine'''
| Alastrim
| Poison gas mine. A constant moving adventure with puzzles and traps to solve and disarm along the way. Suggestions: Barriers of some type, puzzle mini-games (input code words chosen at random, arrange items, push buttons in a certain order, kill a certain monster on the map), a poison map flag, the use of event monster scripting instead of _mobs.txt spawning.
| Ice Skull, Purple Slime, Acid Goblin, Longjohn, Serqet, Fire Lizard
| Firerock,
| 043
|
| tilesets missing
|-
| '''Crypt'''
|
| Reaper boss quest
| Reaper, scythe, the lost, ball lightning, vampire bat
| Death's Hand, Reaper blade
|
|
| tileset incomplete, developer inactive
|-
| '''Ancient Amulets'''
| Alastrim
| Five quests leading to different Four-Leaf Amulets of different strengh.
| Shadow Elemental (1st Quest)
| Four-Leaf Amulets
| 024-3 to 024-8
| Explorer
| on hold, developer inactive
|-
| '''Kageville'''
| Kage
| TBA
|
|
| 040
|
| on hold, developer inactive
|}

<div style="font-size:250%" class="center">'''Teams'''</div>

<div class="center">Here is a list of all the different developer teams. You can see the list of developers [[Developers|here]].</div>

{| border="1" cellspacing="0" cellpadding="5"
! style="background:#efdead;" | Name
! style="background:#efdead;" | Member(s)
! style="background:#efdead;" | Role
|-
| '''The Mana World - Athena Leader'''
| Wombat
| Coordinates tmwA. Network and delegate tasks. Increase participation.
|-
| '''Content Lead'''
| Jenalya
| Coordinates tmwA General Content (non-sound, non-art).
|-
| '''Source Lead'''
| O11c
| Adjusts and coordinates Athena source code. Meets content team requests for source code adjustments to further content. Research and development of Athena source code and scripting conventions.
|-
| '''Sound Lead'''
| Yubaba
| Determines if sound on the forums is ready for the game. Encourages people to get involved in sound and encourage players to try their hand at sound. Attempts to meet the [REQ]s of content developers as well as creates any sound that may seem to add to the project, from monsters to maps to battle and beyond.
|-
| '''Pixel Artists'''
| Wombat, Meway, Irukard, Lizandra, Salmondine, Ejlol, Var
| Determines if art is ready for the game. Helps categorize art topics. Encourage artists contribute to the game and encourage players to try their hand at art. Understand content priorities and attempt to steer art to meeting art deadlines.
|-
| '''tmwA Development Board'''
| Wombat, Jenalya, O11c, Argul, Alastrim
| Helps coordinate the game through Development Board discussion and proposals.
|-
| '''Monster Skills Lead'''
|
| Research and development with monster skills for complex monsters.
|-
| '''XML Lead'''
|
| Fixes item, equipment, monsters, particles, player-set etc. images and xml for game animation.
|-
| '''Mapping Lead'''
|
| Reviews maps for the game. Check for proper use of black border, collision tiles, and application of tiles onto the correct layers they belong on. Fix mapping errors.
|-
| '''Skills and Magic Team'''
| Jenalya, Argul
| Research and development of skills and magic.
|-
| '''Balance'''
|
| Create a new balance system that can be understood by present and future tmwAthena developers and uses equipment tiers.
|-
| '''Alpha Server'''
| Frost, Jenalya, alastrim
| First line of defense against bugs. Pulls from the server-test repository.
|}

Development:How to Develop

2012-08-04T19:29:55Z

Jenalya: Use upper case for 'Git'

We're using Git as version control system for our source files and content. Have a look at our [http://wiki.themanaworld.org/index.php/Working_With_Git Tutorial] about how to use Git.
=Set Up=
This is a how to help content development for official TMW-eA using Ubuntu and the Mana client. Other OS and clients may differ. Following this guide, you should be able to get development testing versions of the client data (tmwdata), server-data (eathena-data) and participate in development by using a localhost server. After getting these, you can both test current development and begin development in the direction you find most fitting.

==Dependencies==
In addition to the basic build tools (GCC, Make, headers, ...), Bison, and Flex are needed.

'''Debian derivates (including Ubuntu)'''
* Open a terminal.
* ''sudo apt-get install build-essential flex bison''

==Set Up Own Server==
'''Here are the steps to use when creating a new local testing server.'''
* Open a terminal.
* ''mkdir ~/tmw-ea''
* ''cd ~/tmw-ea/''
* ''git clone git://gitorious.org/tmw-eathena/mainline.git eathena''
* ''git clone --recursive git://github.com/themanaworld/tmwa-server-data.git eathena-data''
* ''cd eathena/''
* If you are running an older version of make: ''mkdir -p obj/{common,login,char,map,ladmin,tool}''. Debian and Ubuntu, in particular are famous for still not having Make 3.82, which is a much more compliant implementation. If you are technically inclined, I recommend installing it in /usr/local. -o11c
* ''make''
* ''sudo make install'' (you can use prefix=/path to install somewhere other than /usr/local)
* ''git config --global url.git@gitorious.org:.pushInsteadOf git://gitorious.org'' {{ref|push}} {{ref|once}}
* ''git config --global url.git@github.com:.pushInsteadOf git://github.com'' {{ref|push}} {{ref|once}}
* ''cd ../eathena-data''
* Preferably, add the update hooks.
** ''ln -s ../../git/hooks/post-merge .git/hooks/''
** ''ln -s ../../../../git/hooks/post-merge .git/modules/client-data/hooks/'' (git 1.7.8 or newer)
** ''ln -s ../../../git/hooks/post-merge client-data/.git/hooks/'' (git 1.7.7 or older)
* ''make conf''
* ''cd client-data''
* ''git checkout master''
* ''cd music''
* ''git checkout master''

'''You can now launch your test server.'''
* Open a terminal.
* ''cd ~/tmw-ea/eathena-data/''
* ''./char-server& ./login-server& ./map-server&''
* Open another terminal.
* ''mana --server localhost --port 6901 -u -d ~/tmw-ea/eathena-data/client-data''
This should run all three of your servers and the client.

'''Make yourself a GM so you can test changes made.'''
See [[#Administration]]

'''See also:''' [[GM Commands]]

'''You are now free to do some changes, first close the client and your servers.'''

'''''Notes for client data changes: 1) commit and push them in the client-data repo 2) commit and push "client-data" when it shows "(new commits)" in your server-data 3) commit and push other server data changes.'''''
* Make your modifications (e.g. Change a map) and save them.
* Open a terminal.
* ''cd ~/tmw-ea/eathena-data/client-data''
* ''git status''
* ''git add [modified files]''
* ''git commit''
* ''git push'' {{note|push}}
* ''cd ..''
* ''make maps'' (if you changed a map)
* ''git status''
* ''git add [modified files]''
* ''git add client-data'' (if ''git status'' shows ''(new commits)''. '''Don't do this if you don't have push access to client-data!''')
* ''git commit''
* ''git push'' {{note|push}}
* Close the terminal.

{{note|push}} : a step for those with commit access to the remote repositories. For others, you don't need to reconfigure your clone and please make a patch on steps where ''git push'' is suggested.

{{note|once}} : you only need to do this once, no matter how many times you independently clone the repositories.

*''git format-patch -M -C origin/master''
* pastebin the patch(es) and post for review at irc.themanaworld.org channel: #tmw-dev or on our [http://forums.themanaworld.org/viewforum.php?f=18 development forums]. '''Extensive patches must be posted on the forum as a series of well-formed patches with descriptive commit messages.''' In particular, later patches should not fix errors introduced in earlier patches, and each patch should form a logically independent part.

(This is kind of outdated; with github it's often easier to do patches on branches there)

'''You can also pull the data which has been modified.'''
* Open a terminal.
* ''cd ~/tmw-ea/eathena-data''
* ''git pull''
* If you haven't installed the hook, ''git submodule update --merge'' at toplevel (for client-data) and in client-data (for music)
* Close the terminal.

'''See Also:''' [http://wiki.themanaworld.org/images/3/33/README.mv.txt README.mv.txt] - Documentation on using git submodules, like client-data and tmw-music.

== Administration ==
# Start the servers.
# Open a command line terminal.
# cd ~/tmw-ea/eathena-data/login
# ladmin (not ./ladmin)
# add username M password
# gm username 99

== Connecting ==
# Open a command line terminal.
# Run your client pointing to your client data and your local server. E.g. mana -u -d ~/tmw-ea/tmwdata --server localhost --port 6901

If all goes well, you are now ready to test new content and participate with development.

=Making Content=
==Making Map Content==
See [[Mapping Tutorial]].
===Python Converter Tool===
After editing maps for the client, you need to generate the walkmaps and imports for the server.

To run it, just do:

# cd ~/tmw-ea/eathena-data/
# make maps

After that, commit and push the files that the converter edited. Note that, if you do not have push access to the main repository, you should let someone else update the submodule itself.

==Getting Art Content Into The Game==
* Post [CPT] or [WIP] art on the [http://forums.themanaworld.org/viewforum.php?f=8 graphics development forum].
* Work with the Art Director and collaborators on getting the art consistent.
* When finished, edit topic as [FND].
* Art Director approves [FND] art and marks it [RC]. Should the art need animation or special effect, the Art Director requests xml for it. If not, the Art Director commits it and marks as [GIT].
* XML Team reviews or drafts xml related to the art, then commits the .png and .xml. Topic can be marked as [GIT].
::* Art content affected: client-data/graphics/sprites then related directory for .png and .xml animation addition.
* Project developer requests database entry reservations from a General Content Team developer.
::* Map entry server data affected: resnametable.txt and .wlk files in the data directory, map content files in the npc directory.
::* Map entry client data affected: .tmx files in the maps directory.
::* Map entry requires the running of the .tmx converter (aka java converter) before commits can be made.
::* Art content server data affected: entry made in the item_db.txt, mob_db.txt or mob_skills_db.txt in the db directory.
::* Art content client data affected: entry added in items.xml, monsters.xml or other identification file.

===Handling General Content Team [REQ]s===
* General Content Team member adds a [REQ] topic to the graphics development forum.
* General Content Team member adds the [REQ] topic as a hyperlink under "Required Art" on the [[Art in Development]] page.
* Art Director attempts to network with other artists to assign the art to an artist.

==Bit Masking==
Bit Masking helps us reduce our variable count while offering a dynamic method of script writing that is versatile and flexible to both linear and non-linear script writing.

[http://dl.dropbox.com/u/6520164/tester1.txt Bit Masking Test Script]

Development:How to Develop

2012-08-04T19:29:21Z

Jenalya: Add link to Working_With_Git

We're using Git as version control system for our source files and content. Have a look at our [http://wiki.themanaworld.org/index.php/Working_With_Git Tutorial] about how to use git.
=Set Up=
This is a how to help content development for official TMW-eA using Ubuntu and the Mana client. Other OS and clients may differ. Following this guide, you should be able to get development testing versions of the client data (tmwdata), server-data (eathena-data) and participate in development by using a localhost server. After getting these, you can both test current development and begin development in the direction you find most fitting.

==Dependencies==
In addition to the basic build tools (GCC, Make, headers, ...), Bison, and Flex are needed.

'''Debian derivates (including Ubuntu)'''
* Open a terminal.
* ''sudo apt-get install build-essential flex bison''

==Set Up Own Server==
'''Here are the steps to use when creating a new local testing server.'''
* Open a terminal.
* ''mkdir ~/tmw-ea''
* ''cd ~/tmw-ea/''
* ''git clone git://gitorious.org/tmw-eathena/mainline.git eathena''
* ''git clone --recursive git://github.com/themanaworld/tmwa-server-data.git eathena-data''
* ''cd eathena/''
* If you are running an older version of make: ''mkdir -p obj/{common,login,char,map,ladmin,tool}''. Debian and Ubuntu, in particular are famous for still not having Make 3.82, which is a much more compliant implementation. If you are technically inclined, I recommend installing it in /usr/local. -o11c
* ''make''
* ''sudo make install'' (you can use prefix=/path to install somewhere other than /usr/local)
* ''git config --global url.git@gitorious.org:.pushInsteadOf git://gitorious.org'' {{ref|push}} {{ref|once}}
* ''git config --global url.git@github.com:.pushInsteadOf git://github.com'' {{ref|push}} {{ref|once}}
* ''cd ../eathena-data''
* Preferably, add the update hooks.
** ''ln -s ../../git/hooks/post-merge .git/hooks/''
** ''ln -s ../../../../git/hooks/post-merge .git/modules/client-data/hooks/'' (git 1.7.8 or newer)
** ''ln -s ../../../git/hooks/post-merge client-data/.git/hooks/'' (git 1.7.7 or older)
* ''make conf''
* ''cd client-data''
* ''git checkout master''
* ''cd music''
* ''git checkout master''

'''You can now launch your test server.'''
* Open a terminal.
* ''cd ~/tmw-ea/eathena-data/''
* ''./char-server& ./login-server& ./map-server&''
* Open another terminal.
* ''mana --server localhost --port 6901 -u -d ~/tmw-ea/eathena-data/client-data''
This should run all three of your servers and the client.

'''Make yourself a GM so you can test changes made.'''
See [[#Administration]]

'''See also:''' [[GM Commands]]

'''You are now free to do some changes, first close the client and your servers.'''

'''''Notes for client data changes: 1) commit and push them in the client-data repo 2) commit and push "client-data" when it shows "(new commits)" in your server-data 3) commit and push other server data changes.'''''
* Make your modifications (e.g. Change a map) and save them.
* Open a terminal.
* ''cd ~/tmw-ea/eathena-data/client-data''
* ''git status''
* ''git add [modified files]''
* ''git commit''
* ''git push'' {{note|push}}
* ''cd ..''
* ''make maps'' (if you changed a map)
* ''git status''
* ''git add [modified files]''
* ''git add client-data'' (if ''git status'' shows ''(new commits)''. '''Don't do this if you don't have push access to client-data!''')
* ''git commit''
* ''git push'' {{note|push}}
* Close the terminal.

{{note|push}} : a step for those with commit access to the remote repositories. For others, you don't need to reconfigure your clone and please make a patch on steps where ''git push'' is suggested.

{{note|once}} : you only need to do this once, no matter how many times you independently clone the repositories.

*''git format-patch -M -C origin/master''
* pastebin the patch(es) and post for review at irc.themanaworld.org channel: #tmw-dev or on our [http://forums.themanaworld.org/viewforum.php?f=18 development forums]. '''Extensive patches must be posted on the forum as a series of well-formed patches with descriptive commit messages.''' In particular, later patches should not fix errors introduced in earlier patches, and each patch should form a logically independent part.

(This is kind of outdated; with github it's often easier to do patches on branches there)

'''You can also pull the data which has been modified.'''
* Open a terminal.
* ''cd ~/tmw-ea/eathena-data''
* ''git pull''
* If you haven't installed the hook, ''git submodule update --merge'' at toplevel (for client-data) and in client-data (for music)
* Close the terminal.

'''See Also:''' [http://wiki.themanaworld.org/images/3/33/README.mv.txt README.mv.txt] - Documentation on using git submodules, like client-data and tmw-music.

== Administration ==
# Start the servers.
# Open a command line terminal.
# cd ~/tmw-ea/eathena-data/login
# ladmin (not ./ladmin)
# add username M password
# gm username 99

== Connecting ==
# Open a command line terminal.
# Run your client pointing to your client data and your local server. E.g. mana -u -d ~/tmw-ea/tmwdata --server localhost --port 6901

If all goes well, you are now ready to test new content and participate with development.

=Making Content=
==Making Map Content==
See [[Mapping Tutorial]].
===Python Converter Tool===
After editing maps for the client, you need to generate the walkmaps and imports for the server.

To run it, just do:

# cd ~/tmw-ea/eathena-data/
# make maps

After that, commit and push the files that the converter edited. Note that, if you do not have push access to the main repository, you should let someone else update the submodule itself.

==Getting Art Content Into The Game==
* Post [CPT] or [WIP] art on the [http://forums.themanaworld.org/viewforum.php?f=8 graphics development forum].
* Work with the Art Director and collaborators on getting the art consistent.
* When finished, edit topic as [FND].
* Art Director approves [FND] art and marks it [RC]. Should the art need animation or special effect, the Art Director requests xml for it. If not, the Art Director commits it and marks as [GIT].
* XML Team reviews or drafts xml related to the art, then commits the .png and .xml. Topic can be marked as [GIT].
::* Art content affected: client-data/graphics/sprites then related directory for .png and .xml animation addition.
* Project developer requests database entry reservations from a General Content Team developer.
::* Map entry server data affected: resnametable.txt and .wlk files in the data directory, map content files in the npc directory.
::* Map entry client data affected: .tmx files in the maps directory.
::* Map entry requires the running of the .tmx converter (aka java converter) before commits can be made.
::* Art content server data affected: entry made in the item_db.txt, mob_db.txt or mob_skills_db.txt in the db directory.
::* Art content client data affected: entry added in items.xml, monsters.xml or other identification file.

===Handling General Content Team [REQ]s===
* General Content Team member adds a [REQ] topic to the graphics development forum.
* General Content Team member adds the [REQ] topic as a hyperlink under "Required Art" on the [[Art in Development]] page.
* Art Director attempts to network with other artists to assign the art to an artist.

==Bit Masking==
Bit Masking helps us reduce our variable count while offering a dynamic method of script writing that is versatile and flexible to both linear and non-linear script writing.

[http://dl.dropbox.com/u/6520164/tester1.txt Bit Masking Test Script]

Development:Mapping Tutorial

2012-08-04T19:24:20Z

Jenalya: /* Sending the map to the dev team */ Remove mailing list, as this isn't really used anymore, and add Fork on Github as option to submit a map.

{{Status_green}}

'''This tutorial is still based on the old, java-based version of Tiled, not on the rewrite based on QT. While most TMW-specific information in this article still applies, some GUI elements might not be where this guide describes them.'''

== Basics ==
Making maps for The Mana World is not a task that requires a lot of knowledge but is a very good way to become creative and help the game to become more attractive. But getting started can be a little frustrating. Here is a guide that will help you to learn how to make maps.

=== Folders ===
You need to use a certain folder structure when mapping for TMW:
*(some folder)
**graphics
***tiles
****The graphics for the tilesets (png files)
**tilesets
***The external tilesets (tsx files)
**maps
***The actual maps (tmx files)

=== How to get Tiled ===
The map editor we are using is called Tiled. You can find it at http://mapeditor.org/.

=== Setting up the data files ===

To create a map, you will first need some graphics, as well as existing maps to use for reference.

You can get all the files in the right directory structure by cloning the "tmwdata" project from our [[Git repository]].

Alternatively, you can use the data files that are downloaded while playing the game. When you downloaded TMW as an installer packet, all map graphics were downloaded at the start of TMW from the update server and stored in the subfolder "\.tmw\updates" of your home directory as zip archives. Unpack these into the "data" subfolder of your TMW installation.

=== Setting up Tiled for making TMW Maps ===

Tiled is a map editor that isn't made specifically for TMW. That means it has a lot of options and settings we don't need.
[[Image:Maptutorial_Newmap.png|right|Settings for a new tmw map]]
To create a new map, press File->New. Use the following settings:

* Map Type: Orthogonal
* Tile Size: 32x32
* Tile Spacing: 0
* Map Size: Should be at least 60x60 but not larger than 200x200 (although the theoretical maximum is much higher). A 20 tile border around the outside of every map is needed ([[Map development/Border|diagram]]). Additionally, a 20 tile border is recommended between rooms for indoor maps; this is to prevent more than one room from showing at a time on the client.
** In the Argaes woodland, outdoor maps should be 150x120, including the 20 tile border.

=== Importing tilesets ===
[[Image:Maptutorial_Newtileset.png|right|Settings for importing a tileset]]
Now you have to choose the tilesets you want to use on the map. To import a tileset, select Tilesets->Add External Tileset and select the appropriate tsx file from ../tilesets/

If you need to add a tileset that has never been used before:
* Choose Map->New Tileset:
* Hit browse and select the tileset from graphics/tiles/. The name will be auto-filled.
* If the tileset is oversized, adjust the tile height (to 64 for an _x2 tileset; 96 for an _x3, etc.)
* Click OK.
* In the tileset pane, click the "export" button and browse to the ../tilesets/ directory. Save it with the same name, but with a .tsx extension.

Please try to import tilesets in the same order as other maps, and try to eliminate unused tilesets except when necessary to preserve the order. Add remaining tilesets at the end.

You can list the tileset order of existing maps by running tools/list-tileset-order.

The collision tileset should always be first, and the most-used tileset second. This is a good indicator of which existing pattern to follow, or whether you have enough justification to make a new order.

=== Starting to map ===
Now you can finally start to map. To place tiles on the map, select the pen tool from the toolbox to the left. Then select a tile from the tile palette. Now you can place the tiles on the map. Please, always take notice of what layer you are drawing on, because the layers play different roles:
*Use a layer beneath the "Fringe" layer for tiles without transparency. The layers beneath fringe have to be filled completely before you can call the map finished. When there are partially transparent tiles without completely opaque tiles on a layer below, strange graphic bugs will appear in the empty area.
*The "Fringe" Layer itself is for oversized tiles which have to be drawn in front of or behind moving objects, depending on their location. This sorting takes up CPU, making the game run slower. Thus, you should only use this layer for the tiles which have to use it.
*Layers above the "Fringe" layer are always drawn over the map sprites. It should be used for objects which are meant to look as if they are far above the game area. Keep in mind that there are also monsters which are larger than player characters.
*The "Collision" Layer isn't displayed in the game. It contains information about which parts of the map are walkable and which aren't. Don't put any tiles on this layer except for the red collision tiles from the collision tileset.

When you are finished with your map, you have to determine which tiles are walkable and which aren't. To do so, mark all tiles you want to be blocked with the red squares from the collision tileset on the collision layer. Be careful that even if a tile is not reachable, but is walkable, the server can spawn monsters there which can not be killed by the players because they can't reach them. This will eventually lead to all monsters accumulating in the unreachable area until there are no monsters left in the reachable areas.

You can check if you did this properly by saving the map, zooming out until the entire map is visible, hiding all layers except for the collision layer, and then using the flood fill tool with the cross tile on the empty area. Any tiles which are still unmarked are not reachable by the players.

Be aware that you need a border of about 20 tiles in every direction that should not be walkable, but should be designed properly ([[Map development/Border|diagram]]). Portals to other maps should only be some tiles wide. (You can't define the portals with Tiled, by the way. Leave this to the server administrators. The same applies to monster population, NPCs and other interactive objects.)

=== Testing your map ===

To test your map, you have to replace one of the maps in your TMW folder (in the sub folder data/maps). When you start the game and go to the map you replaced you will see your new map. You will see monsters and other players on the map, but don't worry-- the other players still see their version of the map, and they won't see you walk through walls. Just ignore them while you explore your map.

Sometimes your changed map is overridden by a new version of the map in the updates. In that case, you won't see any changes when you change or even remove a map. When you encounter this problem, either skip the update loading by starting tmw with the parameter "-u", or delete the file you want to change in all the zip archives you find in the subfolder /updates/.

== Intermediate topics ==

=== Over sized tiles ===

You might have noticed the tilesets ending with _x2.png or _x3.png contain graphics that are two or three tiles high. The graphics engine recognizes these oversized tiles when they are placed and automatically draws sprites in front of them when they are south of them and behind them when they are north of them. When importing a _x2 tileset, set the tile height to 64; when importing a _x3 tileset, set it to 96.

=== The Stamp ===

The Stamp Feature is a powerful feature of Tiled that is hard to find but can save a lot of time. It allows you to do quick copy/pasting of a part of a layer. This allows you to draw objects consisting of multiple tiles very quick. Just select the pen tool, press the right mouse button, and drag the mouse over the tiles you want to copy. Now you can draw the whole square of tiles over and over again with a single left click. To return to the normal drawing mode, just select the pen tool again or choose a tile from the tile palette.

=== Making two maps with a fluent transition ===

When you create an outdoor map, it is most likely supposed to be adjacent to an existing map. In this case, the transmission from one map to the other should be as seamless as possible. This can only be reached when the border areas of both maps are identical. Unfortunately, Tiled can't copy/paste between different maps (well, it is possible, but it only works correctly when both maps use exactly the same tilesets in exactly the same order), so we developed a command-line based program called TMXcopy for this task. You can find the sourcecode on the GIT repository in the folder http://gitorious.org/tmw/mainline/trees/master/tools/tmxcopy . A compiled windows binary can be found at http://www.crushnet.org/TempFiles/tmw/tmxcopy.zip .

An introduction on how to use this program is described in its [http://gitorious.org/tmw/mainline/blobs/HEAD/tools/tmxcopy/readme.txt readme file].

To create a map adjacent to an existing one, you should:
# Create the new map as described above, and save it.
# Use TMXcopy to copy the border area of the old map to the opposite side of the new map. The area should have the double width of the unwalkable area.
# Open the new map and check if the copying worked correctly. Then modify the lower three layers of the copied area to fit into your map. While doing so, you should focus on the half of the new area that is inside the walkable area of your map. The half that lies in the border zone of your map should not be modified too much because it is part of the old map.
# Use TMXCopy to copy the new area from the new map back to the old map.
# Update the collision layers on both maps.

Now the border area should be visually identical on both maps. The only difference should be that the unwalkable areas are switched. When sending the map to the team, remember to include the new version of the old map.

=== Ambient effects ===
[[Image:Maptutorial_Overlayproperties.png|right|Example for 3 independent scrolling overlays]]
Ambient Effects are a new feature in TMW 0.0.21. They are either background images drawn at places where you place no tiles or tiles with transparency or they are transparent graphics that will be drawn over your map. All these graphics can scroll independent. They can be used to create a variety of special effects like weather, darkness etc.

To add ambient effects to your map open your map with Tiled and click Map->Properties to open the map properties dialog. The dialog is a little bit buggy in the current version of Tiled, so make sure that the property has really been set before you save the map. Pressing enter after entering each key and value helps... sometimes.

==== adding foreground images ====
First you have to choose an image. Do so by adding a key ''foreground0image'' and set its value to the path of the image that you want to use relative to the data directory. For the spotlight effect for example enter ''/graphics/images/ambient/spotlight.png''.

When you want the image to move permanently add the new keys ''foreground0scrollX'' and ''foreground0scrollY'' followed by a number (can be a decimal value). ''foreground0scrollX'' determines the scroll speed to the right (negative values mean scrolling to the left) and ''foreground0scrollY'' the scroll speed down (negative values mean up). both values are in pixels per frame.

You can also define a ''foreground0parallax'' parameter. This parameter affects how much the overlay scrolls when the screen scrolls. A value of 1.0 means that the overlay will stay relative to the ground when the screen scrolls. A value of 0.0 means that the overlay stays relative to the "camera" and is not affected by scrolling. It is a decimal value so you can set it to values between 1 and 0 to create the three dimensional illusion of a layer between the "camera" and the map.

When using foregrounds at different resolutions, some would become disproportioned (for instance, the halo in cave maps that had to fill the screen repeated it self in higher resolution than 800x600.). That why, the keepratio parameter has been added: It will scaled up or down the image based on the current resolution.

Remember that the scaling factor is based on the default 800x600 resolution, so new overlay images are to be fitted for that resolution to make this parameter work.
(The image scaling in 1024x768 resolution mode, for instance, will be calculated this way: New Image Width = image-width / 800 * 1024, New Image Height = image-height / 600 * 768).

To add this parameter to your foreground configuration, you'll have to define the ''foreground0keepratio'' to the ''true'' value.

You can create any number of independent foreground graphics. To define a 2nd one create keys with 1 instead of 0, for a 3rd one 2, and so on. For instance ''foreground2parallax'' for the third foreground parallax value.

The foregrounds won't appear in Tiled. They will only appear in the game.

When it doesn't work please check that all key names are written correctly (they are cAsEsEnSiTiVe) and that the numbers of the foreground are consecutive starting from 0.

When you want to create foreground images yourself (transparent 32bit png graphics of any size) please don't forget to make them transparent with your image manipulation program. Otherwise the player won't be able to see the map under it. An opacity of 50% should be the absolute maximum. When you want to create effects that are not meant to obstruct the players view use an opacity between 10% and 20%.

For historical reasons you can also use "overlay" in place of "foreground". You will notice this annotation in older map files. Please don't do it and use "foreground" instead, "overlay" is depreciated.

==== adding background images====

Backgrounds are added in the same way foregrounds are, with the exceptions that the property keys don't start with the prefix foreground but with background. They use their own numbering, so you have to number your backgrounds 0, 1, 2 etc. no matter if you have foregrounds or not.
''background0image''
''background0scrollY''
''background0scrollX''
''background0keepratio''
In contrary to all other fore- or background images the first background (background0image) must not have any transparency but should be 100% opaque. Otherwise ugly graphic bugs will appear.

=== Particle effects ===

Check out the article about the [[Particle engine]] for a description about how to add particle effects to your map and how to create new particle effects when the effect you need doesn't exist yet.

=== Animated tiles ===
To make a type of tiles animated go to Tilesets->Tileset Manager. Then select the tileset with the tile and all of its animation frames (they have to be on one tileset) and click on the icon with a pencil on a piece of paper (the tooltip reads "Edit...").

Select the tile you want to be animated on the list to the left. You should see a table on the right with two columns named "Name" and "Value". You have to describe the animation of the tile in this table. Here an example for a 3-phase animation:

NAME VALUE
animation-frame0 0
animation-delay0 100
animation-frame1 16
animation-delay1 100
animation-frame2 48
animation-delay2 100

animation-frameX is the Tile number (as shown in the list on the left) and animation-delayX is how long it is shown (100 is equal to one second).

The animation does not show up in Tiled.

== Advanced Topics/Adding a map to the server ==
To get the server to use your new map without replacing the old one, you'll have to create a wlk file (see below). Then edit the data/resnametable.txt file, you'll notice the pattern. Finally, in the npc directory create a directory for your new map, and create a file named _import.txt with the contents:

map: <map_name>.gat

In npc/_import.txt include your new _import.txt file like all the others.

The clients still need direct access to the tmw file. To do this put it in an udpate or put it in the ~/.tmw/maps/ directory for every client that needs access to the map.

=== Creating the WLK files ===
You can either use the tool found in the tools/tmwcon/ directory of the server-data package or use the export plugin that ships with recent java versions of tiled. To use the export plugin go file->Save As and under filetype select the wlk extention, or just name the file with that extention.

== Creating a Minimap ==

The Creation of a minimap is a task that requires an image manipulation software that supports multiple layers and the PNG format (we recommend [http://www.gimp.org GIMP]). When you are not familiar with using one you should ask one of the artists to create a minimap for your map. When you want to create your own minimap then you should exactly follow the following steps to ensure to stay in style with the rest of the minimaps:
#Open your map with tiled, zoom out until the whole map is visible and use the "save as image" option.
#Open the image with your image manipulation program.
#Resize it so that one pixel represents one tile. When your map is for example 160x100 tiles large (including border zone) your picture should be 160x100 pixels large.
#Create a new transparent layer over the existing one.
#Select the pencil tool with a brush size of 1x1 pixel and with the color #000000 (pure black). Anti aliasing should be deactivated when available.
#Now draw lines on the new layer along the following map features:
#*Cliffs and walls (lower and upper edge)
#*River/lake shores
#*Roads (both sides of the road as single lines)
#*The border of any other large map structure that you feel should be on the map
#Trees or other objects can be represented by single pixels with 50% alpha transparency when there are so many that they affect the game play on the map.
#When you are finished remove the background layer. Now only the black lines should be visible
#Resize the image so the sides are half (50%) as long. You should use the best image filtering method available (cubic filtering in GIMP).
#Save your finished minimap as a PNG image with 32bit color depth and alpha transparency as *your_tmw_folder*/data/graphics/minimaps/*mapname*.png.
#Open your map with Tiled, click Map->Properties in the menu bar and add a new property with the key "minimap" and the value "/graphics/minimaps/*mapname*.png". The properties dialog is a little bit buggy in the current version of Tiled, so make sure that the property has really been set before you save the map.
#Send us both the map and the minimap image

''While this is indeed exactly the way I also created the earlier cave and desert minimaps, I am not entirely happy with this method. Mostly because the final result is a really tiny image, without the ability to easily make versions of it on other scales. I would therefore suggest we try to create future minimaps in vector format using Inkscape. The technique would be similar, placing a scaled down version of the map in the background and drawing black lines on top. The result should however be an image that can take any scale. This would allow us both to put more detail in the minimap for larger scales, and to include a zooming feature (or similar) in the game so that notes and other marks can be placed on the map with higher precision.'' --[[User:BjÃ¸rn|BjÃ¸rn]] 16:04, 16 August 2006 (CEST)

== Sending the map to the dev team ==

There are many ways to send us your map so we can include it in the next release.
;Fork on Github: You can create a fork of our [https://github.com/themanaworld/tmwa-client-data client-data repository] on github and push a commit containing your map. Have a look at our [http://wiki.themanaworld.org/index.php/Working_With_Git Tutorial] for using git and creating a fork.
;IRC: Join our [irc://irc.freenode.net/themanaworld IRC Channel]. When you are not familiar with irc you can find a guide in this [http://forums.themanaworld.org/viewtopic.php?t=747 Forum Thread]. When you are in the channel ask a developer if you can send him your map using DCC or upload your map to a webspace or one click hoster and give us the link.
;Forum: Upload your map to any webspace or one click hoster. An overview graphic (can be created with Tileds "Save as Image" feature) would be nice, too. Visit our [http://forums.themanaworld.org/viewforum.php?f=9 Forum] and register a new account. Then open a new thread, introduce yourself and post a link to your map.

Please understand that we will most likely have some details we would like to have changed before we release your map. so please check back or leave some information how to contact you.

== Hints for good mapping ==

* Before you start with a map you should have a loose idea of the layout. Making a sketch of the map on a piece of paper can be very useful.
* Don't put too many similar objects on one screen. Very eye catching tiles should only be used sparingly. Try to break up large areas with the same tile over and over again by throwing in some objects.
* Avoid regular patterns in natural environments. Trees usually don't grow in grid patterns. Rivers, mountain ridges or corridors in caves should never be completely straight.
* Don't map too functional. Give the players something to look at, even when it hasn't got any relevance for the gameplay.
* But keep the playability in mind.

{|-
| A bad mapping style:
| A better mapping style:
|-
| [[Image:Badmap.png]]
| [[Image:Goodmap.png]]
|-
|}

Development:Mapping Tutorial

2012-08-04T19:14:22Z

Jenalya: /* How to get Tiled */ Remove very outdated information

{{Status_green}}

'''This tutorial is still based on the old, java-based version of Tiled, not on the rewrite based on QT. While most TMW-specific information in this article still applies, some GUI elements might not be where this guide describes them.'''

== Basics ==
Making maps for The Mana World is not a task that requires a lot of knowledge but is a very good way to become creative and help the game to become more attractive. But getting started can be a little frustrating. Here is a guide that will help you to learn how to make maps.

=== Folders ===
You need to use a certain folder structure when mapping for TMW:
*(some folder)
**graphics
***tiles
****The graphics for the tilesets (png files)
**tilesets
***The external tilesets (tsx files)
**maps
***The actual maps (tmx files)

=== How to get Tiled ===
The map editor we are using is called Tiled. You can find it at http://mapeditor.org/.

=== Setting up the data files ===

To create a map, you will first need some graphics, as well as existing maps to use for reference.

You can get all the files in the right directory structure by cloning the "tmwdata" project from our [[Git repository]].

Alternatively, you can use the data files that are downloaded while playing the game. When you downloaded TMW as an installer packet, all map graphics were downloaded at the start of TMW from the update server and stored in the subfolder "\.tmw\updates" of your home directory as zip archives. Unpack these into the "data" subfolder of your TMW installation.

=== Setting up Tiled for making TMW Maps ===

Tiled is a map editor that isn't made specifically for TMW. That means it has a lot of options and settings we don't need.
[[Image:Maptutorial_Newmap.png|right|Settings for a new tmw map]]
To create a new map, press File->New. Use the following settings:

* Map Type: Orthogonal
* Tile Size: 32x32
* Tile Spacing: 0
* Map Size: Should be at least 60x60 but not larger than 200x200 (although the theoretical maximum is much higher). A 20 tile border around the outside of every map is needed ([[Map development/Border|diagram]]). Additionally, a 20 tile border is recommended between rooms for indoor maps; this is to prevent more than one room from showing at a time on the client.
** In the Argaes woodland, outdoor maps should be 150x120, including the 20 tile border.

=== Importing tilesets ===
[[Image:Maptutorial_Newtileset.png|right|Settings for importing a tileset]]
Now you have to choose the tilesets you want to use on the map. To import a tileset, select Tilesets->Add External Tileset and select the appropriate tsx file from ../tilesets/

If you need to add a tileset that has never been used before:
* Choose Map->New Tileset:
* Hit browse and select the tileset from graphics/tiles/. The name will be auto-filled.
* If the tileset is oversized, adjust the tile height (to 64 for an _x2 tileset; 96 for an _x3, etc.)
* Click OK.
* In the tileset pane, click the "export" button and browse to the ../tilesets/ directory. Save it with the same name, but with a .tsx extension.

Please try to import tilesets in the same order as other maps, and try to eliminate unused tilesets except when necessary to preserve the order. Add remaining tilesets at the end.

You can list the tileset order of existing maps by running tools/list-tileset-order.

The collision tileset should always be first, and the most-used tileset second. This is a good indicator of which existing pattern to follow, or whether you have enough justification to make a new order.

=== Starting to map ===
Now you can finally start to map. To place tiles on the map, select the pen tool from the toolbox to the left. Then select a tile from the tile palette. Now you can place the tiles on the map. Please, always take notice of what layer you are drawing on, because the layers play different roles:
*Use a layer beneath the "Fringe" layer for tiles without transparency. The layers beneath fringe have to be filled completely before you can call the map finished. When there are partially transparent tiles without completely opaque tiles on a layer below, strange graphic bugs will appear in the empty area.
*The "Fringe" Layer itself is for oversized tiles which have to be drawn in front of or behind moving objects, depending on their location. This sorting takes up CPU, making the game run slower. Thus, you should only use this layer for the tiles which have to use it.
*Layers above the "Fringe" layer are always drawn over the map sprites. It should be used for objects which are meant to look as if they are far above the game area. Keep in mind that there are also monsters which are larger than player characters.
*The "Collision" Layer isn't displayed in the game. It contains information about which parts of the map are walkable and which aren't. Don't put any tiles on this layer except for the red collision tiles from the collision tileset.

When you are finished with your map, you have to determine which tiles are walkable and which aren't. To do so, mark all tiles you want to be blocked with the red squares from the collision tileset on the collision layer. Be careful that even if a tile is not reachable, but is walkable, the server can spawn monsters there which can not be killed by the players because they can't reach them. This will eventually lead to all monsters accumulating in the unreachable area until there are no monsters left in the reachable areas.

You can check if you did this properly by saving the map, zooming out until the entire map is visible, hiding all layers except for the collision layer, and then using the flood fill tool with the cross tile on the empty area. Any tiles which are still unmarked are not reachable by the players.

Be aware that you need a border of about 20 tiles in every direction that should not be walkable, but should be designed properly ([[Map development/Border|diagram]]). Portals to other maps should only be some tiles wide. (You can't define the portals with Tiled, by the way. Leave this to the server administrators. The same applies to monster population, NPCs and other interactive objects.)

=== Testing your map ===

To test your map, you have to replace one of the maps in your TMW folder (in the sub folder data/maps). When you start the game and go to the map you replaced you will see your new map. You will see monsters and other players on the map, but don't worry-- the other players still see their version of the map, and they won't see you walk through walls. Just ignore them while you explore your map.

Sometimes your changed map is overridden by a new version of the map in the updates. In that case, you won't see any changes when you change or even remove a map. When you encounter this problem, either skip the update loading by starting tmw with the parameter "-u", or delete the file you want to change in all the zip archives you find in the subfolder /updates/.

== Intermediate topics ==

=== Over sized tiles ===

You might have noticed the tilesets ending with _x2.png or _x3.png contain graphics that are two or three tiles high. The graphics engine recognizes these oversized tiles when they are placed and automatically draws sprites in front of them when they are south of them and behind them when they are north of them. When importing a _x2 tileset, set the tile height to 64; when importing a _x3 tileset, set it to 96.

=== The Stamp ===

The Stamp Feature is a powerful feature of Tiled that is hard to find but can save a lot of time. It allows you to do quick copy/pasting of a part of a layer. This allows you to draw objects consisting of multiple tiles very quick. Just select the pen tool, press the right mouse button, and drag the mouse over the tiles you want to copy. Now you can draw the whole square of tiles over and over again with a single left click. To return to the normal drawing mode, just select the pen tool again or choose a tile from the tile palette.

=== Making two maps with a fluent transition ===

When you create an outdoor map, it is most likely supposed to be adjacent to an existing map. In this case, the transmission from one map to the other should be as seamless as possible. This can only be reached when the border areas of both maps are identical. Unfortunately, Tiled can't copy/paste between different maps (well, it is possible, but it only works correctly when both maps use exactly the same tilesets in exactly the same order), so we developed a command-line based program called TMXcopy for this task. You can find the sourcecode on the GIT repository in the folder http://gitorious.org/tmw/mainline/trees/master/tools/tmxcopy . A compiled windows binary can be found at http://www.crushnet.org/TempFiles/tmw/tmxcopy.zip .

An introduction on how to use this program is described in its [http://gitorious.org/tmw/mainline/blobs/HEAD/tools/tmxcopy/readme.txt readme file].

To create a map adjacent to an existing one, you should:
# Create the new map as described above, and save it.
# Use TMXcopy to copy the border area of the old map to the opposite side of the new map. The area should have the double width of the unwalkable area.
# Open the new map and check if the copying worked correctly. Then modify the lower three layers of the copied area to fit into your map. While doing so, you should focus on the half of the new area that is inside the walkable area of your map. The half that lies in the border zone of your map should not be modified too much because it is part of the old map.
# Use TMXCopy to copy the new area from the new map back to the old map.
# Update the collision layers on both maps.

Now the border area should be visually identical on both maps. The only difference should be that the unwalkable areas are switched. When sending the map to the team, remember to include the new version of the old map.

=== Ambient effects ===
[[Image:Maptutorial_Overlayproperties.png|right|Example for 3 independent scrolling overlays]]
Ambient Effects are a new feature in TMW 0.0.21. They are either background images drawn at places where you place no tiles or tiles with transparency or they are transparent graphics that will be drawn over your map. All these graphics can scroll independent. They can be used to create a variety of special effects like weather, darkness etc.

To add ambient effects to your map open your map with Tiled and click Map->Properties to open the map properties dialog. The dialog is a little bit buggy in the current version of Tiled, so make sure that the property has really been set before you save the map. Pressing enter after entering each key and value helps... sometimes.

==== adding foreground images ====
First you have to choose an image. Do so by adding a key ''foreground0image'' and set its value to the path of the image that you want to use relative to the data directory. For the spotlight effect for example enter ''/graphics/images/ambient/spotlight.png''.

When you want the image to move permanently add the new keys ''foreground0scrollX'' and ''foreground0scrollY'' followed by a number (can be a decimal value). ''foreground0scrollX'' determines the scroll speed to the right (negative values mean scrolling to the left) and ''foreground0scrollY'' the scroll speed down (negative values mean up). both values are in pixels per frame.

You can also define a ''foreground0parallax'' parameter. This parameter affects how much the overlay scrolls when the screen scrolls. A value of 1.0 means that the overlay will stay relative to the ground when the screen scrolls. A value of 0.0 means that the overlay stays relative to the "camera" and is not affected by scrolling. It is a decimal value so you can set it to values between 1 and 0 to create the three dimensional illusion of a layer between the "camera" and the map.

When using foregrounds at different resolutions, some would become disproportioned (for instance, the halo in cave maps that had to fill the screen repeated it self in higher resolution than 800x600.). That why, the keepratio parameter has been added: It will scaled up or down the image based on the current resolution.

Remember that the scaling factor is based on the default 800x600 resolution, so new overlay images are to be fitted for that resolution to make this parameter work.
(The image scaling in 1024x768 resolution mode, for instance, will be calculated this way: New Image Width = image-width / 800 * 1024, New Image Height = image-height / 600 * 768).

To add this parameter to your foreground configuration, you'll have to define the ''foreground0keepratio'' to the ''true'' value.

You can create any number of independent foreground graphics. To define a 2nd one create keys with 1 instead of 0, for a 3rd one 2, and so on. For instance ''foreground2parallax'' for the third foreground parallax value.

The foregrounds won't appear in Tiled. They will only appear in the game.

When it doesn't work please check that all key names are written correctly (they are cAsEsEnSiTiVe) and that the numbers of the foreground are consecutive starting from 0.

When you want to create foreground images yourself (transparent 32bit png graphics of any size) please don't forget to make them transparent with your image manipulation program. Otherwise the player won't be able to see the map under it. An opacity of 50% should be the absolute maximum. When you want to create effects that are not meant to obstruct the players view use an opacity between 10% and 20%.

For historical reasons you can also use "overlay" in place of "foreground". You will notice this annotation in older map files. Please don't do it and use "foreground" instead, "overlay" is depreciated.

==== adding background images====

Backgrounds are added in the same way foregrounds are, with the exceptions that the property keys don't start with the prefix foreground but with background. They use their own numbering, so you have to number your backgrounds 0, 1, 2 etc. no matter if you have foregrounds or not.
''background0image''
''background0scrollY''
''background0scrollX''
''background0keepratio''
In contrary to all other fore- or background images the first background (background0image) must not have any transparency but should be 100% opaque. Otherwise ugly graphic bugs will appear.

=== Particle effects ===

Check out the article about the [[Particle engine]] for a description about how to add particle effects to your map and how to create new particle effects when the effect you need doesn't exist yet.

=== Animated tiles ===
To make a type of tiles animated go to Tilesets->Tileset Manager. Then select the tileset with the tile and all of its animation frames (they have to be on one tileset) and click on the icon with a pencil on a piece of paper (the tooltip reads "Edit...").

Select the tile you want to be animated on the list to the left. You should see a table on the right with two columns named "Name" and "Value". You have to describe the animation of the tile in this table. Here an example for a 3-phase animation:

NAME VALUE
animation-frame0 0
animation-delay0 100
animation-frame1 16
animation-delay1 100
animation-frame2 48
animation-delay2 100

animation-frameX is the Tile number (as shown in the list on the left) and animation-delayX is how long it is shown (100 is equal to one second).

The animation does not show up in Tiled.

== Advanced Topics/Adding a map to the server ==
To get the server to use your new map without replacing the old one, you'll have to create a wlk file (see below). Then edit the data/resnametable.txt file, you'll notice the pattern. Finally, in the npc directory create a directory for your new map, and create a file named _import.txt with the contents:

map: <map_name>.gat

In npc/_import.txt include your new _import.txt file like all the others.

The clients still need direct access to the tmw file. To do this put it in an udpate or put it in the ~/.tmw/maps/ directory for every client that needs access to the map.

=== Creating the WLK files ===
You can either use the tool found in the tools/tmwcon/ directory of the server-data package or use the export plugin that ships with recent java versions of tiled. To use the export plugin go file->Save As and under filetype select the wlk extention, or just name the file with that extention.

== Creating a Minimap ==

The Creation of a minimap is a task that requires an image manipulation software that supports multiple layers and the PNG format (we recommend [http://www.gimp.org GIMP]). When you are not familiar with using one you should ask one of the artists to create a minimap for your map. When you want to create your own minimap then you should exactly follow the following steps to ensure to stay in style with the rest of the minimaps:
#Open your map with tiled, zoom out until the whole map is visible and use the "save as image" option.
#Open the image with your image manipulation program.
#Resize it so that one pixel represents one tile. When your map is for example 160x100 tiles large (including border zone) your picture should be 160x100 pixels large.
#Create a new transparent layer over the existing one.
#Select the pencil tool with a brush size of 1x1 pixel and with the color #000000 (pure black). Anti aliasing should be deactivated when available.
#Now draw lines on the new layer along the following map features:
#*Cliffs and walls (lower and upper edge)
#*River/lake shores
#*Roads (both sides of the road as single lines)
#*The border of any other large map structure that you feel should be on the map
#Trees or other objects can be represented by single pixels with 50% alpha transparency when there are so many that they affect the game play on the map.
#When you are finished remove the background layer. Now only the black lines should be visible
#Resize the image so the sides are half (50%) as long. You should use the best image filtering method available (cubic filtering in GIMP).
#Save your finished minimap as a PNG image with 32bit color depth and alpha transparency as *your_tmw_folder*/data/graphics/minimaps/*mapname*.png.
#Open your map with Tiled, click Map->Properties in the menu bar and add a new property with the key "minimap" and the value "/graphics/minimaps/*mapname*.png". The properties dialog is a little bit buggy in the current version of Tiled, so make sure that the property has really been set before you save the map.
#Send us both the map and the minimap image

''While this is indeed exactly the way I also created the earlier cave and desert minimaps, I am not entirely happy with this method. Mostly because the final result is a really tiny image, without the ability to easily make versions of it on other scales. I would therefore suggest we try to create future minimaps in vector format using Inkscape. The technique would be similar, placing a scaled down version of the map in the background and drawing black lines on top. The result should however be an image that can take any scale. This would allow us both to put more detail in the minimap for larger scales, and to include a zooming feature (or similar) in the game so that notes and other marks can be placed on the map with higher precision.'' --[[User:BjÃ¸rn|BjÃ¸rn]] 16:04, 16 August 2006 (CEST)

== Sending the map to the dev team ==

There are many ways to send us your map so we can include it in the next release.
;E-Mail: Mail your map to the developers mailing list themanaworld-devel@lists.sourceforge.net. Before you can do so you have to subscribe to it. This is a precaution against spam. You can do so on https://lists.sourceforge.net/lists/listinfo/themanaworld-devel
;IRC: Join our [irc://irc.freenode.net/themanaworld IRC Channel]. When you are not familiar with irc you can find a guide in this [http://forums.themanaworld.org/viewtopic.php?t=747 Forum Thread]. When you are in the channel ask a developer if you can send him your map using DCC or upload your map to a webspace or one click hoster and give us the link.
;Forum: Upload your map to any webspace or one click hoster. An overview graphic (can be created with Tileds "Save as Image" feature) would be nice, too. Visit our [http://forums.themanaworld.org/viewforum.php?f=9 Forum] and register a new account. Then open a new thread, introduce yourself and post a link to your map.

Please understand that we will most likely have some details we would like to have changed before we release your map. so please check back or leave some information how to contact you.

== Hints for good mapping ==

* Before you start with a map you should have a loose idea of the layout. Making a sketch of the map on a piece of paper can be very useful.
* Don't put too many similar objects on one screen. Very eye catching tiles should only be used sparingly. Try to break up large areas with the same tile over and over again by throwing in some objects.
* Avoid regular patterns in natural environments. Trees usually don't grow in grid patterns. Rivers, mountain ridges or corridors in caves should never be completely straight.
* Don't map too functional. Give the players something to look at, even when it hasn't got any relevance for the gameplay.
* But keep the playability in mind.

{|-
| A bad mapping style:
| A better mapping style:
|-
| [[Image:Badmap.png]]
| [[Image:Goodmap.png]]
|-
|}

Item Reference/Head Armor

2012-05-24T20:20:59Z

Jenalya: After discussion in #tmw-private it was decided that dev caps will still be given together with push access to the main repositories.

{{Category playerinfo}}

{{Template:Item Reference Page}}

The items are sorted first by defense, then by magic bonus, then by price, then by ID.

==Head Armor==
{| border="1" cellspacing="0" cellpadding="2" width="100%" align="center"
! style="background:#efdead;" | Image
! style="background:#efdead;" | Name (ID)
! style="background:#efdead;" | DEF
! style="background:#efdead;" | BUY/Sell
! style="background:#efdead;" | Weight
! style="background:#efdead;" width="350px" | Description
! style="background:#efdead;" | Rarity
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-paperbag.png]]
| Paper Bag (1218) Agility -1 M. Attack -1
| align="center" | 1
| align="right" | 1,000 GP 5 gp
| align="center" | 10
| A paper bag with eye holes.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-mouboohead.png]]
| Mouboo Head (1216)
| align="center" | 1
| align="right" | 10 GP 1 gp
| align="center" | 80
| A tightly fitting mouboo head.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-moubootaurhead.png]]
| Moubootaur Head (1219)
| align="center" | 1
| align="right" | 10 GP 1 gp
| align="center" | 80
| The Moubootaur's head.
| Unobtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-bunchofparsley.png]]
| Bunch Of Parsley (1220) Deaf
| align="center" | 1
| align="right" | 3 GP 1 gp
| align="center" | 1
| A bunch of parsley, useful for salads and many other dishes. In a pinch, it doubles as earplugs.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-pinkiehat.png]]
| Pinkie Hat (751) M. Attack +1
| align="center" | 1
| align="right" | 5,000 GP 1,000 gp
| align="center" | 5
| With this, you'll fit right in with those strange pinkies.
| Rare drop
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-catears.png]]
| Cat Ears (1217) Agility +3 M. Attack +1
| align="center" | 1
| align="right" | 50 GP 2 gp
| align="center" | 20
| A pair of plush cat ears.
| [[Cat Ears Quest|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-fluffyhat.png]]
| Fluffy Hat (752) M. Attack -5
| align="center" | 2
| align="right" | 7,000 GP 2,000 gp
| align="center" | 10
| Now you can wear fur on your head.
| Rare drop
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-santahat.png]]
| Santa Hat (511) M. Attack -2
| align="center" | 2
| align="right" | 400 GP 200 gp
| align="center" | 20
| Ask Santa about this hat.
| [[Quest Of Snowman|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-earmuffs.png]]
| Earmuffs (848) M. Attack -1
| align="center" | 2
| align="right" | 1,000 GP 500 gp
| align="center" | 20
| This earmuffs can keep your ears enjoyably warm.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-rangerhat.png]]
| Ranger Hat (1203) M. Attack -1
| align="center" | 2
| align="right" | 1,000 GP 500 gp
| align="center" | 20
| A leather hat traditionally worn by Rangers.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-goggles.png]]
| Goggles (618)
| align="center" | 2
| align="right" | 500 GP 100 gp
| align="center" | 20
| Goggles designed to take care of your eyes.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-serf.png]]
| Serf Hat (656)
| align="center" | 2
| align="right" | 500 GP 100 gp
| align="center" | 20
| A simple hat made from cloth.
| Buyable, [[Aidan And Ishi's Monster Points|Ishi]], [[Tulimshar Quests|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-gradcap.png]]
| Graduation Cap (675)
| align="center" | 2
| align="right" | 1,000 GP 255 gp
| align="center" | 20
| A traditional cap which a university student may wear upon graduating.
| [[Newbie Graduation|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-cottonheadband.png]]
| Cotton Headband (724) [[Selim The Dyer|Dyable]]
| align="center" | 2
| align="right" | 3,000 GP 500 gp
| align="center" | 5
| Just a cotton headband. [[Selim The Dyer|Dyable]]
| Buyable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-redcottonheadband.png]]
| Red Cotton Headband (2140) [[Selim The Dyer|Dyed]]
| align="center" | 2
| align="right" | 3,000 GP 500 gp
| align="center" | 5
| Just a red cotton headband.
| Buyable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-greencottonheadband.png]]
| Green Cotton Headband (2141) [[Selim The Dyer|Dyed]]
| align="center" | 2
| align="right" | 3,000 GP 500 gp
| align="center" | 5
| Just a green cotton headband.
| Buyable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-darkbluecottonheadband.png]]
| Dark Blue Cotton Headband (2142) [[Selim The Dyer|Dyed]]
| align="center" | 2
| align="right" | 3,000 GP 500 gp
| align="center" | 5
| Just a dark blue cotton headband.
| Buyable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-yellowcottonheadband.png]]
| Yellow Cotton Headband (2143) [[Selim The Dyer|Dyed]]
| align="center" | 2
| align="right" | 3,000 GP 500 gp
| align="center" | 5
| Just a yellow cotton headband.
| Buyable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-lightbluecottonheadband.png]]
| Light Blue Cotton Headband (2144) [[Selim The Dyer|Dyed]]
| align="center" | 2
| align="right" | 3,000 GP 500 gp
| align="center" | 5
| Just a light blue cotton headband.
| Buyable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-pinkcottonheadband.png]]
| Pink Cotton Headband (2145) [[Selim The Dyer|Dyed]]
| align="center" | 2
| align="right" | 3,000 GP 500 gp
| align="center" | 5
| Just a pink cotton headband.
| Buyable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-blackcottonheadband.png]]
| Black Cotton Headband (2146) [[Selim The Dyer|Dyed]]
| align="center" | 2
| align="right" | 3,000 GP 500 gp
| align="center" | 5
| Just a black cotton headband.
| Buyable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-orangecottonheadband.png]]
| Orange Cotton Headband (2147) [[Selim The Dyer|Dyed]]
| align="center" | 2
| align="right" | 3,000 GP 500 gp
| align="center" | 5
| Just an orange cotton headband.
| Buyable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-purplecottonheadband.png]]
| Purple Cotton Headband (2148) [[Selim The Dyer|Dyed]]
| align="center" | 2
| align="right" | 3,000 GP 500 gp
| align="center" | 5
| Just a purple cotton headband.
| Buyable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-darkgreencottonheadband.png]]
| Dark Green Cotton Headband (2149) [[Selim The Dyer|Dyed]]
| align="center" | 2
| align="right" | 3,000 GP 500 gp
| align="center" | 5
| Just a dark green cotton headband.
| Buyable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-monocle.png]]
| Monocle (4031) Dexterity +1 / Luck +1 / Critical +20
| align="center" | 2
| align="right" | 5,000 GP 2,500 gp
| align="center" | 20
| A handy perception tool, even when not at the opera.
| Unreleased
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-christmastree.png]]
| Christmas Tree Hat (1205) M. Attack +4
| align="center" | 2
| align="right" | 2,000 GP 1,000 gp
| align="center" | 20
| A hat shaped like a Christmas tree.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-facemask.png]]
| Skull Mask (1221) M. Attack +5
| align="center" | 2
| align="right" | 10,000 GP 5,000 gp
| align="center" | 150
| A mask made out of bones.
| Rare drop
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-sunglasses.png]]
| Sunglasses (855) M. Attack +6
| align="center" | 2
| align="right" | 1,000 GP 500 gp
| align="center" | 10
| Some stealthy sunglasses hiding your eyes from skeptical eyes.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-standardheadband.png]]
| Standard Headband (543) M. Attack -3
| align="center" | 3
| align="right" | 800 GP 400 gp
| align="center" | 10
| A standard headband.
| Frequent drop, Buyable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-leathergoggles.png]]
| Leather Goggles (619)
| align="center" | 3
| align="right" | 1,000 GP 500 gp
| align="center" | 20
| Goggles designed for desert storms.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-eyepatch.png]]
| Eyepatch (621)
| align="center" | 3
| align="right" | 1,000 GP 500 gp
| align="center" | 5
| What really makes you a pirate.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-bandana.png]]
| Bandana (622)
| align="center" | 3
| align="right" | 1,000 GP 500 gp
| align="center" | 20
| A striped bandana.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:armor-head-deserthat.png]]
| Desert Hat (723) [[Selim The Dyer|Dyable]] M. Attack -1
| align="center" | 3
| align="right" | 2,400 GP 600 gp
| align="center" | 20
| While the desert hat is perfect for sand storms, it won't help you much against a blow to the head. [[Selim The Dyer|Dyable]]
| Buyable, [[Lora Tay The Legendary Seamstress|Tailorable]]
|-
| align="center" height="65px" width="65px" | [[Image:armor-head-reddeserthat.png]]
| Red Desert Hat (2130) [[Selim The Dyer|Dyed]] M. Attack -1
| align="center" | 3
| align="right" | 2,400 GP 600 gp
| align="center" | 20
| While the red desert hat is perfect for sand storms, it won't help you much against a blow to the head.
| Buyable, [[Lora Tay The Legendary Seamstress|Tailorable]]
|-
| align="center" height="65px" width="65px" | [[Image:armor-head-greendeserthat.png]]
| Green Desert Hat (2131) [[Selim The Dyer|Dyed]] M. Attack -1
| align="center" | 3
| align="right" | 2,400 GP 600 gp
| align="center" | 20
| While the green desert hat is perfect for sand storms, it won't help you much against a blow to the head.
| Buyable, [[Lora Tay The Legendary Seamstress|Tailorable]]
|-
| align="center" height="65px" width="65px" | [[Image:armor-head-darkbluedeserthat.png]]
| Dark Blue Desert Hat (2132) [[Selim The Dyer|Dyed]] M. Attack -1
| align="center" | 3
| align="right" | 2,400 GP 600 gp
| align="center" | 20
| While the dark blue desert hat is perfect for sand storms, it won't help you much against a blow to the head.
| Buyable, [[Lora Tay The Legendary Seamstress|Tailorable]]
|-
| align="center" height="65px" width="65px" | [[Image:armor-head-yellowdeserthat.png]]
| Yellow Desert Hat (2133) [[Selim The Dyer|Dyed]] M. Attack -1
| align="center" | 3
| align="right" | 2,400 GP 600 gp
| align="center" | 20
| While the yellow desert hat is perfect for sand storms, it won't help you much against a blow to the head.
| Buyable, [[Lora Tay The Legendary Seamstress|Tailorable]]
|-
| align="center" height="65px" width="65px" | [[Image:armor-head-lightbluedeserthat.png]]
| Light Blue Desert Hat (2134) [[Selim The Dyer|Dyed]] M. Attack -1
| align="center" | 3
| align="right" | 2,400 GP 600 gp
| align="center" | 20
| While the light blue desert hat is perfect for sand storms, it won't help you much against a blow to the head.
| Buyable, [[Lora Tay The Legendary Seamstress|Tailorable]]
|-
| align="center" height="65px" width="65px" | [[Image:armor-head-pinkdeserthat.png]]
| Pink Desert Hat (2135) [[Selim The Dyer|Dyed]] M. Attack -1
| align="center" | 3
| align="right" | 2,400 GP 600 gp
| align="center" | 20
| While the pink desert hat is perfect for sand storms, it won't help you much against a blow to the head.
| Buyable, [[Lora Tay The Legendary Seamstress|Tailorable]]
|-
| align="center" height="65px" width="65px" | [[Image:armor-head-blackdeserthat.png]]
| Black Desert Hat (2136) [[Selim The Dyer|Dyed]] M. Attack -1
| align="center" | 3
| align="right" | 2,400 GP 600 gp
| align="center" | 20
| While the black desert hat is perfect for sand storms, it won't help you much against a blow to the head.
| Buyable, [[Lora Tay The Legendary Seamstress|Tailorable]]
|-
| align="center" height="65px" width="65px" | [[Image:armor-head-orangedeserthat.png]]
| Orange Desert Hat (2137) [[Selim The Dyer|Dyed]] M. Attack -1
| align="center" | 3
| align="right" | 2,400 GP 600 gp
| align="center" | 20
| While the orange desert hat is perfect for sand storms, it won't help you much against a blow to the head.
| Buyable, [[Lora Tay The Legendary Seamstress|Tailorable]]
|-
| align="center" height="65px" width="65px" | [[Image:armor-head-purpledeserthat.png]]
| Purple Desert Hat (2138) [[Selim The Dyer|Dyed]] M. Attack -1
| align="center" | 3
| align="right" | 2,400 GP 600 gp
| align="center" | 20
| While the purple desert hat is perfect for sand storms, it won't help you much against a blow to the head.
| Buyable, [[Lora Tay The Legendary Seamstress|Tailorable]]
|-
| align="center" height="65px" width="65px" | [[Image:armor-head-darkgreendeserthat.png]]
| Dark Green Desert Hat (2139) [[Selim The Dyer|Dyed]] M. Attack -1
| align="center" | 3
| align="right" | 2,400 GP 600 gp
| align="center" | 20
| While the dark green desert hat is perfect for sand storms, it won't help you much against a blow to the head.
| Buyable, [[Lora Tay The Legendary Seamstress|Tailorable]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-knitcap.png]]
| Knit Cap (854)
| align="center" | 3
| align="right" | 1,000 GP 500 gp
| align="center" | 50
| A knitted cap keeping your head warm in the crual cold.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-nohmask.png]]
| Noh Mask (678) M. Attack +1
| align="center" | 3
| align="right" | 7,000 GP 1,000 gp
| align="center" | 18
| A mask made out of bones.
| [[Robberies In Hurnscald|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-demonmask.png]]
| Demon Mask (679) M. Attack +5
| align="center" | 3
| align="right" | 10,000 GP 5,000 gp
| align="center" | 23
| A scary mask to make you look like a demon.
| [[Demon Mask|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-elfnightcap.png]]
| Elf Nightcap (854) M. Attack +5
| align="center" | 3
| align="right" | 1,000 GP 500 gp
| align="center" | 50
| A comfortable nightcap worn by Santa's helpers.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-guyfawkesmask.png]]
| Guy Fawkes Mask (769)
| align="center" | 3
| align="right" | 1,000 GP 500 gp
| align="center" | 30
| The famous Guy Fawkes mask.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-operamask.png]]
| Opera Mask (1276)
| align="center" | 3
| align="right" | 1,000 GP 500 gp
| align="center" | 50
| Pale and broken. There is surely a story to be told here.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-jestermask.png]]
| Jester Mask (1277)
| align="center" | 3
| align="right" | 1,000 GP 500 gp
| align="center" | 50
| Laughter with bells on.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-witchhat.png]]
| Witch Hat (1278)
| align="center" | 3
| align="right" | 1,000 GP 500 gp
| align="center" | 50
| Big, dark, and pointy. It looks a bit out of place.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-goblinmask.png]]
| Goblin Mask (1279)
| align="center" | 3
| align="right" | 1,000 GP 500 gp
| align="center" | 50
| A strange dark mask. Who knows what lurks behind it?
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-witchdoctormask.png]]
| Witch Doctor's Mask (781)
| align="center" | 3
| align="right" | ? GP ? gp
| align="center" | 20
| A crazy mask from the Voodoo doctor.
| Unreleased
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-minershat.png]]
| Miners Hat (525) M. Attack -8
| align="center" | 4
| align="right" | 800 GP 400 gp
| align="center" | 40
| A hat used by miners.
| Frequent drop, [[Tulimshar Quests|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-piratehat.png]]
| Pirate Hat (617) M. Attack -8
| align="center" | 4
| align="right" | 2,000 GP 1,000 gp
| align="center" | 40
| A pirate hat.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-pumpkinhelmet.png]]
| Pumpkin Helmet (615) M. Attack -4
| align="center" | 4
| align="right" | 2,000 GP 1,000 gp
| align="center" | 60
| A helmet made out of a pumpkin.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-axehat.png]]
| Axe Hat (616) M. Attack -4
| align="center" | 4
| align="right" | 2,000 GP 1,000 gp
| align="center" | 50
| A really cool joke.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-crown.png]]
| Crown (646)
| align="center" | 4
| align="right" | 5,000 GP 1,000
| align="center" | 240
| A jewel embossed crown fit for any ruler.
| Unobtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-antlerhat.png]]
| Antler Hat (1204) M. Attack +2
| align="center" | 4
| align="right" | 1,000 GP 500 gp
| align="center" | 15
| A hat with antlers sticking out of it.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-circlet.png]]
| Circlet (620) M. Attack +5
| align="center" | 4
| align="right" | 2,000 GP 1,000 gp
| align="center" | 25
| A nice piece of jewelry.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-highpriest-crown.png]]
| High Priest Crown (721) SP +20 M. Attack +20
| align="center" | 4
| align="right" | 20,000 GP 5,000 gp
| align="center" | 400
| A golden crown with an enchanted ruby.
| Buyable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-yeti-mask.png]]
| Yeti Mask (4027) M. Attack -10
| align="center" | 4
| align="right" | 6,000 GP 3,000 gp
| align="center" | 10
| A mask made from the yeti's head.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-snowgoggles.png]]
| Snow Goggles (1242) M. Attack -2
| align="center" | 5
| align="right" | 7,500 GP 5,000 gp
| align="center" | 10
| Snow goggles to keep your eyeballs from freezing.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-fancyhat.png]]
| Fancy Hat (524)
| align="center" | 5
| align="right" | 1,600 GP 800 gp
| align="center" | 20
| A Fancy Hat.
| Buyable, Frequent drop, [[Aidan And Ishi's Monster Points|Ishi]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-newcap.png]]
| Cap (654)
| align="center" | 5
| align="right" | 2,000 GP 500 gp
| align="center" | 20
| A hat with a peak to shield your eyes from the sun.
| Buyable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-santabeardhat.png]]
| Santa Beard Hat (1206) M. Attack +2
| align="center" | 5
| align="right" | 1,000 GP 500 gp
| align="center" | 20
| Now you will look just like Santa Claus!
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-devcap.png]]
| Developers Cap (647) M. Attack +5
| align="center" | 5
| align="right" | 2,000 GP 500 gp
| align="center" | 20
| A cap which identifies you as a developer.
| [[User:Fate/Becoming_a_developer|Special quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-gmcap.png]]
| GM Cap (725) M. Attack +5
| align="center" | 5
| align="right" | 2,000 GP 500 gp
| align="center" | 20
| A hat with a peak to shield your eyes from the sun.
| GM only
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-rabbit ears.png]]
| White Rabbit Ears (1255) [[Selim The Dyer|Dyable]] M. Attack +4
| align="center" | 5
| align="right" | 7,000 GP 5,000 gp
| align="center" | 20
| A headband with rabbit ears, pure white.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-redrabbitears.png]]
| Red Rabbit Ears (2190) [[Selim The Dyer|Dyed]] M. Attack +4
| align="center" | 5
| align="right" | 7,000 GP 5,000 gp
| align="center" | 15
| A headband with rabbit ears, bright red.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-greenrabbitears.png]]
| Green Rabbit Ears (2191) [[Selim The Dyer|Dyed]] M. Attack +4
| align="center" | 5
| align="right" | 7,000 GP 5,000 gp
| align="center" | 15
| A headband with rabbit ears, warm green.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-darkbluerabbitears.png]]
| Dark Blue Rabbit Ears (2192) [[Selim The Dyer|Dyed]] M. Attack +4
| align="center" | 5
| align="right" | 7,000 GP 5,000 gp
| align="center" | 15
| A headband with rabbit ears, iridescent dark blue.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-yellowrabbitears.png]]
| Yellow Rabbit Ears (2193) [[Selim The Dyer|Dyed]] M. Attack +4
| align="center" | 5
| align="right" | 7,000 GP 5,000 gp
| align="center" | 15
| A headband with rabbit ears, soft yellow.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-lightbluerabbitears.png]]
| Light Blue Rabbit Ears (2194) [[Selim The Dyer|Dyed]] M. Attack +4
| align="center" | 5
| align="right" | 7,000 GP 5,000 gp
| align="center" | 15
| A headband with rabbit ears, light blue.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-pinkrabbitears.png]]
| Pink Rabbit Ears (2195) [[Selim The Dyer|Dyed]] M. Attack +4
| align="center" | 5
| align="right" | 7,000 GP 5,000 gp
| align="center" | 15
| A headband with rabbit ears, bright pink.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-blackrabbitears.png]]
| Black Rabbit Ears (2196) [[Selim The Dyer|Dyed]] M. Attack +4
| align="center" | 5
| align="right" | 7,000 GP 5,000 gp
| align="center" | 15
| A headband with rabbit ears, deep black.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-orangerabbitears.png]]
| Orange Rabbit Ears (2197) [[Selim The Dyer|Dyed]] M. Attack +4
| align="center" | 5
| align="right" | 7,000 GP 5,000 gp
| align="center" | 15
| A headband with rabbit ears, bright orange.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-purplerabbitears.png]]
| Purple Rabbit Ears (2198) [[Selim The Dyer|Dyed]] M. Attack +4
| align="center" | 5
| align="right" | 7,000 GP 5,000 gp
| align="center" | 15
| A headband with rabbit ears, strong purple.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-darkgreenrabbitears.png]]
| Dark Green Rabbit Ears (2199) [[Selim The Dyer|Dyed]] M. Attack +4
| align="center" | 5
| align="right" | 7,000 GP 5,000 gp
| align="center" | 15
| A headband with rabbit ears, deep green.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-wizardhat.png]]
| Wizard Hat (4028) Intelligence +3 - [[Selim The Dyer|Dyable]] M. Attack +5
| align="center" | 5
| align="right" | 5,000 GP 2,500 gp
| align="center" | 20
| A wizard hat.
| [[Angela's Daughter|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-redwizardhat.png]]
| Red Wizard Hat (2200) Intelligence +3 - [[Selim The Dyer|Dyed]] M. Attack +5
| align="center" | 5
| align="right" | 5,000 GP 2,500 gp
| align="center" | 20
| A wizard hat, bright red.
| [[Angela's Daughter|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-greenwizardhat.png]]
| Green Wizard Hat (2201) Intelligence +3 - [[Selim The Dyer|Dyed]] M. Attack +5
| align="center" | 5
| align="right" | 5,000 GP 2,500 gp
| align="center" | 20
| A wizard hat, warm green.
| [[Angela's Daughter|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-darkbluewizardhat.png]]
| Dark Blue Wizard Hat (2202) Intelligence +3 - [[Selim The Dyer|Dyed]] M. Attack +5
| align="center" | 5
| align="right" | 5,000 GP 2,500 gp
| align="center" | 20
| A wizard hat, iridescent dark blue.
| [[Angela's Daughter|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-yellowwizardhat.png]]
| Yellow Wizard Hat (2203) Intelligence +3 - [[Selim The Dyer|Dyed]] M. Attack +5
| align="center" | 5
| align="right" | 5,000 GP 2,500 gp
| align="center" | 20
| A wizard hat, soft yellow.
| [[Angela's Daughter|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-lightbluewizardhat.png]]
| Light Blue Wizard Hat (2204) Intelligence +3 - [[Selim The Dyer|Dyed]] M. Attack +5
| align="center" | 5
| align="right" | 5,000 GP 2,500 gp
| align="center" | 20
| A wizard hat, light blue.
| [[Angela's Daughter|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-pinkwizardhat.png]]
| Pink Wizard Hat (2205) Intelligence +3 - [[Selim The Dyer|Dyed]] M. Attack +5
| align="center" | 5
| align="right" | 5,000 GP 2,500 gp
| align="center" | 20
| A wizard hat, bright pink.
| [[Angela's Daughter|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-blackwizardhat.png]]
| Black Wizard Hat (2206) Intelligence +3 - [[Selim The Dyer|Dyed]] M. Attack +5
| align="center" | 5
| align="right" | 5,000 GP 2,500 gp
| align="center" | 20
| A wizard hat, deep black.
| [[Angela's Daughter|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-orangewizardhat.png]]
| Orange Wizard Hat (2207) Intelligence +3 - [[Selim The Dyer|Dyed]] M. Attack +5
| align="center" | 5
| align="right" | 5,000 GP 2,500 gp
| align="center" | 20
| A wizard hat, bright orange.
| [[Angela's Daughter|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-purplewizardhat.png]]
| Purple Wizard Hat (2208) Intelligence +3 - [[Selim The Dyer|Dyed]] M. Attack +5
| align="center" | 5
| align="right" | 5,000 GP 2,500 gp
| align="center" | 20
| A wizard hat, strong purple.
| [[Angela's Daughter|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-darkgreenwizardhat.png]]
| Dark Green Wizard Hat (2209) Intelligence +3 - [[Selim The Dyer|Dyed]] M. Attack +5
| align="center" | 5
| align="right" | 5,000 GP 2,500 gp
| align="center" | 20
| A wizard hat, dark green.
| [[Angela's Daughter|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-sailorhat.png]]
| Sailor Hat (764)
| align="center" | 5
| align="right" | ? GP ? gp
| align="center" | 5
| A hat worn by brave sailors.
| Unreleased
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-cowboywhite.png]]
| White Cowboy Hat (643) M. Attack -12
| align="center" | 6
| align="right" | 1,800 GP 900 gp
| align="center" | 30
| A white cowboy hat with a band.
| [[Pachua the Hermit Indian|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-cowboyblack.png]]
| Black Cowboy Hat (644) M. Attack -12
| align="center" | 6
| align="right" | 1,800 GP 900 gp
| align="center" | 30
| A black cowboy hat with shiny buckles.
| [[Pachua the Hermit Indian|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-monster-skull-helm.png]]
| Monster Skull Helmet (722) M. Attack +10 - M. Defense +20
| align="center" | 7
| align="right" | 15,000 GP 3,000 gp
| align="center" | 250
| The conserved skull of a mysterious ancient monster.
| Buyable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-heartglasses.png]]
| Heart Glasses (1247) M. Attack +5
| align="center" | 8
| align="right" | 7,500 GP 5,000 gp
| align="center" | 20
| Heart Glasses from another universe. Decisions were different there.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-fairyhat.png]]
| Fairy Hat (770) Luck +3 M. Attack -10
| align="center" | 5
| align="right" | 2,000 GP 1,000 gp
| align="center" | 20
| The famous hat worn by Robin Hood.
| [[Bandit Quest|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-pinkiehelmet.png]]
| Pinkie Helmet (801) Luck +1 M. Attack -20
| align="center" | 10
| align="right" | 20,000 GP 1,500 gp
| align="center" | 800
| A helmet of Pinkie warriors.
| [[Headless Man's Helmet|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-silkheadband.png]]
| Silk Headband (544) M. Attack -10
| align="center" | 10
| align="right" | 10,000 GP 2,000 gp
| align="center" | 10
| A cool headband made of silk.
| Frequent drop, Buyable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-mushroomhat.png]]
| Mush Hat (629)
| align="center" | 10
| align="right" | 2,500 GP 1,250 gp
| align="center" | 30
| Soft and fashionable.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-mask.png]]
| Face Mask (634)
| align="center" | 10
| align="right" | 2,500 GP 1,250 gp
| align="center" | 50
| A wooden mask to conceal your face.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-bunnyears.png]]
| Bunny Ears (1214) M. Attack +1
| align="center" | 10
| align="right" | 5,000 GP 2,000 gp
| align="center" | 20
| A headband with plush bunny ears.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-tophat.png]]
| Top Hat (627) M. Attack +2
| align="center" | 10
| align="right" | 2,500 GP 1,250 gp
| align="center" | 30
| For the gentry of The Mana World.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-bowlerhat.png]]
| Bowler Hat (4030) [[Selim The Dyer|Dyable]] M. Attack +2
| align="center" | 10
| align="right" | 2,500 GP 1,250 gp
| align="center" | 30
| A hat for those with a bit of class.
| [[Shannon's Bowler Hat|Annual Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-redbowlerhat.png]]
| Red Bowler Hat (2210) [[Selim The Dyer|Dyed]] M. Attack +2
| align="center" | 10
| align="right" | 2,500 GP 1,250 gp
| align="center" | 30
| A hat for those with a bit of class, with a red band.
| [[Shannon's Bowler Hat|Annual Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-greenbowlerhat.png]]
| Green Bowler Hat (2211) [[Selim The Dyer|Dyed]] M. Attack +2
| align="center" | 10
| align="right" | 2,500 GP 1,250 gp
| align="center" | 30
| A hat for those with a bit of class, with a green band.
| [[Shannon's Bowler Hat|Annual Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-darkbluebowlerhat.png]]
| Dark Blue Bowler Hat (2212) [[Selim The Dyer|Dyed]] M. Attack +2
| align="center" | 10
| align="right" | 2,500 GP 1,250 gp
| align="center" | 30
| A hat for those with a bit of class, with a dark blue band.
| [[Shannon's Bowler Hat|Annual Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-yellowbowlerhat.png]]
| Yellow Bowler Hat (2213) [[Selim The Dyer|Dyed]] M. Attack +2
| align="center" | 10
| align="right" | 2,500 GP 1,250 gp
| align="center" | 30
| A hat for those with a bit of class, with a yellow band.
| [[Shannon's Bowler Hat|Annual Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-lightbluebowlerhat.png]]
| Light Blue Bowler Hat (2214) [[Selim The Dyer|Dyed]] M. Attack +2
| align="center" | 10
| align="right" | 2,500 GP 1,250 gp
| align="center" | 30
| A hat for those with a bit of class, with a light blue band.
| [[Shannon's Bowler Hat|Annual Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-pinkbowlerhat.png]]
| Pink Bowler Hat (2215) [[Selim The Dyer|Dyed]] M. Attack +2
| align="center" | 10
| align="right" | 2,500 GP 1,250 gp
| align="center" | 30
| A hat for those with a bit of class, with a pink band.
| [[Shannon's Bowler Hat|Annual Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-blackbowlerhat.png]]
| Black Bowler Hat (2216) [[Selim The Dyer|Dyed]] M. Attack +2
| align="center" | 10
| align="right" | 2,500 GP 1,250 gp
| align="center" | 30
| A hat for those with a bit of class, with a black band.
| [[Shannon's Bowler Hat|Annual Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-orangebowlerhat.png]]
| Orange Bowler Hat (2217) [[Selim The Dyer|Dyed]] M. Attack +2
| align="center" | 10
| align="right" | 2,500 GP 1,250 gp
| align="center" | 30
| A hat for those with a bit of class, with an orange band.
| [[Shannon's Bowler Hat|Annual Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-purplebowlerhat.png]]
| Purple Bowler Hat (2218) [[Selim The Dyer|Dyed]] M. Attack +2
| align="center" | 10
| align="right" | 2,500 GP 1,250 gp
| align="center" | 30
| A hat for those with a bit of class, with a purple band.
| [[Shannon's Bowler Hat|Annual Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-darkgreenbowlerhat.png]]
| Dark Green Bowler Hat (2219) [[Selim The Dyer|Dyed]] M. Attack +2
| align="center" | 10
| align="right" | 2,500 GP 1,250 gp
| align="center" | 30
| A hat for those with a bit of class, with a dark green band.
| [[Shannon's Bowler Hat|Annual Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-bowlerhat(brown).png]]
| Bowler Hat (Brown) (800) [[Selim The Dyer|Dyable]] M. Attack +2
| align="center" | 10
| align="right" | 2,500 GP 1,250 gp
| align="center" | 30
| A hat for those with a bit of class.
| [[Love Triangle Quest|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-redbowlerhat(brown).png]]
| Red Bowler Hat (Brown) (2230) [[Selim The Dyer|Dyed]] M. Attack +2
| align="center" | 10
| align="right" | 2,500 GP 1,250 gp
| align="center" | 30
| A hat for those with a bit of class, with a red band.
| [[Love Triangle Quest|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-greenbowlerhat(brown).png]]
| Green Bowler Hat (Brown) (2231) [[Selim The Dyer|Dyed]] M. Attack +2
| align="center" | 10
| align="right" | 2,500 GP 1,250 gp
| align="center" | 30
| A hat for those with a bit of class, with a green band.
| [[Love Triangle Quest|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-darkbluebowlerhat(brown).png]]
| Dark Blue Bowler Hat (Brown) (2232) [[Selim The Dyer|Dyed]] M. Attack +2
| align="center" | 10
| align="right" | 2,500 GP 1,250 gp
| align="center" | 30
| A hat for those with a bit of class, with a dark blue band.
| [[Love Triangle Quest|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-yellowbowlerhat(brown).png]]
| Yellow Bowler Hat (Brown) (2233) [[Selim The Dyer|Dyed]]
| align="center" | 10
| align="right" | 2,500 GP 1,250 gp
| align="center" | 30
| A hat for those with a bit of class, with a yellow band.
| [[Love Triangle Quest|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-lightbluebowlerhat(brown).png]]
| Light Blue Bowler Hat (Brown) (2234) [[Selim The Dyer|Dyed]]
| align="center" | 10
| align="right" | 2,500 GP 1,250 gp
| align="center" | 30
| A hat for those with a bit of class, with a light blue band.
| [[Love Triangle Quest|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-pinkbowlerhat(brown).png]]
| Pink Bowler Hat (Brown) (2235) [[Selim The Dyer|Dyed]] M. Attack +2
| align="center" | 10
| align="right" | 2,500 GP 1,250 gp
| align="center" | 30
| A hat for those with a bit of class, with a pink band.
| [[Love Triangle Quest|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-blackbowlerhat(brown).png]]
| Black Bowler Hat (Brown) (2236) [[Selim The Dyer|Dyed]] M. Attack +2
| align="center" | 10
| align="right" | 2,500 GP 1,250 gp
| align="center" | 30
| A hat for those with a bit of class, with a black band.
| [[Love Triangle Quest|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-orangebowlerhat(brown).png]]
| Orange Bowler Hat (Brown) (2237) [[Selim The Dyer|Dyed]] M. Attack +2
| align="center" | 10
| align="right" | 2,500 GP 1,250 gp
| align="center" | 30
| A hat for those with a bit of class, with a orange band.
| [[Love Triangle Quest|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-purplebowlerhat(brown).png]]
| Purple Bowler Hat (Brown) (2238) [[Selim The Dyer|Dyed]] M. Attack +2
| align="center" | 10
| align="right" | 2,500 GP 1,250 gp
| align="center" | 30
| A hat for those with a bit of class, with a purple band.
| [[Love Triangle Quest|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-darkgreenbowlerhat(brown).png]]
| Dark Green Bowler Hat (Brown) (2239) [[Selim The Dyer|Dyed]] M. Attack +2
| align="center" | 10
| align="right" | 2,500 GP 1,250 gp
| align="center" | 30
| A hat for those with a bit of class, with a dark green band.
| [[Love Triangle Quest|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-eggshellhat.png]]
| Eggshell Hat (1256) Agility -1
| align="center" | 12
| align="right" | 7,000 GP 5,000 gp
| align="center" | 15
| A novelty hat shaped like an eggshell half.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-shroomhat.png]]
| Shroom Hat (630)
| align="center" | 13
| align="right" | 3,000 GP 1,500 gp
| align="center" | 30
| Evil and fashionable.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-funkyhat.png]]
| Funky Hat (628) M. Attack +2
| align="center" | 13
| align="right" | 3,000 GP 1,500 gp
| align="center" | 20
| Yawn...
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-xmaself.png]]
| Christmas Elf Hat (633) M. Attack +2
| align="center" | 13
| align="right" | 3,000 GP 1,500 gp
| align="center" | 30
| A hat worn by christmas elfs.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-infantryhelm.png]]
| Infantry Helmet (638) M. Attack -30
| align="center" | 15
| align="right" | 15,000 GP 1,500 gp
| align="center" | 400
| A helmet for soldiers and guards.
| Rare drop
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-bromenalhelmet.png]]
| Bromenal Helmet (795) M. Attack -30
| align="center" | 15
| align="right" | 15,000 GP 1,500 gp
| align="center" | 400
| A hard bromenal helmet.
| Unreleased
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-knighthelm.png]]
| Knight's Helmet (637) M. Attack -30
| align="center" | 15
| align="right" | 20,000 GP 2,000 gp
| align="center" | 600
| A helmet with two small wings on it.
| [[Nicholas The Blacksmith|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Terranite-helmet.png]]
| Terranite Helmet (766) M. Attack -12 - M. Defense +5
| align="center" | 15
| align="right" | 200,000 GP 3,000 gp
| align="center" | 300
| A magical helmet made out of semi-polished granite that was enchanted to be very light. Great for mages on the battlefield.
| [[The Terranite Armor|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-captainhat.png]]
| Captain's Hat (765)
| align="center" | 15
| align="right" | ? GP ? gp
| align="center" | 8
| A hat worn by the bravest captains.
| Unreleased
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-candlehelmet.png]]
| Candle Helmet (4020) Agility -1 / Intelligence +1 M. Attack -25
| align="center" | 16
| align="right" | 20,000 GP 2,000 gp
| align="center" | 450
| Worn by spelunkers.
| [[Orum Quest|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-warlordhelm.png]]
| Warlord Helmet (636) M. Attack -36
| align="center" | 18
| align="right" | 30,000 GP 3,000 gp
| align="center" | 900
| Worn by great warriors.
| [[Nicholas The Blacksmith|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-crusade.png]]
| Crusade Helmet (639) M. Attack -36
| align="center" | 18
| align="right" | 25,000 GP 2,500 gp
| align="center" | 1300
| Start your own crusade.
| [[Nicholas The Blacksmith|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-paladinhelmet.png]]
| Paladin's Helmet (759)
| align="center" | 19
| align="right" | ? GP ? gp
| align="center" | 43
| Worn only by paladins.
| Unreleased
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-overlordhelm.png]]
| Overlord Helmet (760)
| align="center" | 20
| align="right" | ? GP ? gp
| align="center" | 45
| Worn by the greatest warriors.
| Unreleased
|-
| align="center" height="65px" width="65px" | [[Image:Armor-head-deserthelmet.png]]
| Desert Helmet (761)
| align="center" | 21
| align="right" | ? GP ? gp
| align="center" | 48
| The perfect desert warriors' helmet.
| Unreleased
|}

'''[[Item Reference|< Item Reference]]'''

User:Fate/Becoming a developer

2012-05-24T20:16:36Z

Jenalya: After discussion in #tmw-private it was decided that dev caps will still be given together with push access to the main repositories.

Since this question keeps popping up, I've decided to put together a brief summary of how (in my experience) someone can become a developer in a Free Software project. Note that different projects have different cultures, so this advice may not be universal.

As developer, your goal is to '''maximise your use to the project''' within what your real life constraints and obligations to other projects allow. Keep this in mind for all of the following.

== Background ==

First, make sure that you are familiar with the project's
* aim
* principal communication channels
* organisation
* technical choices

The last two points, ''organisation'' and ''technical choices'' you need only understand as far as needed for actually interacting with development.

== Starting out ==

Free software developers must be self-reliant. If you have an idea, chances are that nobody will like it until you've finished implementing it (people are silly like that.)
If you are just starting out, you cannot expect help from the existing developers.

Try to follow the following rules of thumb:
* Figure things out on your own as much as possible
* Manage and sanity-check your ideas
* Allocate time
** To learn
** To implement

== Figuring things out ==
* If you can google for it, don't ask about it.
* If it's documented, don't ask about it, unless it's broken.
* If it's not in the project's best interest, don't even consider it.

== Managing your ideas ==
* If you think you have a good idea, write it down for yourself first.
* Check: does this idea introduce security issues or other exploits?
* Check: is this idea actually useful (or entertaining, for a game)?
* Check: is this idea usable?
* Check: does this idea really add something new?
* Check: does this idea integrate well with the rest of the project?
* Check: does this idea integrate well with the project's aim and projected plan?
* Check: is this idea technically feasible?
* Check: ''do you have the resources to implement this idea yourself''?

You can try to answer these questions for yourself or talk them through with your friends.
If you are just starting out, try to rely on the existing developers' help as little as possible.
If you need other people's help, make sure to ask for help politely. Don't waste your time on ideas that you cannot implement yourself and that you cannot find help for. As for requesting help, remember:

* Don't expect anyone to do your work for you, ''ever'':
** Let me repeat that: implementing things is hard work. Don't ever expect people to do hard work for you for free. No matter what you may think, you are not ''that'' brilliant.
** If you want an idea implemented, show that you are serious about working on it yourself.
*** Don't repeat yourself or go into unnecessary detail.
*** Do check your idea, read up on technical aspects you are not aware of, build prototypes, draw sketches, criticise yourself and revise your idea.
*** Acquire the skills needed to make your idea a reality.

== Learning and Time Management ==
Free software development is ''mostly'' about learning, especially at the beginning, so be prepared to learn new languages, radically new ideas, and new techniques in tools that you have been using for years.

Remember:
* The first revision of anything you try will usually be horrible.
* The second revision will usually be too bad to be practical.
* The third revision may or may not be good enough.
* At any time you may find that you did something very silly and need to read up and start over from the beginning.

Make sure to allocate a lot of time to accommodate for all of this.

== Joining the team ==
Now that we've covered the basics, how can you join a Free Software project's team? The most important thing is to show that you are indeed useful to the project. If you have programming skills, solve an existing problem or limitation of the project using your skills and submit a patch. If you have writing skills, try to see if there is something you can write for the project. If you have pixelling or drawing skills, produce some graphics that may help the project. If you don't have any of these skills, try to acquire them.

If you don't have any skills nor time to acquire them, then test and submit bug reports, or try to answer newbie questions that you know the answers to. This last step will not make you a developer, but it will give you a starting point in case you do manage to find time later on.
Also, you help the project by freeing up developer time, so that's a good thing.

Classic:TmwAthena Scripting Reference

2012-05-04T15:03:00Z

Jenalya: /* areamonster */ Add note about event behaviour when spawning in an area NPC.

This page is a reference for commands believed to work in the eAthena scripting language still used by tmwAthena.

A number of problematic commands have been removed from this list, but not all commands have been tested.

== Language Commands ==
These are command that are closely tied to the language itself.

=== goto ===
<pre>
goto L_1;
</pre>
Unconditionally jump to a label. Often used in an "if" body.

=== callsub ===
<pre>
callsub S_labelname, arguments...;
</pre>
Jump to the given label. When the "return" statement is executed, continue on the next line.

It is not known whether "arguments..." works, we use temporary variables instead.

It might also be possible to use this as a function, if the form of return with a value is used, but we use temporary variables instead.

=== callfunc ===
<pre>
callfunc "function_name", arguments...;
</pre>
Jump to the given function script. When the "return" statement is executed, continue on the next line of this script.

It is not known whether "arguments..." works, we use temporary variables instead.

It might also be possible to use this as a function, if the form of return with a value is used, but we use temporary variables instead.

"return" is broken if this is used from within an if(). If you need a conditional callfunc, first goto a label.

=== return ===
<pre>
return;
return expr;
</pre>
Return from this script or sublabel to the calling function.

It is unknown what happens if this is used from the top-level script, use "close" or "end" instead.

We use temporary variables instead of the form that returns an expression.

=== getarg ===
<pre>
getarg(index)
</pre>
Return (by reference?) an argument of "callsub" or "callfunc". Aborts the script if used at toplevel of if out of range.

We use temporary variables instead.

=== set ===
<pre>
set variable, expression;
</pre>
Very common command, to set variables.

=== setarray ===
<pre>
setarray arrayvariable, val1, val2, ...;
</pre>
Set elements of an array. Previous elements are not cleared. At most 128 elements can be assigned.

It is currently possible, but deprecated, to specify a (zero-based) array index to start at the given part of an array. It's pretty amazing that that code works anyway.

Remember that there are no permanent arrays, only temporary.

=== cleararray ===
<pre>
cleararray variable, value, count;
</pre>
Fill an array with "count" copies of "value".

=== copyarray ===
<pre>
copyarray dest_var, src_var, count;
</pre>
Copy elements of an array.

This function looks broken to me.

=== getarraysize ===
<pre>
getarraysize variable;
</pre>
Get the size of an array.

The size of an array is simply one more than the index of the last nonzero integer or nonempty string.

WARNING: most functions that set an array do not bother to clear out high indices. You should almost always use an explicitly-provided size instead.

=== deletearray ===
<pre>
deletearray variable[, count = 1];
</pre>
Remove count elements from an array.

If there are elements beyond count, they will be shifted into lower indices.

After that, all remaining elements will be set to 0 or "".

This function is currently broken, instead use cleararray variable, 0, count;

=== getelementofarray ===
<pre>
getelementofarray(arrayname, index_expr)
</pre>
This function is invoked internally by the arrayname[index_expr] syntax.

=== if ===
<pre>
if (condition) condition_command [conditional_command_args, ...];
</pre>
If condition is zero, do nothing. Else, evaluate the conditional command.

The only thing special about the if command is the lack of commas during parsing (from my reading this is only a warning?). During execution it is perfectly normal.

=== end ===
<pre>
end;
</pre>
Stop executing the script.

Don't use this if you have opened a dialog to the player, use "close" instead. Or, use "close2" and *then* "end".

=== debugmes ===
<pre>
debugmes "string"
</pre>
Print a message to stdout.

== Message Commands ==
These are commands for dialog or one-way chat with players.

=== mes ===
<pre>
mes "string";
</pre>
Display a line of text to the player. If a dialog box is not already open for the attached NPC, one will be created.

It is unknown if the client properly supports dialog with multiple NPCs simultaneously. Note that the server only allows each account one paused script at a time, so it probably wouldn't work anyway.

=== next ===
<pre>
next;
</pre>
Stop the script until the user presses "Next" in the dialog.

=== close ===
<pre>
close;
</pre>
Stop executing the script and give the user a "Close" button in the dialog.

=== close2 ===
<pre>
close2;
</pre>
Stop the script until the user presses the "Close" button in the dialog, then keep executing the script.

WARNING: unlike close, this command is a blocking command, the usual caveats apply.

=== menu ===
<pre>
menu
"option 1", L_1,
"option 2", L_2,
"default", -;
</pre>
Display a list of choices to the player, then branch to the specified label. The special label "-" means don't branch, just continue with the next statement.

Additionally, the temporary variable "@menu" is set to the 1-based index of the choice.

The options must not contain the character ":", as the protocol uses it as a separator.

=== input ===
<pre>
input variable_name;
</pre>
Input an integer or string to the given variable, depending on whether has the '$' string postfix.

The implementation allows variable_name to be omitted if input is an integer, in case l14 is used. Don't use this.

=== announce ===
<pre>
announce "message", flag;
</pre>
Do a GM message.

If flag & 0xF == 0 forward it to all map servers.
If flag & 0x8, message is from the OID (NPC? usually?) rather than the RID (player).

If (flag & 0x7) == 1, send to all on map.
If (flag & 0x7) == 2, send to all in line of sight.
If (flag & 0x7) == 3, send to self only.
If (flag & 0x7) == anything else, send to all clients.

=== mapannounce ===
<pre>
mapannounce "mapname", "message", flag;
</pre>
Send an announcement to all players in map.

Only flag & 0x10 is interpreted, which does not work with the Mana client. So, flag must be 0.

=== areaannounce ===
<pre>
areaannounce "mapname", x0, y0, x1, y1, "message", flag;
</pre>
Send an announcement to all players in area.

Only flag & 0x10 is interpreted, which does not work with the Mana client. So, flag must be 0.

=== message ===
<pre>
message "player", "message";
</pre>
Display (in chat) a message from the server to a single user.

=== npctalk ===
<pre>
npctalk "message";
</pre>
Make an NPC say something publicly.

Note: in many cases areaannounce is a better choice.

== Character Commands ==
These have to do with attributes of the player.

=== setlook ===
<pre>
setlook type, value;
</pre>
Set an aspect of a character's appearance. Used e.g. by the barber.

There are constant provided for the LOOK type, and for hair color and hair style.

=== heal ===
<pre>
heal hp, sp
</pre>
Increase or decrease the player's hp and sp.

=== itemheal ===
<pre>
itemheal "ii"
</pre>
Increase or decrease the player's hp and sp, for use in item scripts.

=== percentheal ===
<pre>
percentheal "ii"
</pre>
Increase or decrease the player's hp and sp, by percentage of max HP.

This is probably the best way to instakill the player.

=== readparam ===
<pre>
readparam(type[, "playername"])
</pre>
Return one of the core parameters of a player.

type is one of the bCamelCase constants, see db/const.txt

=== getcharid ===
<pre>
getcharid(type[ "playername"])
</pre>
Get an id of the attached (or given) player.

Type is:
0: char id
1: party id
2: guild id (deprecated)
3: account id

You usually want 3.

=== getpartyname ===
<pre>
getpartyname(partyid)
</pre>
Return the name of the party with the given id, or "null".

=== getpartymember ===
<pre>
getpartymember partyid
</pre>
Fills in the array $@partymembername$

=== strcharinfo ===
<pre>
strcharinfo(num)
</pre>
Return string information about an account:
num==0: name
num==1: party name
num==2: guild name (deprecated)

=== sc_start ===
<pre>
sc_start type, tick, val1[, beingid];
</pre>
Apply a status effect to a player (or monster?).

type is one of the sc_* constants.

=== sc_start2 ===
<pre>
sc_start2 type, tick, val1, chance[, beingid];
</pre>
Chance of applying a status effect, out of 10000.

=== sc_end ===
<pre>
sc_end type;
</pre>
Immediately end status effect on current player.

=== sc_check ===
<pre>
sc_check(type)
</pre>
Whether a status effect is currently active.

=== getscrate ===
<pre>
getscrate(type, rate[, being_id])
</pre>
If the sc is poison, modify rate by (3 + vit + luk/3) percent.

The form that accepts a being_id is broken in the current stable version of the server.

=== resetlvl ===
<pre>
resetlvl type;
</pre>

=== resetstatus ===
<pre>
resetstatus;
</pre>

=== resetskill ===
<pre>
resetskill;
</pre>

=== changesex ===
<pre>
changesex;
</pre>
Ask the login server (via the char server) to toggle this account's sex, then kick the player.

=== attachrid ===
<pre>
attachrid(id)
</pre>
Change the being associated with this script.

Return true if such a player is logged in.

=== detachrid ===
<pre>
detachrid;
</pre>
Detach the player associated with this script.

=== isloggedin ===
<pre>
isloggedin(id)
</pre>
Return true if the given ID is logged in.

Often you shouldn't use this, but attachrid(id) instead

=== marriage ===
<pre>
marriage("otherplayer")
</pre>
Marry the attached player to the other player.

Return 1 on success and 0 on failure.

=== divorce ===
<pre>
divorce()
</pre>
Divorce the attached player from their partner

Return 1 on success and 0 on failure.

=== getpartnerid2 ===
<pre>
getpartnerid2()
</pre>
Return the ID of the attached player's partner (0 is none).

=== getexp ===
<pre>
getexp base, job;
</pre>
Increase the types of experience.

=== getinventorylist ===
<pre>
getinventorylist;
</pre>
Fill in some arrays of useful information: "@inventorylist_id", "@inventorylist_amount", "@inventorylist_equip".

The arrays are not cleared between calls, use "@inventory_count".

=== getskilllist ===
<pre>
getskilllist;
</pre>
Fill in some arrays of useful information: "@skilllist_id", "@skilllist_lv", "@skilllist_flag".

The arrays are not cleared between calls, use "@skill_count".

=== getpoolskilllist ===
<pre>
getpoolskilllist;
</pre>
Same, but only poolable skills.

=== getactivatedpoolskilllist ===
<pre>
getactivatedpoolskilllist;
</pre>
Same, but only activated pool skills.

=== getunactivatedpoolskilllist ===
<pre>
getunactivatedpoolskilllist;
</pre>
Same, but only unactivated pool skills.

=== poolskill ===
<pre>
poolskill skill_id;
</pre>
Activate a poolable skill.

=== unpoolskill ===
<pre>
unpoolskill skill_id;
</pre>
Deactivate a poolable skill.

=== checkpoolskill ===
<pre>
checkpoolskill(skill_id)
</pre>
Check if a pool skill is activated

=== misceffect ===
<pre>
misceffect type, "player_name";
misceffect type, being_id;
misceffect type;
</pre>
Display a miscellaneous effect on a being.

In the third form, it will use the OID if possible, and fallback to the RID.

=== getlook ===
<pre>
getlook(type)
</pre>
Return part of the player's appearance:
val==1: hair
val==2: weapon
val==3: bottom
val==4: middle
val==5: top
val==6: hair color
val==8: shield
val==9: shoes

On failure, return -1.

=== getsavepoint ===
<pre>
getsavepoint(type)
</pre>
type==0: Return savepoint map
type==1: Return savepoint x
type==2: Return savepoint y

This is believed to be the only function (other than callfunc and callsub of course) that returns a different type depending on its arguments.

=== shop ===
<pre>
shop "npcname";
</pre>
Close the script and open the given NPC's shop.

=== isdead ===
<pre>
isdead()
</pre>
Return 1 if the attached player is dead, else 0.

=== fakenpcname ===
<pre>
fakenpcname "name", "newname", new_sprite_id;
</pre>
Change the appearance of an NPC.

== Location Commands ==
These are commands that have to do with the location of players

=== warp ===
<pre>
warp "mapname", x, y;
</pre>
Warp the attached player to the given location. "mapname" may have the special values "Random", "SavePoint", and "Save" (case-sensitive), but x and y are still required.

=== isat ===
<pre>
isat("mapname", x, y)
</pre>
Return 1 if the attached player is at the given location, 0 otherwise.

=== areawarp ===
<pre>
areawarp "src_map", x0, y0, x1, y1, "dst_map", x, y;
</pre>
Warp all players in the given area to the given location.

=== getusers ===
<pre>
getusers(type)
</pre>
Count users.

If flag & 0x8, base on OID instead of RID.
If (flag & 0x7) == 0, return users on the map.
If (flag & 0x7) == 1, return users on the server.

=== getmapusers ===
<pre>
getmapusers("mapname")
</pre>
Count users on a given map.

=== getareausers ===
<pre>
getareausers("mapname", x0, y0, x1, y1)
</pre>
Count users in an area.

=== mapwarp ===
<pre>
mapwarp "src_map", "dst_map", x, y;
</pre>
Warp all players from source map to destination location.

=== npcwarp ===
<pre>
npcwarp x, y, "npcname";
</pre>
Move an NPC to a different location on the same map.

=== isin ===
<pre>
isin("mapname", x0, y0, x1, y1)
</pre>
Check if the player is in the area.

=== getx ===
<pre>
getx()
</pre>
Return attached player's x coordinate.

=== gety ===
<pre>
gety()
</pre>
Return attached player's y coordinate.

== Item Commands ==
These have to do with items or inventory.

=== getitem ===
<pre>
getitem "itemname", count[, unused_argument[, playerid]];
getitem itemid, count[, unused_argument[, playerid]];
"ii**"
</pre>
Grant the attached player (or the given player) "count" copies of an item.

If itemname is unrecognized you get an iten (727) instead.

=== makeitem ===
<pre>
makeitem "itemname", count, "mapname", x, y;
makeitem itemid, count, "mapname", x, y;
</pre>
Drop items on the ground.

The special "mapname" value "this" means the map of the attached player.

=== delitem ===
<pre>
delitem "itemname", count;
delitem itemid, count;
</pre>
Remove items from the attached player's inventory.

This command is buggy if the player does not have enough of the item.

=== countitem ===
<pre>
countitem("itemname")
countitem(itemid)
</pre>
Return the number of the given item in the player's inventory.

=== checkweight ===
<pre>
checkweight("itemname", count)
checkweight(itemid, count)
</pre>
Return 0 if adding "count" of the item would put player above max weight, 1 if it would still be less than max weight.
Also returns 0 if item does not exist.

=== getequipid ===
<pre>
getequipid(equip_point)
</pre>
Return the ID of the item in the given equip slot.

equip_point is one of the equip_* constants

=== getequipname ===
<pre>
getequipname(equip_point)
</pre>
Return the name of the item in the given equip slot.

equip_point is one of the equip_* constants

=== getequipisequiped ===
<pre>
getequipisequiped(num)
</pre>
Return 1 if the player currently has an item equipped in the slot.

=== statusup ===
<pre>
statusup bType;
</pre>
Permanently increase a stat by one point.

=== statusup2 ===
<pre>
statusup2 bType, delta;
</pre>
Permanently increase or decrease a stat.

=== bonus ===
<pre>
bonus bType, delta
</pre>
Temporarily increase a stat. For use in item scripts only.

=== skill ===
<pre>
skill id, level[, flag = 1];
</pre>
Grant a skill.

flag==0: permanent skill
flag==1: temporary skill (item scripts only)

(Untested)

=== setskill ===
<pre>
setskill id, level;
</pre>
Grant a skill permanently.

=== getskilllv ===
<pre>
getskilllv(skill)
</pre>
Return the player's level of the given skill.

=== getgmlevel ===
<pre>
getgmlevel()
</pre>
Return the player's GM level.

=== getopt2 ===
<pre>
getopt2()
</pre>
Return the player's opt2 flags.

=== setopt2 ===
<pre>
setopt2 flags;
</pre>
Set the player's opt2 flags.

=== checkoption ===
<pre>
checkoption(type)
</pre>
Return 1 if the player has any of the given (XOR'ed) option bits. Usually only one is given.

=== setoption ===
<pre>
setoption type
</pre>
Set the player's option flags exactly (not OR'ing).

=== savepoint ===
<pre>
savepoint "mapname", x, y;
</pre>
Set the player's save point. Used e.g. by Soul Menhirs, and during the time travel quest.

=== openstorage ===
<pre>
openstorage;
</pre>
Open the player's storage.

=== getitemname ===
<pre>
getitemname("itemname")
getitemname(itemid)
</pre>
Return the name of the item, or "Unknown Item".

=== clearitem ===
<pre>
clearitem;
</pre>
Remove all items from a player's inventory.

=== nude ===
<pre>
nude;
</pre>
Unequip all items.

=== hasitems ===
<pre>
hasitems()
</pre>
Return 1 if the player has any inventory, 0 otherwise.

=== unequipbyid ===
<pre>
unequipbyid slot_id;
</pre>
Unequip whatever is in the slot

=== getareadropitem ===
<pre>
getareadropitem("mapname", x0, y0, x1, y1, "itemname"[, delitems = 0]);
getareadropitem("mapname", x0, y0, x1, y1, itemid[, delitems = 0]);
</pre>
Count items on the floor in an area. If delitems, the items will be deleted as well.

== Common Functions ==
These are not mostly not related to the RPG or the scripting language.

=== rand ===
<pre>
rand(range)
rand(min, max)
</pre>
In the first form, return a random number between 0 (inclusive) and range (exclusive). Return 0 if range is not positive.
In the second form, return a random number between min and max, inclusive. Min and max may be swapped.

=== gettimetick ===
<pre>
gettimetick(type)
</pre>
Return one of the ticks

type==0 (or other): milliseconds since some point in time, wraps every 50 days.
type==1: time since midnight, UTC.
type==2: seconds since the epoch.

You should almost always use type 2.

=== gettime ===
<pre>
gettime(type)
</pre>
Get a component of the time (UTC).

1: second (0-59)
2: minute (0-59)
3: hour (0-23)
4: day of week (0-6)
5: day of month (1-31)
6: month (1-12)
7: year (1902-2038)

=== gettimestr ===
<pre>
gettimestr("format", length)
</pre>
Frontend for strftime(3).

This function may be removed for technical reasons, please construct the string manually using gettime().

There is a script function that does this: callfunct "time_stamp";

== Timers and Events ==
These have to do with transfering control in ways that are not immediately obvious.

The most common ones are initnpctimer or startnpctimer, stopnpctimer, and setnpctimer.

=== doevent ===
<pre>
doevent "event";
</pre>
Manually invoke an NPC event.

=== donpcevent ===
<pre>
donpcevent "event";
</pre>
Manually invoke an NPC event.

=== addtimer ===
<pre>
addtimer tick, "event";
</pre>
Invoke an NPC event after a delay, for the attached NPC.

This command does the same thing as areatimer, but for only the attached player.

=== deltimer ===
<pre>
deltimer "event";
</pre>
This command is untested and might freeze the server.

=== initnpctimer ===
<pre>
initnpctimer;
</pre>
Set the NPC's attached timer to tick 0 and start it.

This is equivalent to setnpctimer, 0; startnpctimer;

=== stopnpctimer ===
<pre>
stopnpctimer;
</pre>
Stop the NPC's attached timer.

This DOES NOT do anything about the tick. But that's okay, you should normally be starting it with initnpctimer.

=== startnpctimer ===
<pre>
startnpctimer;
</pre>
Start the NPC's attached timer, without setting the tick.

=== setnpctimer ===
<pre>
setnpctimer tick;
</pre>
Set the NPC's timer to a specific tick. Generally, this is only useful for tick 0.

=== getnpctimer ===
<pre>
getnpctimer(type)
</pre>
Get the current tick of an NPC's timer.

type==0: timer event tick (like setnpctimer)
type==1: bool if it has a next timer.
type==2: timer amount

=== cmdothernpc ===
<pre>
cmdothernpc "npc", "Foo";
</pre>
Invoke ::OnCommandFoo

=== mobcount ===
<pre>
mobcount("mapname", "event")
</pre>
Count the remaining mobs from the spawn with the given event.

=== areatimer ===
<pre>
areatimer "mapname", x0, y0, x1, y1, tick, "event";
</pre>
Add a PC event timer to all players in the area.

After "tick" milliseconds, the given NPC event will fire with each player as the RID.

== Unsorted Commands ==
These are commands that still need sorting, please edit this page, see talk page for category (and subcategory?) suggestions.

=== monster ===
<pre>
monster "mapname", x, y, "string", class, count[, "event"];
</pre>
Spawn monsters at a point. If you define an OnDead event using a trigger area then the event is shot only inside that area, hence the event is ignored when the monster is killed outside the trigger area.

=== areamonster ===
<pre>
areamonster "mapname", x0, y0, x1, y1, "string", class, count[, "event"];
</pre>
Spawn monsters in an area. If you define an OnDead event using a trigger area then the event is shot only inside that area, hence the event is ignored when the monster is killed outside the trigger area.

=== killmonster ===
<pre>
killmonster "mapname", "event";
</pre>
Kill monsters on a map.

Unless it is "All", "event" must match the one used at spawn time.

If "All" is given, this function properly preserves permanently respawning monsters.

=== killmonsterall ===
<pre>
killmonsterall "mapname";
</pre>
Kill all monsters unconditionally.

This command might prevent monsters from respawning. Instead use "killmonster" with "event" == "All".

=== enablenpc ===
<pre>
enablenpc "name";
</pre>
Enable an NPC.

=== disablenpc ===
<pre>
disablenpc "name";
</pre>
Disable an NPC.

=== hideoffnpc ===
<pre>
hideoffnpc "name";
</pre>
What does this do?

=== hideonnpc ===
<pre>
hideonnpc "name";
</pre>
What does this do?

=== setmapflagnosave ===
<pre>
setmapflagnosave "mapname", "savemap", x, y;
</pre>
Set the nosave flag and respawn location.

=== setmapflag ===
<pre>
setmapflag "mapname", flag;
</pre>
Set an arbitrary mapflag.

This function may be problematic in the stable version.

=== removemapflag ===
<pre>
removemapflag "mapname", flag;
</pre>
Unset an arbitrary mapflag.

This function may be problematic in the stable version.

=== pvpon ===
<pre>
pvpon "mapname";
</pre>
Allow PvP on a map.

=== pvpoff ===
<pre>
pvpoff "mapname";
</pre>
Deny PvP on a map.

=== emotion ===
<pre>
emotion emote_index;
</pre>
Show a smiley above the OID.

=== getspellinvocation ===
<pre>
getspellinvocation("spell-identifier")
</pre>
Return the #invocation used for a spell, or "...".

=== getanchorinvocation ===
<pre>
getanchorinvocation "anchor-identifier"
</pre>
Return the invocation used for a teleport anchor (?)

=== strmobinfo ===
<pre>
strmobinfo(num, class)
</pre>
Info about a type of mob:
num==1: name
num==2: jname
num==3: lv
num==4: maxhp
num==5: maxsp
num==6: base_exp
num==7: job_exp

Note that only types 1 and 2 actually return strings, the rest return integers

=== specialeffect ===
<pre>
specialeffect type;
</pre>
Display a special effect on the OID.

Same as "misceffect", but does not fallback when there is no OID.

=== specialeffect2 ===
<pre>
specialeffect2 type;
</pre>
Same as "misceffect", but works when there is an OID.

=== gmcommand ===
<pre>
gmcommand "@command maybe with arguments";
</pre>
Run a GM command, at level 99.

Classic:TmwAthena Scripting Reference

2012-05-04T15:01:36Z

Jenalya: /* monster */ Add note about behaviour of event monsters in trigger area NPCs.

This page is a reference for commands believed to work in the eAthena scripting language still used by tmwAthena.

A number of problematic commands have been removed from this list, but not all commands have been tested.

== Language Commands ==
These are command that are closely tied to the language itself.

=== goto ===
<pre>
goto L_1;
</pre>
Unconditionally jump to a label. Often used in an "if" body.

=== callsub ===
<pre>
callsub S_labelname, arguments...;
</pre>
Jump to the given label. When the "return" statement is executed, continue on the next line.

It is not known whether "arguments..." works, we use temporary variables instead.

It might also be possible to use this as a function, if the form of return with a value is used, but we use temporary variables instead.

=== callfunc ===
<pre>
callfunc "function_name", arguments...;
</pre>
Jump to the given function script. When the "return" statement is executed, continue on the next line of this script.

It is not known whether "arguments..." works, we use temporary variables instead.

It might also be possible to use this as a function, if the form of return with a value is used, but we use temporary variables instead.

"return" is broken if this is used from within an if(). If you need a conditional callfunc, first goto a label.

=== return ===
<pre>
return;
return expr;
</pre>
Return from this script or sublabel to the calling function.

It is unknown what happens if this is used from the top-level script, use "close" or "end" instead.

We use temporary variables instead of the form that returns an expression.

=== getarg ===
<pre>
getarg(index)
</pre>
Return (by reference?) an argument of "callsub" or "callfunc". Aborts the script if used at toplevel of if out of range.

We use temporary variables instead.

=== set ===
<pre>
set variable, expression;
</pre>
Very common command, to set variables.

=== setarray ===
<pre>
setarray arrayvariable, val1, val2, ...;
</pre>
Set elements of an array. Previous elements are not cleared. At most 128 elements can be assigned.

It is currently possible, but deprecated, to specify a (zero-based) array index to start at the given part of an array. It's pretty amazing that that code works anyway.

Remember that there are no permanent arrays, only temporary.

=== cleararray ===
<pre>
cleararray variable, value, count;
</pre>
Fill an array with "count" copies of "value".

=== copyarray ===
<pre>
copyarray dest_var, src_var, count;
</pre>
Copy elements of an array.

This function looks broken to me.

=== getarraysize ===
<pre>
getarraysize variable;
</pre>
Get the size of an array.

The size of an array is simply one more than the index of the last nonzero integer or nonempty string.

WARNING: most functions that set an array do not bother to clear out high indices. You should almost always use an explicitly-provided size instead.

=== deletearray ===
<pre>
deletearray variable[, count = 1];
</pre>
Remove count elements from an array.

If there are elements beyond count, they will be shifted into lower indices.

After that, all remaining elements will be set to 0 or "".

This function is currently broken, instead use cleararray variable, 0, count;

=== getelementofarray ===
<pre>
getelementofarray(arrayname, index_expr)
</pre>
This function is invoked internally by the arrayname[index_expr] syntax.

=== if ===
<pre>
if (condition) condition_command [conditional_command_args, ...];
</pre>
If condition is zero, do nothing. Else, evaluate the conditional command.

The only thing special about the if command is the lack of commas during parsing (from my reading this is only a warning?). During execution it is perfectly normal.

=== end ===
<pre>
end;
</pre>
Stop executing the script.

Don't use this if you have opened a dialog to the player, use "close" instead. Or, use "close2" and *then* "end".

=== debugmes ===
<pre>
debugmes "string"
</pre>
Print a message to stdout.

== Message Commands ==
These are commands for dialog or one-way chat with players.

=== mes ===
<pre>
mes "string";
</pre>
Display a line of text to the player. If a dialog box is not already open for the attached NPC, one will be created.

It is unknown if the client properly supports dialog with multiple NPCs simultaneously. Note that the server only allows each account one paused script at a time, so it probably wouldn't work anyway.

=== next ===
<pre>
next;
</pre>
Stop the script until the user presses "Next" in the dialog.

=== close ===
<pre>
close;
</pre>
Stop executing the script and give the user a "Close" button in the dialog.

=== close2 ===
<pre>
close2;
</pre>
Stop the script until the user presses the "Close" button in the dialog, then keep executing the script.

WARNING: unlike close, this command is a blocking command, the usual caveats apply.

=== menu ===
<pre>
menu
"option 1", L_1,
"option 2", L_2,
"default", -;
</pre>
Display a list of choices to the player, then branch to the specified label. The special label "-" means don't branch, just continue with the next statement.

Additionally, the temporary variable "@menu" is set to the 1-based index of the choice.

The options must not contain the character ":", as the protocol uses it as a separator.

=== input ===
<pre>
input variable_name;
</pre>
Input an integer or string to the given variable, depending on whether has the '$' string postfix.

The implementation allows variable_name to be omitted if input is an integer, in case l14 is used. Don't use this.

=== announce ===
<pre>
announce "message", flag;
</pre>
Do a GM message.

If flag & 0xF == 0 forward it to all map servers.
If flag & 0x8, message is from the OID (NPC? usually?) rather than the RID (player).

If (flag & 0x7) == 1, send to all on map.
If (flag & 0x7) == 2, send to all in line of sight.
If (flag & 0x7) == 3, send to self only.
If (flag & 0x7) == anything else, send to all clients.

=== mapannounce ===
<pre>
mapannounce "mapname", "message", flag;
</pre>
Send an announcement to all players in map.

Only flag & 0x10 is interpreted, which does not work with the Mana client. So, flag must be 0.

=== areaannounce ===
<pre>
areaannounce "mapname", x0, y0, x1, y1, "message", flag;
</pre>
Send an announcement to all players in area.

Only flag & 0x10 is interpreted, which does not work with the Mana client. So, flag must be 0.

=== message ===
<pre>
message "player", "message";
</pre>
Display (in chat) a message from the server to a single user.

=== npctalk ===
<pre>
npctalk "message";
</pre>
Make an NPC say something publicly.

Note: in many cases areaannounce is a better choice.

== Character Commands ==
These have to do with attributes of the player.

=== setlook ===
<pre>
setlook type, value;
</pre>
Set an aspect of a character's appearance. Used e.g. by the barber.

There are constant provided for the LOOK type, and for hair color and hair style.

=== heal ===
<pre>
heal hp, sp
</pre>
Increase or decrease the player's hp and sp.

=== itemheal ===
<pre>
itemheal "ii"
</pre>
Increase or decrease the player's hp and sp, for use in item scripts.

=== percentheal ===
<pre>
percentheal "ii"
</pre>
Increase or decrease the player's hp and sp, by percentage of max HP.

This is probably the best way to instakill the player.

=== readparam ===
<pre>
readparam(type[, "playername"])
</pre>
Return one of the core parameters of a player.

type is one of the bCamelCase constants, see db/const.txt

=== getcharid ===
<pre>
getcharid(type[ "playername"])
</pre>
Get an id of the attached (or given) player.

Type is:
0: char id
1: party id
2: guild id (deprecated)
3: account id

You usually want 3.

=== getpartyname ===
<pre>
getpartyname(partyid)
</pre>
Return the name of the party with the given id, or "null".

=== getpartymember ===
<pre>
getpartymember partyid
</pre>
Fills in the array $@partymembername$

=== strcharinfo ===
<pre>
strcharinfo(num)
</pre>
Return string information about an account:
num==0: name
num==1: party name
num==2: guild name (deprecated)

=== sc_start ===
<pre>
sc_start type, tick, val1[, beingid];
</pre>
Apply a status effect to a player (or monster?).

type is one of the sc_* constants.

=== sc_start2 ===
<pre>
sc_start2 type, tick, val1, chance[, beingid];
</pre>
Chance of applying a status effect, out of 10000.

=== sc_end ===
<pre>
sc_end type;
</pre>
Immediately end status effect on current player.

=== sc_check ===
<pre>
sc_check(type)
</pre>
Whether a status effect is currently active.

=== getscrate ===
<pre>
getscrate(type, rate[, being_id])
</pre>
If the sc is poison, modify rate by (3 + vit + luk/3) percent.

The form that accepts a being_id is broken in the current stable version of the server.

=== resetlvl ===
<pre>
resetlvl type;
</pre>

=== resetstatus ===
<pre>
resetstatus;
</pre>

=== resetskill ===
<pre>
resetskill;
</pre>

=== changesex ===
<pre>
changesex;
</pre>
Ask the login server (via the char server) to toggle this account's sex, then kick the player.

=== attachrid ===
<pre>
attachrid(id)
</pre>
Change the being associated with this script.

Return true if such a player is logged in.

=== detachrid ===
<pre>
detachrid;
</pre>
Detach the player associated with this script.

=== isloggedin ===
<pre>
isloggedin(id)
</pre>
Return true if the given ID is logged in.

Often you shouldn't use this, but attachrid(id) instead

=== marriage ===
<pre>
marriage("otherplayer")
</pre>
Marry the attached player to the other player.

Return 1 on success and 0 on failure.

=== divorce ===
<pre>
divorce()
</pre>
Divorce the attached player from their partner

Return 1 on success and 0 on failure.

=== getpartnerid2 ===
<pre>
getpartnerid2()
</pre>
Return the ID of the attached player's partner (0 is none).

=== getexp ===
<pre>
getexp base, job;
</pre>
Increase the types of experience.

=== getinventorylist ===
<pre>
getinventorylist;
</pre>
Fill in some arrays of useful information: "@inventorylist_id", "@inventorylist_amount", "@inventorylist_equip".

The arrays are not cleared between calls, use "@inventory_count".

=== getskilllist ===
<pre>
getskilllist;
</pre>
Fill in some arrays of useful information: "@skilllist_id", "@skilllist_lv", "@skilllist_flag".

The arrays are not cleared between calls, use "@skill_count".

=== getpoolskilllist ===
<pre>
getpoolskilllist;
</pre>
Same, but only poolable skills.

=== getactivatedpoolskilllist ===
<pre>
getactivatedpoolskilllist;
</pre>
Same, but only activated pool skills.

=== getunactivatedpoolskilllist ===
<pre>
getunactivatedpoolskilllist;
</pre>
Same, but only unactivated pool skills.

=== poolskill ===
<pre>
poolskill skill_id;
</pre>
Activate a poolable skill.

=== unpoolskill ===
<pre>
unpoolskill skill_id;
</pre>
Deactivate a poolable skill.

=== checkpoolskill ===
<pre>
checkpoolskill(skill_id)
</pre>
Check if a pool skill is activated

=== misceffect ===
<pre>
misceffect type, "player_name";
misceffect type, being_id;
misceffect type;
</pre>
Display a miscellaneous effect on a being.

In the third form, it will use the OID if possible, and fallback to the RID.

=== getlook ===
<pre>
getlook(type)
</pre>
Return part of the player's appearance:
val==1: hair
val==2: weapon
val==3: bottom
val==4: middle
val==5: top
val==6: hair color
val==8: shield
val==9: shoes

On failure, return -1.

=== getsavepoint ===
<pre>
getsavepoint(type)
</pre>
type==0: Return savepoint map
type==1: Return savepoint x
type==2: Return savepoint y

This is believed to be the only function (other than callfunc and callsub of course) that returns a different type depending on its arguments.

=== shop ===
<pre>
shop "npcname";
</pre>
Close the script and open the given NPC's shop.

=== isdead ===
<pre>
isdead()
</pre>
Return 1 if the attached player is dead, else 0.

=== fakenpcname ===
<pre>
fakenpcname "name", "newname", new_sprite_id;
</pre>
Change the appearance of an NPC.

== Location Commands ==
These are commands that have to do with the location of players

=== warp ===
<pre>
warp "mapname", x, y;
</pre>
Warp the attached player to the given location. "mapname" may have the special values "Random", "SavePoint", and "Save" (case-sensitive), but x and y are still required.

=== isat ===
<pre>
isat("mapname", x, y)
</pre>
Return 1 if the attached player is at the given location, 0 otherwise.

=== areawarp ===
<pre>
areawarp "src_map", x0, y0, x1, y1, "dst_map", x, y;
</pre>
Warp all players in the given area to the given location.

=== getusers ===
<pre>
getusers(type)
</pre>
Count users.

If flag & 0x8, base on OID instead of RID.
If (flag & 0x7) == 0, return users on the map.
If (flag & 0x7) == 1, return users on the server.

=== getmapusers ===
<pre>
getmapusers("mapname")
</pre>
Count users on a given map.

=== getareausers ===
<pre>
getareausers("mapname", x0, y0, x1, y1)
</pre>
Count users in an area.

=== mapwarp ===
<pre>
mapwarp "src_map", "dst_map", x, y;
</pre>
Warp all players from source map to destination location.

=== npcwarp ===
<pre>
npcwarp x, y, "npcname";
</pre>
Move an NPC to a different location on the same map.

=== isin ===
<pre>
isin("mapname", x0, y0, x1, y1)
</pre>
Check if the player is in the area.

=== getx ===
<pre>
getx()
</pre>
Return attached player's x coordinate.

=== gety ===
<pre>
gety()
</pre>
Return attached player's y coordinate.

== Item Commands ==
These have to do with items or inventory.

=== getitem ===
<pre>
getitem "itemname", count[, unused_argument[, playerid]];
getitem itemid, count[, unused_argument[, playerid]];
"ii**"
</pre>
Grant the attached player (or the given player) "count" copies of an item.

If itemname is unrecognized you get an iten (727) instead.

=== makeitem ===
<pre>
makeitem "itemname", count, "mapname", x, y;
makeitem itemid, count, "mapname", x, y;
</pre>
Drop items on the ground.

The special "mapname" value "this" means the map of the attached player.

=== delitem ===
<pre>
delitem "itemname", count;
delitem itemid, count;
</pre>
Remove items from the attached player's inventory.

This command is buggy if the player does not have enough of the item.

=== countitem ===
<pre>
countitem("itemname")
countitem(itemid)
</pre>
Return the number of the given item in the player's inventory.

=== checkweight ===
<pre>
checkweight("itemname", count)
checkweight(itemid, count)
</pre>
Return 0 if adding "count" of the item would put player above max weight, 1 if it would still be less than max weight.
Also returns 0 if item does not exist.

=== getequipid ===
<pre>
getequipid(equip_point)
</pre>
Return the ID of the item in the given equip slot.

equip_point is one of the equip_* constants

=== getequipname ===
<pre>
getequipname(equip_point)
</pre>
Return the name of the item in the given equip slot.

equip_point is one of the equip_* constants

=== getequipisequiped ===
<pre>
getequipisequiped(num)
</pre>
Return 1 if the player currently has an item equipped in the slot.

=== statusup ===
<pre>
statusup bType;
</pre>
Permanently increase a stat by one point.

=== statusup2 ===
<pre>
statusup2 bType, delta;
</pre>
Permanently increase or decrease a stat.

=== bonus ===
<pre>
bonus bType, delta
</pre>
Temporarily increase a stat. For use in item scripts only.

=== skill ===
<pre>
skill id, level[, flag = 1];
</pre>
Grant a skill.

flag==0: permanent skill
flag==1: temporary skill (item scripts only)

(Untested)

=== setskill ===
<pre>
setskill id, level;
</pre>
Grant a skill permanently.

=== getskilllv ===
<pre>
getskilllv(skill)
</pre>
Return the player's level of the given skill.

=== getgmlevel ===
<pre>
getgmlevel()
</pre>
Return the player's GM level.

=== getopt2 ===
<pre>
getopt2()
</pre>
Return the player's opt2 flags.

=== setopt2 ===
<pre>
setopt2 flags;
</pre>
Set the player's opt2 flags.

=== checkoption ===
<pre>
checkoption(type)
</pre>
Return 1 if the player has any of the given (XOR'ed) option bits. Usually only one is given.

=== setoption ===
<pre>
setoption type
</pre>
Set the player's option flags exactly (not OR'ing).

=== savepoint ===
<pre>
savepoint "mapname", x, y;
</pre>
Set the player's save point. Used e.g. by Soul Menhirs, and during the time travel quest.

=== openstorage ===
<pre>
openstorage;
</pre>
Open the player's storage.

=== getitemname ===
<pre>
getitemname("itemname")
getitemname(itemid)
</pre>
Return the name of the item, or "Unknown Item".

=== clearitem ===
<pre>
clearitem;
</pre>
Remove all items from a player's inventory.

=== nude ===
<pre>
nude;
</pre>
Unequip all items.

=== hasitems ===
<pre>
hasitems()
</pre>
Return 1 if the player has any inventory, 0 otherwise.

=== unequipbyid ===
<pre>
unequipbyid slot_id;
</pre>
Unequip whatever is in the slot

=== getareadropitem ===
<pre>
getareadropitem("mapname", x0, y0, x1, y1, "itemname"[, delitems = 0]);
getareadropitem("mapname", x0, y0, x1, y1, itemid[, delitems = 0]);
</pre>
Count items on the floor in an area. If delitems, the items will be deleted as well.

== Common Functions ==
These are not mostly not related to the RPG or the scripting language.

=== rand ===
<pre>
rand(range)
rand(min, max)
</pre>
In the first form, return a random number between 0 (inclusive) and range (exclusive). Return 0 if range is not positive.
In the second form, return a random number between min and max, inclusive. Min and max may be swapped.

=== gettimetick ===
<pre>
gettimetick(type)
</pre>
Return one of the ticks

type==0 (or other): milliseconds since some point in time, wraps every 50 days.
type==1: time since midnight, UTC.
type==2: seconds since the epoch.

You should almost always use type 2.

=== gettime ===
<pre>
gettime(type)
</pre>
Get a component of the time (UTC).

1: second (0-59)
2: minute (0-59)
3: hour (0-23)
4: day of week (0-6)
5: day of month (1-31)
6: month (1-12)
7: year (1902-2038)

=== gettimestr ===
<pre>
gettimestr("format", length)
</pre>
Frontend for strftime(3).

This function may be removed for technical reasons, please construct the string manually using gettime().

There is a script function that does this: callfunct "time_stamp";

== Timers and Events ==
These have to do with transfering control in ways that are not immediately obvious.

The most common ones are initnpctimer or startnpctimer, stopnpctimer, and setnpctimer.

=== doevent ===
<pre>
doevent "event";
</pre>
Manually invoke an NPC event.

=== donpcevent ===
<pre>
donpcevent "event";
</pre>
Manually invoke an NPC event.

=== addtimer ===
<pre>
addtimer tick, "event";
</pre>
Invoke an NPC event after a delay, for the attached NPC.

This command does the same thing as areatimer, but for only the attached player.

=== deltimer ===
<pre>
deltimer "event";
</pre>
This command is untested and might freeze the server.

=== initnpctimer ===
<pre>
initnpctimer;
</pre>
Set the NPC's attached timer to tick 0 and start it.

This is equivalent to setnpctimer, 0; startnpctimer;

=== stopnpctimer ===
<pre>
stopnpctimer;
</pre>
Stop the NPC's attached timer.

This DOES NOT do anything about the tick. But that's okay, you should normally be starting it with initnpctimer.

=== startnpctimer ===
<pre>
startnpctimer;
</pre>
Start the NPC's attached timer, without setting the tick.

=== setnpctimer ===
<pre>
setnpctimer tick;
</pre>
Set the NPC's timer to a specific tick. Generally, this is only useful for tick 0.

=== getnpctimer ===
<pre>
getnpctimer(type)
</pre>
Get the current tick of an NPC's timer.

type==0: timer event tick (like setnpctimer)
type==1: bool if it has a next timer.
type==2: timer amount

=== cmdothernpc ===
<pre>
cmdothernpc "npc", "Foo";
</pre>
Invoke ::OnCommandFoo

=== mobcount ===
<pre>
mobcount("mapname", "event")
</pre>
Count the remaining mobs from the spawn with the given event.

=== areatimer ===
<pre>
areatimer "mapname", x0, y0, x1, y1, tick, "event";
</pre>
Add a PC event timer to all players in the area.

After "tick" milliseconds, the given NPC event will fire with each player as the RID.

== Unsorted Commands ==
These are commands that still need sorting, please edit this page, see talk page for category (and subcategory?) suggestions.

=== monster ===
<pre>
monster "mapname", x, y, "string", class, count[, "event"];
</pre>
Spawn monsters at a point. If you define an OnDead event using a trigger area then the event is shot only inside that area, hence the event is ignored when the monster is killed outside the trigger area.

=== areamonster ===
<pre>
areamonster "mapname", x0, y0, x1, y1, "string", class, count[, "event"];
</pre>
Spawn monsters in an area.

=== killmonster ===
<pre>
killmonster "mapname", "event";
</pre>
Kill monsters on a map.

Unless it is "All", "event" must match the one used at spawn time.

If "All" is given, this function properly preserves permanently respawning monsters.

=== killmonsterall ===
<pre>
killmonsterall "mapname";
</pre>
Kill all monsters unconditionally.

This command might prevent monsters from respawning. Instead use "killmonster" with "event" == "All".

=== enablenpc ===
<pre>
enablenpc "name";
</pre>
Enable an NPC.

=== disablenpc ===
<pre>
disablenpc "name";
</pre>
Disable an NPC.

=== hideoffnpc ===
<pre>
hideoffnpc "name";
</pre>
What does this do?

=== hideonnpc ===
<pre>
hideonnpc "name";
</pre>
What does this do?

=== setmapflagnosave ===
<pre>
setmapflagnosave "mapname", "savemap", x, y;
</pre>
Set the nosave flag and respawn location.

=== setmapflag ===
<pre>
setmapflag "mapname", flag;
</pre>
Set an arbitrary mapflag.

This function may be problematic in the stable version.

=== removemapflag ===
<pre>
removemapflag "mapname", flag;
</pre>
Unset an arbitrary mapflag.

This function may be problematic in the stable version.

=== pvpon ===
<pre>
pvpon "mapname";
</pre>
Allow PvP on a map.

=== pvpoff ===
<pre>
pvpoff "mapname";
</pre>
Deny PvP on a map.

=== emotion ===
<pre>
emotion emote_index;
</pre>
Show a smiley above the OID.

=== getspellinvocation ===
<pre>
getspellinvocation("spell-identifier")
</pre>
Return the #invocation used for a spell, or "...".

=== getanchorinvocation ===
<pre>
getanchorinvocation "anchor-identifier"
</pre>
Return the invocation used for a teleport anchor (?)

=== strmobinfo ===
<pre>
strmobinfo(num, class)
</pre>
Info about a type of mob:
num==1: name
num==2: jname
num==3: lv
num==4: maxhp
num==5: maxsp
num==6: base_exp
num==7: job_exp

Note that only types 1 and 2 actually return strings, the rest return integers

=== specialeffect ===
<pre>
specialeffect type;
</pre>
Display a special effect on the OID.

Same as "misceffect", but does not fallback when there is no OID.

=== specialeffect2 ===
<pre>
specialeffect2 type;
</pre>
Same as "misceffect", but works when there is an OID.

=== gmcommand ===
<pre>
gmcommand "@command maybe with arguments";
</pre>
Run a GM command, at level 99.

Raging Skill

2012-04-29T13:10:32Z

Jenalya: Some small fixes regarding the backgroundstory of the quests

{{I18n}}

{{Quest
|Image = [[Image:yerrnk.png]][[Image:birrod-kimarr.png]]
|Start = 033-1 Snow Path, Southwest of Nivalis
|Prerequisites = [[Focusing Skills]]
|Level = 40
|Reward = [[Raging Skill]]
|Cost = Apples and/or Cakes
}}
The Barbarians are members of the Mangarr Tribe. Under the orders of first warrior Yerrnk, warrior Birrod and Hunter/warrior Kimarr are seeking help for a problem with unusually aggressive monsters threatening their tribe. You will have to prove your hunting skills with Kimarr, your chivalrous skill and mind with Birrod, and strength with Yerrnk. This may be adventure may seem hard but getting the Mangarr's respect and friendship is really worth the pain.

==The First Quest - Hunting Hungry Fluffies==
# Talk to Kimarr, and he suggests you to prove your warrior ability and enter the closed area near the entrance to the cave. You agree and and are warped inside the area.
# You have to drop some Red Apples, Green Apples, Cakes or Xmas Cakes in order to call some Hungry Fluffies out.
##If you drop Apples '''one''' Hungry Fluffy is spawned per dropped apple.
##If you drop Cakes, '''three''' Hungry Fluffies are spawned per dropped cake.
##If you drop Xmas Cakes, '''five''' Hungry Fluffies are spawned per dropped Xmas cake.
# The goal of that minigame is to kill at least 1 + (YourLevel*7)/10 Hungry Fluffies in 3 minutes. If you fail, you may try until you succeed. You get [[Item Reference/Chest Armor#Yeti Shirt|Yeti Shirt]] as a reward for killing the required amount of Hungry Fluffies.

==The Second Quest - Hunting Wolverns==
# You need to be at least '''level 40''' to complete this part.
# After that you have to talk to Birrod and to get the quest for killing Wolverns in the western Snow Forest (034-1). You have to kill at least 16 Wolverns. These wolverns will prepare ambushes against you by groups of 3 or 4, so watch out while walking in the forest.
# After killing the required number of Wolverns, go back to Birrod; he will ask you some questions. You will need to show yourself as brave and generous as possible.
# You will receive the [[Raging Skill]] and 5,000 XP as a reward. Also Birrod welcomes you as a tribe member.

==The Third Quest - Hunting a Yeti==
# You need to be at least '''level 70''' to complete this part.
# Now talk to Yerrnk and ask him for a task. He asks you to kill a Yeti near a hut in the south-west part of Snow Forest (034-1).
# When you're done, return to Yerrnk to receive another reward, the [[Item Reference/Leg Armor#Leather Trousers|Leather Trousers]].
==Raging Skill==

This [[Skills|skill]] is intended for warriors. When focused on it will make you hit harder with '''hand weapons''' by increasing the probablility of critical hits. This additional probability is based on '''strength''', thus the higher strength, the more critical hits (and higher). You pay it with a ''defense noticeable decrease'', so you may require healing assistance; but here again what is better than comradeship, born in blood, sweat and tears?

==Hints:==

* Every time you drop Apples or Cakes, not only fluffies can appear, but Ice Goblins, Wolverns and Yetis can come out, the number and strength depending on your level when you start the mini-game.
* If somebody helps you for the First Quest by using attack [[Spells]] for example, this person will die. You can be healed though.
* Use concentration and iron potions (3 each max)

==Rewards:==

* Yeti Shirt
* [[Raging Skill]]
* Leather Trousers
* 5,000 EXP

==Total Cost:==

* Red Apples
* Green Apples
* Cakes
* Xmas Cakes

[[Category:Skills]]

Development:Tilesets

2012-03-23T22:23:17Z

Jenalya: /* Needed tilesets */

{{Category_art}}
{{Status_green}}
== Getting started ==

To get started on tileset development, please look into what kind of areas we plan to add to the game or what kind of changes we would still want to make to existing maps. See for example [[Geography]] and [[concept art]]. Ideas of your own are welcome too!

== General specifications ==

* '''Tile size:''' 32x32
* '''Tileset size:''' Width: 512, Max height: 512 (for 1x1 sets)
* '''Color Depth:''' 24 or 32 (alpha layer optional, no magic colors)
* '''File Format:''' [http://www.libpng.org/pub/png/ PNG]
* '''Current tilesets:''' https://github.com/themanaworld/tmwa-client-data/tree/master/graphics/tiles

Please also note our [[Guidelines|style guidelines]].

== Guidelines ==
*Please keep in mind how maps are made (see [[Map development]]). The lowest layer is usually used for ground tiles/walls.

*Although we prefer high quality tiles over low quality ones, please keep in mind that we try to resemble the look of old SNES games. So please try not to make the tiles too realistic. Please don't use realistic textures, such as a photo of a wooden piece, and use it for your tiles. We strongly encourage you to '''manually pixelate every tile''' and '''avoid to use gradients or filters (such as blur)''' excessively.

*Regarding '''color choice''': Keep your color palette narrow. Don't use more shades per color than necessary. 3 shades of one color are usually enough for small objects. Even very large objects shouldn't use more than 5 or 7 shades. But how many shades you use is in the end left up to the artists discretion. Keep in mind that dithering is usually used for structure effects in TMW and rarely for blending one color into another. When a structure effect is not needed you shoud better add an additional shade instead of applying too much dithering just for color blending.
*Try to use the '''same color palette for the whole tileset'''. The selection of color is important for the feeling of the tileset. Cold colors with a low saturation are good for a sad and cold feeling for example while warm and saturated colors create a warm and cheerful atmosphere (but please don't overdo the saturation). Whatever atmosphere you choose, it should be consistent through the whole tileset. When you create new tiles for existing tilesets you should try to use only colors that are already used in the tileset. Otherwise your new tiles will stand out and look weird when next to the old tiles.

*'''Visible outlines''' are reserved for sprites. Please avoid them when creating map tiles.

*The '''light direction''' is south-west for outdoor tilesets. Imagine the light source to be over your left shoulder. Of course there can be exceptions to this rule. Different or special areas may have a different direction of light to give it a subtle different feeling, such as lava caves with subtle orange light from the bottom, and deep in the dark forest with glowing mushrooms. For indoor tilesets diffused light is nice, but overusage could lead into problems with contrast between the inside and the outside.

*'''Perspective:''' top-down 45Â° view angle (see the schematic to the right).[[Image:Perspective_Reference.png|right|384px]] SVG version: [http://lasdomogrod.pl/tmw/perspective-reference/TMW-PerspectiveReference.svg TMW-PerspectiveReference.svg]

*'''Proportions:''' A character is approximately one tile wide and two tiles high. Don't be afraid to copy a player character into your image from time to time to check the size relation.

*'''Drop shadows:''' Large objects on outdoor tilesets (like buildings, for example) should have drop shadows cast to the northeast. The shadows should be pure black with an opacity of 30%. The edges of the shadows should only have an opacity of 15%.

*'''Reuse:''' The tiles in one tileset should be able to be put together in as many different ways as possible to allow the mapper to express his creativity.

== Current projects ==
These are tilesets that are currently under development. The name of the developer in charge is in brackets. When you want to help you should contact them or just write into their threads in the [http://forums.themanaworld.org/viewforum.php?f=8 graphic development forum].
* Thermin indoor, outdoor and cave Tilesets (Merlin and others): http://forums.themanaworld.org/viewtopic.php?f=8&t=14228
* Graveyard and crypt tileset (various people): http://forums.themanaworld.org/viewtopic.php?f=4&t=3338&p=47287 http://forums.themanaworld.org/viewtopic.php?f=8&t=3724 https://trello.com/card/crypt-tilesets/4ea730ee9982b463f800497e/89

== Stalled projects ==
These are tilesets that have been started, but unfortunately the artists who started them haven't got the time to finish them. So we are searching for people who want to continue their work so that it isn't wasted.
*Ice Cave Tileset (data/graphics/tiles/icecave.png)
*Savannah Tileset (http://forums.themanaworld.org/viewtopic.php?t=1348)
*Desert Tileset ([[User:VxD|VxD]]) development thread : http://forums.themanaworld.org/viewtopic.php?t=1913

== Needed tilesets ==
These are tilesets that will be required in the near future.
* Barbarian village indoor and outdoor

== Other Tilesets ==
Beside these tilesets there is of course a lot of other stuff planned for the future. Refer to [[Geography]] for a list of regions that we have planned. And then there are a lot of different themed dungeons we could make. When you got an idea about a scenario you could make a tileset for you should post on the graphic design forum so we can refine the concept together.

Development:Tilesets

2012-03-23T22:21:52Z

Jenalya: /* Current projects */ Information updated to currently active projects

{{Category_art}}
{{Status_green}}
== Getting started ==

To get started on tileset development, please look into what kind of areas we plan to add to the game or what kind of changes we would still want to make to existing maps. See for example [[Geography]] and [[concept art]]. Ideas of your own are welcome too!

== General specifications ==

* '''Tile size:''' 32x32
* '''Tileset size:''' Width: 512, Max height: 512 (for 1x1 sets)
* '''Color Depth:''' 24 or 32 (alpha layer optional, no magic colors)
* '''File Format:''' [http://www.libpng.org/pub/png/ PNG]
* '''Current tilesets:''' https://github.com/themanaworld/tmwa-client-data/tree/master/graphics/tiles

Please also note our [[Guidelines|style guidelines]].

== Guidelines ==
*Please keep in mind how maps are made (see [[Map development]]). The lowest layer is usually used for ground tiles/walls.

*Although we prefer high quality tiles over low quality ones, please keep in mind that we try to resemble the look of old SNES games. So please try not to make the tiles too realistic. Please don't use realistic textures, such as a photo of a wooden piece, and use it for your tiles. We strongly encourage you to '''manually pixelate every tile''' and '''avoid to use gradients or filters (such as blur)''' excessively.

*Regarding '''color choice''': Keep your color palette narrow. Don't use more shades per color than necessary. 3 shades of one color are usually enough for small objects. Even very large objects shouldn't use more than 5 or 7 shades. But how many shades you use is in the end left up to the artists discretion. Keep in mind that dithering is usually used for structure effects in TMW and rarely for blending one color into another. When a structure effect is not needed you shoud better add an additional shade instead of applying too much dithering just for color blending.
*Try to use the '''same color palette for the whole tileset'''. The selection of color is important for the feeling of the tileset. Cold colors with a low saturation are good for a sad and cold feeling for example while warm and saturated colors create a warm and cheerful atmosphere (but please don't overdo the saturation). Whatever atmosphere you choose, it should be consistent through the whole tileset. When you create new tiles for existing tilesets you should try to use only colors that are already used in the tileset. Otherwise your new tiles will stand out and look weird when next to the old tiles.

*'''Visible outlines''' are reserved for sprites. Please avoid them when creating map tiles.

*The '''light direction''' is south-west for outdoor tilesets. Imagine the light source to be over your left shoulder. Of course there can be exceptions to this rule. Different or special areas may have a different direction of light to give it a subtle different feeling, such as lava caves with subtle orange light from the bottom, and deep in the dark forest with glowing mushrooms. For indoor tilesets diffused light is nice, but overusage could lead into problems with contrast between the inside and the outside.

*'''Perspective:''' top-down 45Â° view angle (see the schematic to the right).[[Image:Perspective_Reference.png|right|384px]] SVG version: [http://lasdomogrod.pl/tmw/perspective-reference/TMW-PerspectiveReference.svg TMW-PerspectiveReference.svg]

*'''Proportions:''' A character is approximately one tile wide and two tiles high. Don't be afraid to copy a player character into your image from time to time to check the size relation.

*'''Drop shadows:''' Large objects on outdoor tilesets (like buildings, for example) should have drop shadows cast to the northeast. The shadows should be pure black with an opacity of 30%. The edges of the shadows should only have an opacity of 15%.

*'''Reuse:''' The tiles in one tileset should be able to be put together in as many different ways as possible to allow the mapper to express his creativity.

== Current projects ==
These are tilesets that are currently under development. The name of the developer in charge is in brackets. When you want to help you should contact them or just write into their threads in the [http://forums.themanaworld.org/viewforum.php?f=8 graphic development forum].
* Thermin indoor, outdoor and cave Tilesets (Merlin and others): http://forums.themanaworld.org/viewtopic.php?f=8&t=14228
* Graveyard and crypt tileset (various people): http://forums.themanaworld.org/viewtopic.php?f=4&t=3338&p=47287 http://forums.themanaworld.org/viewtopic.php?f=8&t=3724 https://trello.com/card/crypt-tilesets/4ea730ee9982b463f800497e/89

== Stalled projects ==
These are tilesets that have been started, but unfortunately the artists who started them haven't got the time to finish them. So we are searching for people who want to continue their work so that it isn't wasted.
*Ice Cave Tileset (data/graphics/tiles/icecave.png)
*Savannah Tileset (http://forums.themanaworld.org/viewtopic.php?t=1348)
*Desert Tileset ([[User:VxD|VxD]]) development thread : http://forums.themanaworld.org/viewtopic.php?t=1913

== Needed tilesets ==
These are tilesets that will be required in the near future.
Right now, there are no tilesets required, but when there are, they will be posted here.

== Other Tilesets ==
Beside these tilesets there is of course a lot of other stuff planned for the future. Refer to [[Geography]] for a list of regions that we have planned. And then there are a lot of different themed dungeons we could make. When you got an idea about a scenario you could make a tileset for you should post on the graphic design forum so we can refine the concept together.

Development:Tilesets

2012-03-23T22:15:58Z

Jenalya: /* General specifications */ Update link to git repository

{{Category_art}}
{{Status_green}}
== Getting started ==

To get started on tileset development, please look into what kind of areas we plan to add to the game or what kind of changes we would still want to make to existing maps. See for example [[Geography]] and [[concept art]]. Ideas of your own are welcome too!

== General specifications ==

* '''Tile size:''' 32x32
* '''Tileset size:''' Width: 512, Max height: 512 (for 1x1 sets)
* '''Color Depth:''' 24 or 32 (alpha layer optional, no magic colors)
* '''File Format:''' [http://www.libpng.org/pub/png/ PNG]
* '''Current tilesets:''' https://github.com/themanaworld/tmwa-client-data/tree/master/graphics/tiles

Please also note our [[Guidelines|style guidelines]].

== Guidelines ==
*Please keep in mind how maps are made (see [[Map development]]). The lowest layer is usually used for ground tiles/walls.

*Although we prefer high quality tiles over low quality ones, please keep in mind that we try to resemble the look of old SNES games. So please try not to make the tiles too realistic. Please don't use realistic textures, such as a photo of a wooden piece, and use it for your tiles. We strongly encourage you to '''manually pixelate every tile''' and '''avoid to use gradients or filters (such as blur)''' excessively.

*Regarding '''color choice''': Keep your color palette narrow. Don't use more shades per color than necessary. 3 shades of one color are usually enough for small objects. Even very large objects shouldn't use more than 5 or 7 shades. But how many shades you use is in the end left up to the artists discretion. Keep in mind that dithering is usually used for structure effects in TMW and rarely for blending one color into another. When a structure effect is not needed you shoud better add an additional shade instead of applying too much dithering just for color blending.
*Try to use the '''same color palette for the whole tileset'''. The selection of color is important for the feeling of the tileset. Cold colors with a low saturation are good for a sad and cold feeling for example while warm and saturated colors create a warm and cheerful atmosphere (but please don't overdo the saturation). Whatever atmosphere you choose, it should be consistent through the whole tileset. When you create new tiles for existing tilesets you should try to use only colors that are already used in the tileset. Otherwise your new tiles will stand out and look weird when next to the old tiles.

*'''Visible outlines''' are reserved for sprites. Please avoid them when creating map tiles.

*The '''light direction''' is south-west for outdoor tilesets. Imagine the light source to be over your left shoulder. Of course there can be exceptions to this rule. Different or special areas may have a different direction of light to give it a subtle different feeling, such as lava caves with subtle orange light from the bottom, and deep in the dark forest with glowing mushrooms. For indoor tilesets diffused light is nice, but overusage could lead into problems with contrast between the inside and the outside.

*'''Perspective:''' top-down 45Â° view angle (see the schematic to the right).[[Image:Perspective_Reference.png|right|384px]] SVG version: [http://lasdomogrod.pl/tmw/perspective-reference/TMW-PerspectiveReference.svg TMW-PerspectiveReference.svg]

*'''Proportions:''' A character is approximately one tile wide and two tiles high. Don't be afraid to copy a player character into your image from time to time to check the size relation.

*'''Drop shadows:''' Large objects on outdoor tilesets (like buildings, for example) should have drop shadows cast to the northeast. The shadows should be pure black with an opacity of 30%. The edges of the shadows should only have an opacity of 15%.

*'''Reuse:''' The tiles in one tileset should be able to be put together in as many different ways as possible to allow the mapper to express his creativity.

== Current projects ==
These are tilesets that are currently under development. The name of the developer in charge is in brackets. When you want to help you should contact them or just write into their threads in the [http://forums.themanaworld.org/viewforum.php?f=8 graphic development forum].
*Castle Walls Tileset ([[User:Irukard|Irukard]]) : http://forums.themanaworld.org/viewtopic.php?t=2034
* Graveyard tileset (various people): http://forums.themanaworld.org/viewtopic.php?f=4&t=3338&p=47287 http://forums.themanaworld.org/viewtopic.php?f=8&t=3724

== Stalled projects ==
These are tilesets that have been started, but unfortunately the artists who started them haven't got the time to finish them. So we are searching for people who want to continue their work so that it isn't wasted.
*Ice Cave Tileset (data/graphics/tiles/icecave.png)
*Savannah Tileset (http://forums.themanaworld.org/viewtopic.php?t=1348)
*Desert Tileset ([[User:VxD|VxD]]) development thread : http://forums.themanaworld.org/viewtopic.php?t=1913

== Needed tilesets ==
These are tilesets that will be required in the near future.
Right now, there are no tilesets required, but when there are, they will be posted here.

== Other Tilesets ==
Beside these tilesets there is of course a lot of other stuff planned for the future. Refer to [[Geography]] for a list of regions that we have planned. And then there are a lot of different themed dungeons we could make. When you got an idea about a scenario you could make a tileset for you should post on the graphic design forum so we can refine the concept together.

Development:How to Develop

2012-02-16T20:30:25Z

Jenalya: Update the url for the content repository

=Set Up=
This is a how to help content development for official TMW-eA using Ubuntu and the Mana client. Other OS and clients may differ. Following this guide, you should be able to get development testing versions of the client data (tmwdata), server-data (eathena-data) and participate in development by using a localhost server. After getting these, you can both test current development and begin development in the direction you find most fitting.

==Dependencies==
In addition to the basic build tools (GCC, Make, headers, ...), Bison, and Flex are needed.

'''Debian derivates (including Ubuntu)'''
* Open a terminal.
* ''sudo apt-get install build-essential flex bison''

==Set Up Own Server==
'''Here are the steps to use when creating a new local testing server.'''
* Open a terminal.
* ''mkdir ~/tmw-ea''
* ''cd ~/tmw-ea/''
* ''git clone git://gitorious.org/tmw-eathena/mainline.git eathena''
* ''git clone --recursive git://github.com/themanaworld/tmwa-server-data.git eathena-data''
* ''cd eathena/''
* If you are running and older version of make: ''mkdir -p obj/{common,login,char,map,ladmin,tool}''. Debian, Ubuntu, Redhat, SuSE, Knoppix, and Cygwin in particular are famous for still not having Make 3.82, which is a much more compliant implementation. If you are technically inclined, I recommend installing it in /usr/local. -o11c
* ''make''
* ''sudo cp login-server char-server map-server ladmin /usr/local/bin/''
* ''git config --global url.git@gitorious.org:.pushInsteadOf git://gitorious.org'' {{ref|push}} {{ref|once}}
* ''cd ../eathena-data''
* Preferably, add the update hooks.
** ''ln -s ../../git/hooks/post-merge .git/hooks/''
** ''ln -s ../../../git/hooks/post-merge client-data/.git/hooks/''
* ''make conf''
* ''cd client-data''
* ''git checkout master''
* ''cd music''
* ''git checkout master''

'''You can now launch your test server.'''
* Open a terminal.
* ''cd ~/tmw-ea/eathena-data/''
* ''./char-server& ./login-server& ./map-server&''
* Open another terminal.
* ''mana --server localhost --port 6901 -u -d ~/tmw-ea/eathena-data/client-data''
This should run all three of your servers and the client.

'''Make yourself a GM so you can test changes made.'''
See [[#Administration]]

'''See also:''' [[GM Commands]]

'''You are now free to do some changes, first close the client and your servers.'''

'''''Notes for client data changes: 1) commit and push them in the client-data repo 2) commit and push "client-data" when it shows "(new commits)" in your server-data 3) commit and push other server data changes.'''''
* Make your modifications (e.g. Change a map) and save them.
* Open a terminal.
* ''cd ~/tmw-ea/eathena-data/client-data''
* ''git status''
* ''git add [modified files]''
* ''git commit''
* ''git push'' {{note|push}}
* ''cd ..''
* ''make maps'' (if you changed a map)
* ''git status''
* ''git add [modified files]''
* ''git add client-data'' (if ''git status'' shows ''(new commits)''. '''Don't do this if you don't have push access to client-data!''')
* ''git commit''
* ''git push'' {{note|push}}
* Close the terminal.

{{note|push}} : a step for those with commit access to the remote repositories. For others, you don't need to reconfigure your clone and please make a patch on steps where ''git push'' is suggested.

{{note|once}} : you only need to do this once, no matter how many times you independently clone the repositories.

*''git format-patch -M -C origin/master''
* pastebin the patch(es) and post for review at irc.themanaworld.org channel: #tmw-dev or on our [http://forums.themanaworld.org/viewforum.php?f=18 development forums]. '''Extensive patches must be posted on the forum as a series of well-formed patches with descriptive commit messages.''' In particular, later patches should not fix errors introduced in earlier patches, and each patch should form a logically independent part.

'''You can also pull the data which has been modified.'''
* Open a terminal.
* ''cd ~/tmw-ea/eathena-data''
* ''git pull''
* If you haven't installed the hook, ''git submodule update --merge'' at toplevel (for client-data) and in client-data (for music)
* Close the terminal.

'''See Also:''' [http://wiki.themanaworld.org/images/3/33/README.mv.txt README.mv.txt] - Documentation on using git submodules, like client-data and tmw-music.

== Administration ==
# Start the servers.
# Open a command line terminal.
# cd ~/tmw-ea/eathena-data/login
# ladmin (not ./ladmin)
# add username M password
# gm username 99

== Connecting ==
# Open a command line terminal.
# Run your client pointing to your client data and your local server. E.g. mana -u -d ~/tmw-ea/tmwdata --server localhost --port 6901

If all goes well, you are now ready to test new content and participate with development.

=Making Content=
==Making Map Content==
===Java Converter Tool===
This has been my experience on running the java Converter tools, which takes map data from client-data and applies it to the server-data. The README addresses dependencies for using this tool. It suggests there are other ways it can work in the README, if this method does work for you.

Edit your map and save it. You can push the client data now. Now, you need to run the converter.
# cd ~/tmw-ea/eathena-data/
# make maps
After that, commit and push the files that the converter edited.

==Getting Art Content Into The Game==
* Post [CPT] or [WIP] art on the [http://forums.themanaworld.org/viewforum.php?f=8 graphics development forum].
* Work with the Art Director and collaborators on getting the art consistent.
* When finished, edit topic as [FND].
* Art Director approves [FND] art and marks it [RC]. Should the art need animation or special effect, the Art Director requests xml for it. If not, the Art Director commits it and marks as [GIT].
* XML Team reviews or drafts xml related to the art, then commits the .png and .xml. Topic can be marked as [GIT].
::* Art content affected: client-data/graphics/sprites then related directory for .png and .xml animation addition.
* Project developer requests database entry reservations from a General Content Team developer.
::* Map entry server data affected: resnametable.txt and .wlk files in the data directory, map content files in the npc directory.
::* Map entry client data affected: .tmx files in the maps directory.
::* Map entry requires the running of the .tmx converter (aka java converter) before commits can be made.
::* Art content server data affected: entry made in the item_db.txt, mob_db.txt or mob_skills_db.txt in the db directory.
::* Art content client data affected: entry added in items.xml, monsters.xml or other identification file.

===Handling General Content Team [REQ]s===
* General Content Team member adds a [REQ] topic to the graphics development forum.
* General Content Team member adds the [REQ] topic as a hyperlink under "Required Art" on the [[Art in Development]] page.
* Art Director attempts to network with other artists to assign the art to an artist.

==Bit Masking==
Bit Masking helps us reduce our variable count while offering a dynamic method of script writing that is versatile and flexible to both linear and non-linear script writing.

[http://dl.dropbox.com/u/6520164/tester1.txt Bit Masking Test Script]

=Using the Test Server=
*[[Testing Server]]
=Using The Mana World Workshop=
*[http://locke.suu.edu/~adams/mana/workshop/manual/ The Mana World Workshop Manual]

=Trouble Shooting=
see [http://wiki.themanaworld.org/index.php/Setting_up_eAthena_on_Linux#Troubleshooting for Linux Troubleshooting]

Item Reference/Miscellaneous

2012-01-15T10:18:05Z

Jenalya: The Hitchhiker's Towels are still obtainable.

{{Category playerinfo}}

{{Template:Item Reference Page}}

The items are sorted first by price, then by ID.

==Other==
{| border="1" cellspacing="0" cellpadding="2" width="100%" align="center"
! style="background:#efdead;" | Image
! style="background:#efdead;" | Name (ID)
! style="background:#efdead;" | BUY/Sell
! style="background:#efdead;" | Weight
! style="background:#efdead;" width="350px" | Description
! style="background:#efdead;" | Rarity
|-
| align="center" height="65px" width="65px" | [[Image:Generic-mopoxcurepotion.png]]
| Mopox Cure Potion (746)
| align="right" | 0 GP 0 gp
| align="center" | 5
| A gooey brew with a vile smell, supposedly able to cure Mopox.
| Unreleased
|-
| align="center" height="65px" width="65px" | [[Image:Generic-bluehint.png]]
| Aqua Hint (551)
| align="right" | 20 GP 0 gp
| align="center" | 10
| A hint.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Generic-magentahint.png]]
| Magenta Hint (552)
| align="right" | 20 GP 0 gp
| align="center" | 10
| A hint.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Generic-yellowhint.png]]
| Yellow Hint (553)
| align="right" | 20 GP 0 gp
| align="center" | 10
| A hint.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Generic-greenhint.png]]
| Green Hint (554)
| align="right" | 20 GP 0 gp
| align="center" | 10
| A hint.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Generic-tealhint.png]]
| Teal Hint (555)
| align="right" | 20 GP 0 gp
| align="center" | 10
| A hint.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Generic-purplehint.png]]
| Purple Hint (556)
| align="right" | 20 GP 0 gp
| align="center" | 10
| A hint.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Generic-redhint.png]]
| Red Hint (557)
| align="right" | 20 GP 0 gp
| align="center" | 10
| A hint.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Generic-otherbluehint.png]]
| Blue Hint (558)
| align="right" | 20 GP 0 gp
| align="center" | 10
| A hint.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Generic-orangehint.png]]
| Orange Hint (559)
| align="right" | 20 GP 0 gp
| align="center" | 10
| A hint.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Generic-greyhint.png]]
| Grey Hint (560)
| align="right" | 20 GP 0 gp
| align="center" | 10
| A hint.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:generic-iten.png]]
| Iten (727)
| align="right" | 0 GP 0 gp
| align="center" | 8000
| An iten.
| [[Tulimshar Quests|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:generic-warped-log.png]]
| Warped Log (729)
| align="right" | 0 GP 0 gp
| align="center" | 8
| A piece of wood, warped and twisted by some unnatural force.
| Spellable
|-
| align="center" height="65px" width="65px" | [[Image:Generic-lifestone.png]]
| [[Lifestone]] (730)
| align="right" | 0 GP 0 gp
| align="center" | 5
| A small crystal shard, warm to the touch.
| Spellable, [[Aidan And Ishi's Monster Points|Ishi]]
|-
| align="center" height="65px" width="65px" | [[Image:Use-potion-purificationpotion.png]]
| Purification Potion (733)
| align="right" | 0 GP 0 gp
| align="center" | 15
| A transparent, odorless liquid that feels strangely lighter than water.
| [[Magic Quests|Magic Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Mauve-herb.png]]
| Mauve Herb (680)
| align="right" | 2 GP 1 gp
| align="center" | 1
| An ingredient for brewing healing potions.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Cobalt-herb.png]]
| Cobalt Herb (681)
| align="right" | 2 GP 1 gp
| align="center" | 1
| An ingredient for brewing healing potions.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Gamboge-herb.png]]
| Gamboge Herb (682)
| align="right" | 2 GP 1 gp
| align="center" | 1
| An ingredient for brewing healing potions.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Alizarin-herb.png]]
| Alizarin Herb (683)
| align="right" | 2 GP 1 gp
| align="center" | 1
| An ingredient for brewing healing potions.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:generic-mouboo-figurine.png]]
| Mouboo Figurine (728)
| align="right" | 0 GP 1 gp
| align="center" | 9
| A small, wooden figurine of a mouboo.
| Spellable
|-
| align="center" height="65px" width="65px" | [[Image:generic-broken-four-leaf-amulet.png]]
| Broken Four-Leaf Amulet (833)
| align="right" | 100 GP 1 gp
| align="center" | 10
| A broken four-leaf clover amulet.
| Unreleased
|-
| align="center" height="65px" width="65px" | [[Image:generic-jacko-soul.png]]
| Jack O Soul (1198)
| align="right" | 0 GP 1 gp
| align="center" | 1
| The soul of a Jack O.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:generic-pumpkinseed.png]]
| Pumpkin Seeds (3011)
| align="right" | 5 GP 1 gp
| align="center" | 1
| The seeds from a seasonal pumpkin vine.
| Unobtainable
|-
| align="center" height="65px" width="65px" | [[Image:generic-dry-branch.png]]
| Druid Tree Branch (732)
| align="right" | 0 GP 2 gp
| align="center" | 2
| A branch cut off from the druid tree. It feels strangely leathery to the touch.
| [[Magic Quests|Magic Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Generic-cocoon-silk.png]]
| Silk Cocoon (718)
| align="right" | 200 GP 3 gp
| align="center" | 1
| A silkworm's cocoon.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-maggotslime.png]]
| Maggot Slime (505)
| align="right" | 8 GP 4 gp
| align="center" | 1
| Slimy maggot slime.
| Frequent drop, [[Aidan And Ishi's Monster Points|Ishi]]
|-
| align="center" height="65px" width="65px" | [[Image:Generic-whitefur.png]]
| White Fur (611)
| align="right" | 8 GP 4 gp
| align="center" | 8
| A patch of white, fluffy fur.
| Frequent drop, [[Aidan And Ishi's Monster Points|Ishi]]
|-
| align="center" height="65px" width="65px" | [[Image:Generic-pinkantennae.png]]
| Pink Antenna (614)
| align="right" | 10 GP 5 gp
| align="center" | 10
| No-one knows why violets got these antennaes.
| Frequent drop, [[Aidan And Ishi's Monster Points|Ishi]]
|-
| align="center" height="65px" width="65px" | [[Image:Generic-doll.png]]
| Broken Doll (834)
| align="right" | 20 GP 5 gp
| align="center" | 15
| An ancient doll taken from a fallen Fey Element that used it as a lure for its young victims.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-redpowder.png]]
| Red Powder (4017)
| align="right" | 3,000 GP 5 gp
| align="center" | 10
| A pile of magical red powder.
| [[Orum Quest|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Generic-yellowpowder.png]]
| Yellow Powder (4018)
| align="right" | 3,000 GP 5 gp
| align="center" | 10
| A pile of magical yellow powder.
| [[Orum Quest|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Generic-bluepowder.png]]
| Blue Powder (4019)
| align="right" | 3,000 GP 5 gp
| align="center" | 10
| A pile of magical blue powder.
| [[Orum Quest|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Generic-casinocoins.png]]
| Casino Coins (503)
| align="right" | 20 GP 10 gp
| align="center" | 1
| Just some casino coins.
| Frequent drop, [[Aidan And Ishi's Monster Points|Ishi]]
|-
| align="center" height="65px" width="65px" | [[Image:Generic-greenpresentbox.png]]
| Green Present Box (538)
| align="right" | 20 GP 10 gp
| align="center" | 10
| Something mysterious inside.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-emptybottle.png]]
| Empty Bottle (540)
| align="right" | 20 GP 10 gp
| align="center" | 1
| An empty bottle.
| Rare drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-rawlog2.png]]
| Raw Log (569)
| align="right" | 20 GP 10 gp
| align="center" | 10
| A raw log.
| Frequent drop, [[Aidan And Ishi's Monster Points|Ishi]]
|-
| align="center" height="65px" width="65px" | [[Image:Use-food-decorcandy.png]]
| Decor Candy (504)
| align="right" | 25 GP 10 gp
| align="center" | 1
| A leftover decor candy from last Christmas.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-batwing.png]]
| Bat Wing (753)
| align="right" | 500 GP 10 gp
| align="center" | 3
| The wing from a bat.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-reedbundle.png]]
| Reed Bundles (806)
| align="right" | 20 GP 10 gp
| align="center" | 7
| A bundle of reed.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-grassseeds.png]]
| Grass Seeds (807)
| align="right" | 20 GP 10 gp
| align="center" | 10
| Some grass seeds.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-yellowpresentbox.png]]
| Yellow Present Box (4021)
| align="right" | 20 GP 10 gp
| align="center" | 10
| Something mysterious inside?
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-whitepresentbox.png]]
| White Present Box (4022)
| align="right" | 20 GP 10 gp
| align="center" | 10
| Something very mysterious inside.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-Grimaceofdementia.png]]
| [[Dementia Potion|Grimace of Dementia]] (4029)
| align="right" | 20 GP 10 gp
| align="center" | 10
| A feared potion. If done wrong... what did you say?
| [[Dementia Potion|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Generic-hardspike.png]]
| Hard Spike (613)
| align="right" | 40 GP 10 gp
| align="center" | 10
| The hard spike of a slain monster.
| Buyable, Frequent drop, [[Aidan And Ishi's Monster Points|Ishi]]
|-
| align="center" height="65px" width="65px" | [[Image:Generic-grub-slime.png]]
| Grub Slime (836)
| align="right" | 40 GP 10 gp
| align="center" | 2
| The orifice secretions of a grub.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-batteeth.png]]
| Bat Teeth (754)
| align="right" | 600 GP 12 gp
| align="center" | 2
| The teeth from a bat. Rather sharp.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-ear-zombie.png]]
| Undead Ear (779)
| align="right" | 30 GP 15 gp
| align="center" | 5
| An ear from a zombie.
| Rare drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-eyeball.png]]
| Undead Eye (780)
| align="right" | 30 GP 15 gp
| align="center" | 3
| An eye from a zombie.
| Rare drop
|-
| align="center" height="65px" width="65px" | [[Image:generic-newstinger.png]]
| Scorpion Stinger (507)
| align="right" | 50 GP 25 gp
| align="center" | 1
| A poisoned scorpion stinger.
| Frequent drop, [[Aidan And Ishi's Monster Points|Ishi]]
|-
| align="center" height="65px" width="65px" | [[Image:Generic-purplepresentbox.png]]
| Purple Present Box (515)
| align="right" | 50 GP 25 gp
| align="center" | 10
| Something mysterious inside.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-sulphurpowder.png]]
| Sulphur Powder (703)
| align="right" | 1,000 GP 25 gp
| align="center" | 2
| A small pile of sulphur.
| Frequent drop, Spellable, [[Rauk The Alchemist|Craftable]]
|-
| align="center" height="65px" width="65px" | [[Image:Generic-hyvern-stinger.png]]
| Hyvern Stinger (835)
| align="right" | 100 GP 25 gp
| align="center" | 10
| A stinger snapped off the end of a Hyvern's abdomen.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-squirrelpelt.png]]
| Squirrel Pelt (860)
| align="right" | 50 GP 25 gp
| align="center" | 20
| The pelt of a squirrel. Trophy of the less experienced hunters, can be used to create clothes.
| Unreleased
|-
| align="center" height="65px" width="65px" | [[Image:Generic-angryscorpionstinger.png]]
| Angry Scorpion Stinger (4000)
| align="right" | 50 GP 25 gp
| align="center" | 1
| An angry scorpion stinger.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-animal-bones.png]]
| Animal Bones (4023)
| align="right" | 50 GP 25 gp
| align="center" | 10
| Bones from an animal.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-bugleg.png]]
| Bug Leg (518)
| align="right" | 100 GP 25 gp
| align="center" | 1
| A bug's leg. Mostly used for alchemy.
| Buyable, Frequent drop, [[Aidan And Ishi's Monster Points|Ishi]]
|-
| align="center" height="65px" width="65px" | [[Image:Generic-bluepresentbox.png]]
| Blue Present Box (516)
| align="right" | 60 GP 30 gp
| align="center" | 10
| Something mysterious inside.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-normal-snaketongue.png]]
| Snake Tongue (710)
| align="right" | 60 GP 30 gp
| align="center" | 1
| The forked tongue of a snake.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-bottleofsand.png]]
| Bottle of Sand (542)
| align="right" | 70 GP 35 gp
| align="center" | 10
| A bottle with sand in it.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:Generic-cavesnakelamp.png]]
| Cave Snake Lamp (612)
| align="right" | 80 GP 40 gp
| align="center" | 10
| Feeler of a lamp snake that glows in the dark.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-mountain-snaketongue.png]]
| Mountain Snake Tongue (711)
| align="right" | 80 GP 40 gp
| align="center" | 1
| The forked tongue of a mountain snake.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-coinbag.png]]
| Coin Bag (526)
| align="right" | 1000 GP 500 gp
| align="center" | 5
| A bag used to transport coins in it. If you own it you can take more coins with you.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-treasurekey.png]]
| [[Treasure Key]] (537)
| align="right" | 100 GP 50 gp
| align="center" | 2
| A rusty key.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-rags-rotten.png]]
| Rotten Rags (777)
| align="right" | 100 GP 50 gp
| align="center" | 15
| Rotten rags from an undead creature.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-wolvern-tooth.png]]
| Wolvern Tooth (858)
| align="right" | 100 GP 50 gp
| align="center" | 1
| A tooth from a wolvern.
| Unreleased
|-
| align="center" height="65px" width="65px" | [[Image:Generic-bandit-hood.png]]
| Bandit Hood (4016)
| align="right" | 100 GP 50 gp
| align="center" | 50
| A bandit hood crawling with lice.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-cave-snaketongue.png]]
| Cave Snake Tongue (713)
| align="right" | 120 GP 60 gp
| align="center" | 1
| The forked tongue of a cave snake.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-bone.png]]
| Bone (775)
| align="right" | 140 GP 70 gp
| align="center" | 10
| A bone.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-yeticlaw.png]]
| Yeti Claw (4025)
| align="right" | 150 GP 75 gp
| align="center" | 1
| A claw broken off from a yeti.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-ironpowder.png]]
| [[Iron Powder]] (704)
| align="right" | 800 GP 80 gp
| align="center" | 3
| A pile of powdered iron.
| Spellable, [[Rauk The Alchemist|Craftable]]
|-
| align="center" height="65px" width="65px" | [[Image:Generic-grass-snaketongue.png]]
| Grass Snake Tongue (712)
| align="right" | 160 GP 80 gp
| align="center" | 1
| The forked tongue of a grass snake.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-redscorpionstinger.png]]
| Red Scorpion Stinger (517)
| align="right" | 170 GP 85 gp
| align="center" | 1
| A highly poisoned red scorpion stinger.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-heart-diseased.png]]
| Diseased Heart (778)
| align="right" | 180 GP 90 gp
| align="center" | 10
| A diseased heart. Likely from a zombie.
| Rare drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-ironore.png]]
| [[Iron Ore]] (640)
| align="right" | 250 GP 100 gp
| align="center" | 40
| A lump of iron ore.
| Frequent drop, [[Aidan And Ishi's Monster Points|Ishi]]
|-
| align="center" height="65px" width="65px" | [[Image:Generic-snakeskin.png]]
| Snake Skin (641)
| align="right" | 250 GP 100 gp
| align="center" | 15
| The skin of a slain snake.
| Frequent drop, [[Aidan And Ishi's Monster Points|Ishi]]
|-
| align="center" height="65px" width="65px" | [[Image:cotton-cloth.png]]
| Cotton Cloth (660)
| align="right" | 400 GP 100 gp
| align="center" | 10
| A piece of cotton cloth.
| Frequent drop, [[Aidan And Ishi's Monster Points|Ishi]]
|-
| align="center" height="65px" width="65px" | [[Image:pile-of-ash.png]]
| Pile Of Ash (701)
| align="right" | 3,000 GP 100 gp
| align="center" | 5
| A pile of ash similar to volcanic ash.
| Frequent drop, [[Aidan And Ishi's Monster Points|Ishi]]
|-
| align="center" height="65px" width="65px" | [[Image:Generic-blackscorpionstinger.png]]
| Black Scorpion Stinger (709)
| align="right" | 250 GP 100 gp
| align="center" | 1
| A black scorpion stinger, dripping with poison.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:generic-coal.png]]
| [[Coal]] (4001)
| align="right" | 250 GP 100 gp
| align="center" | 20
| A lump of coal.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:generic-ice-cube.png]]
| Ice Cube (4026)
| align="right" | 200 GP 100 gp
| align="center" | 1
| Very cold ice cube that never seems to completely melt.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:generic-jackolantern.png]]
| Jack-o-Lantern (3000)
| align="right" | 200 GP 100 gp
| align="center" | 1000
| A pumpkin that has been carved into a super-scary face for Hallowe'en.
| Rare drop
|-
| align="center" height="65px" width="65px" | [[Image:generic-rubberbat.png]]
| Rubber Bat (3001)
| align="right" | 200 GP 100 gp
| align="center" | 30
| Squeaks when you squeeze it.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:generic-realisticbrain.png]]
| Realistic Brain (3002)
| align="right" | 200 GP 100 gp
| align="center" | 50
| This brain sure is realistic.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:generic-jarofblood.png]]
| Jar Of Blood (3003)
| align="right" | 200 GP 100 gp
| align="center" | 375
| Just the thing to scare the kids at Hallowe'en.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-patch-leather.png]]
| Leather Patch (708)
| align="right" | 300 GP 150 gp
| align="center" | 18
| A patch of tanned leather.
| [[Pachua the Hermit Indian|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Generic-root.png]]
| Root (740)
| align="right" | 500 GP 200 gp
| align="center" | 5
| A root from a plant.
| Buyable, Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-terraniteore.png]]
| Terranite Ore (763)
| align="right" | 500 GP 250 gp
| align="center" | 40
| Some ore collected out of terranite.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-darkcrystal.png]]
| Dark Crystal (631)
| align="right" | 1,000 GP 250 gp
| align="center" | 10
| A dark crystal that emits a demonic aura.
| Buyable, Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Generic-wolvernpelt.png]]
| Wolvern Pelt (859)
| align="right" | 500 GP 205 gp
| align="center" | 50
| The pelt of a wolvern. Can be used to make clothes, blankets, or tents.
| Unreleased
|-
| align="center" height="65px" width="65px" | [[Image:lightcrystal.png]]
| Light Crystal (1228)
| align="right" | 1,000 GP 250 gp
| align="center" | 10
| A light crystal that emits an angelic aura.
| Unreleased
|-
| align="center" height="65px" width="65px" | [[Image:Generic-ingot.png]]
| [[Iron Ingots|Iron Ingot]] (4015)
| align="right" | 500 GP 250 gp
| align="center" | 200
| An ingot of iron.
| [[Iron Ingots|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Generic-frozen-yeti-tear.png]]
| Frozen Yeti Tear (4024)
| align="right" | 500 GP 250 gp
| align="center" | 1
| A tear from a yeti, frozen.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:Use-potion-manapotion.png]]
| [[Mana Potion]] (705)
| align="right" | 2,000 GP 300 gp
| align="center" | 50
| A dark, sirupy brew, with a smell reminiscent of manaberries.
| [[Magic Quests|Magic Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:wisppowder.png]]
| Wisp Powder (772)
| align="right" | 700 GP 350 gp
| align="center" | 3
| Powder froma wisp.
| Buyable, Frequent drop, [[Aidan And Ishi's Monster Points|Ishi]]
|-
| align="center" height="65px" width="65px" | [[Image:spectrepowder.png]]
| Spectre Powder (773)
| align="right" | 700 GP 350 gp
| align="center" | 3
| Powder from a spectre.
| Buyable, Frequent drop, [[Aidan And Ishi's Monster Points|Ishi]]
|-
| align="center" height="65px" width="65px" | [[Image:poltergeistpowder.png]]
| Poltergeist Powder (774)
| align="right" | 700 GP 350 gp
| align="center" | 3
| Powder from a portergeist.
| Buyable, Frequent drop, [[Aidan And Ishi's Monster Points|Ishi]]
|-
| align="center" height="65px" width="65px" | [[Image:Generic-skull.png]]
| Skull (776)
| align="right" | 900 GP 450 gp
| align="center" | 30
| A skull.
| Frequent drop
|-
| align="center" height="65px" width="65px" | [[Image:hitch-towel.png]]
| Hitchhiker's Towel (808)
| align="right" | 1,000 GP 500 gp
| align="center" | 30
| An inconspicuous towel. [[The Lost Hitchhiker|Dyable]]
| [[The Lost Hitchhiker|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:hitch-whitetowel.png]]
| White Hitchhiker's Towel (809) Warp: Nivalis (020-1 66,91)
| align="right" | 1,000 GP 500 gp
| align="center" | 30
| An inconspicuous white towel.
| [[The Lost Hitchhiker|Quest]], [[The Lost Hitchhiker|Colored]]
|-
| align="center" height="65px" width="65px" | [[Image:hitch-redtowel.png]]
| Red Hitchhiker's Towel (810) Warp: Hurnscald (009-1 51,40)
| align="right" | 1,000 GP 500 gp
| align="center" | 30
| An inconspicuous red towel.
| [[The Lost Hitchhiker|Quest]], [[The Lost Hitchhiker|Colored]]
|-
| align="center" height="65px" width="65px" | [[Image:hitch-greentowel.png]]
| Green Hitchhiker's Towel (811)
| align="right" | 1,000 GP 500 gp
| align="center" | 30
| An inconspicuous green towel.
| Unreleased
|-
| align="center" height="65px" width="65px" | [[Image:hitch-bluetowel.png]]
| Blue Hitchhiker's Towel (812)
| align="right" | 1,000 GP 500 gp
| align="center" | 30
| An inconspicuous blue towel.
| Unreleased
|-
| align="center" height="65px" width="65px" | [[Image:hitch-yellowtowel.png]]
| Yellow Hitchhiker's Towel (813) Warp: Tulimshar (003-1 40,71)
| align="right" | 1,000 GP 500 gp
| align="center" | 30
| An inconspicuous yellow towel.
| [[The Lost Hitchhiker|Quest]], [[The Lost Hitchhiker|Colored]]
|-
| align="center" height="65px" width="65px" | [[Image:hitch-purpletowel.png]]
| Purple Hitchhiker's Towel (814)
| align="right" | 1,000 GP 500 gp
| align="center" | 30
| An inconspicuous purple towel.
| Unreleased
|-
| align="center" height="65px" width="65px" | [[Image:hitch-orangetowel.png]]
| Orange Hitchhiker's Towel (815) Warp: Graveyard (027-1 70,100)
| align="right" | 1,000 GP 500 gp
| align="center" | 30
| An inconspicuous Orange towel.
| [[The Lost Hitchhiker|Quest]], [[The Lost Hitchhiker|Colored]]
|-
| align="center" height="65px" width="65px" | [[Image:hitch-pinktowel.png]]
| Pink Hitchhiker's Towel (816) Warp: Terranite Cave (012-3 448,66)
| align="right" | 1,000 GP 500 gp
| align="center" | 30
| An inconspicuous pink towel.
| [[The Lost Hitchhiker|Quest]], [[The Lost Hitchhiker|Colored]]
|-
| align="center" height="65px" width="65px" | [[Image:hitch-tealtowel.png]]
| Teal Hitchhiker's Towel (817)
| align="right" | 1,000 GP 500 gp
| align="center" | 30
| An inconspicuous teal towel.
| Unreleased
|-
| align="center" height="65px" width="65px" | [[Image:hitch-limetowel.png]]
| Lime Hitchhiker's Towel (818)
| align="right" | 1,000 GP 500 gp
| align="center" | 30
| An inconspicuous lime towel.
| Unreleased
|-
| align="center" height="65px" width="65px" | [[Image:diamondpowder.png]]
| Diamond Powder (819)
| align="right" | 1,000 GP 500 gp
| align="center" | 5
| A white powder made out of a diamond.
| [[The Lost Hitchhiker|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:rubypowder.png]]
| Ruby Powder (820)
| align="right" | 1,000 GP 500 gp
| align="center" | 5
| A red powder made out of a ruby.
| [[The Lost Hitchhiker|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:emeraldpowder.png]]
| Emerald Powder (821)
| align="right" | 1,000 GP 500 gp
| align="center" | 5
| A green powder made out of an emerald.
| [[The Lost Hitchhiker|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:sapphirepowder.png]]
| Sapphire Powder (822)
| align="right" | 1,000 GP 500 gp
| align="center" | 5
| A blue powder made out of a sapphire.
| [[The Lost Hitchhiker|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:topazpowder.png]]
| Topaz Powder (823)
| align="right" | 1,000 GP 500 gp
| align="center" | 5
| A yellow powder made out of a topaz.
| [[The Lost Hitchhiker|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:amethystpowder.png]]
| Amethyst Powder (824)
| align="right" | 1,000 GP 500 gp
| align="center" | 5
| A purple powder made out of an amethyst.
| [[The Lost Hitchhiker|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Generic-goldenscorpionstinger.png]]
| Golden Scorpion Stinger (706)
| align="right" | 2,000 GP 500 gp
| align="center" | 2
| A golden scorpion stinger, tipped with lethal poison.
| [[Setzer Quest|Quest]]

|-
| align="center" height="65px" width="65px" | [[Image:Use-potion-monsteroilpotion.png]]
| Monster Oil Potion (707)
| align="right" | 10,000 GP 2,000 gp
| align="center" | 50
| A dark, oily liquid with a sinister stench.
| [[Setzer Quest|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:Diamond.png]]
| Diamond (4002)
| align="right" | 5,000 GP 2,500 gp
| align="center" | 20
| A raw diamond gemstone.
| Rare drop
|-
| align="center" height="65px" width="65px" | [[Image:Ruby.png]]
| Ruby (4003)
| align="right" | 5,000 GP 2,500 gp
| align="center" | 20
| A raw ruby gemstone.
| Rare drop
|-
| align="center" height="65px" width="65px" | [[Image:Emerald.png]]
| Emerald (4004)
| align="right" | 5,000 GP 2,500 gp
| align="center" | 20
| A raw emerald gemstone.
| Rare drop
|-
| align="center" height="65px" width="65px" | [[Image:Sapphire.png]]
| Sapphire (4005)
| align="right" | 5,000 GP 2,500 gp
| align="center" | 20
| A raw sapphire gemstone.
| Rare drop
|-
| align="center" height="65px" width="65px" | [[Image:Topaz.png]]
| Topaz (4006)
| align="right" | 5,000 GP 2,500 gp
| align="center" | 20
| A raw toapaz gemstone.
| Rare drop
|-
| align="center" height="65px" width="65px" | [[Image:Amethyst.png]]
| Amethyst (4007)
| align="right" | 5,000 GP 2,500 gp
| align="center" | 20
| A raw amethyst gemstone.
| Rare drop
|-
| align="center" height="65px" width="65px" | [[Image:Pearl.png]]
| Pearl (700)
| align="right" | 5,000 GP 3,000 gp
| align="center" | 5
| A pearl, round and shiny.
| Rare drop
|-
| align="center" height="65px" width="65px" | [[Image:mylarin-dust.png]]
| Mylarin Dust (799)
| align="right" | 10,000 GP 5,000 gp
| align="center" | 3
| A bottle of mylarin particles.
| [[Love Triangle Quest|Quest]]
|-
| align="center" height="65px" width="65px" | [[Image:generic-smallclay.png]]
| Small Piece Of Clay (1222)
| align="right" | ? GP ? gp
| align="center" | 5
| A small piece of clay, used to make different shapes.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:generic-bigclay.png]]
| Big Piece Of Clay (1223)
| align="right" | ? GP ? gp
| align="center" | 10
| A big piece of white clay, used to make bigger shapes.
| No longer obtainable
|-
| align="center" height="65px" width="65px" | [[Image:generic-paperscroll.png]]
| Scroll Of Paper (1224)
| align="right" | ? GP ? gp
| align="center" | 1
| A scroll made of fine paper.
| Unreleased
|-
| align="center" height="65px" width="65px" | [[Image:generic-firescroll.png]]
| Fire Scroll (1225)
| align="right" | ? GP ? gp
| align="center" | 1
| A scroll on which is written an ancient formula giving birth to fire.
| Unreleased
|-
| align="center" height="65px" width="65px" | [[Image:generic-silverbell.png]]
| Silver Bell (1226)
| align="right" | ? GP ? gp
| align="center" | 25
| A tiny bell made of silver.
| Unreleased
|}

'''[[Item Reference|< Item Reference]]'''

Development:Testing Server

2012-01-05T11:28:44Z

Jenalya: /* GM Abilities */

Before developers release game content onto the official server, they'd like feedback from other developers and playtesters. This testing server regularly restarts for content fixes and tweaks.

===IRC===
Those interested in content testing should come to irc.themanaworld.org channel: #tmw-dev.

===Gitorious===
Keep track of our testing phase by following us on gitorious.org: [https://gitorious.org/+tmw-admins/tmw/tmwa-server-test Server-data], [https://gitorious.org/+tmw-admins/tmw/tmwa-client-test client-data].

===Forums===
Before content is tested and/or while it is being tested, content is often discussed on the [http://forums.themanaworld.org/viewforum.php?f=18 tmwAthena development forums].

===Client===
Those interested in playtesting need to get a client, which can be found on our [http://themanaworld.org/downloads.php downloads] page.

===GM Abilities===
There are several levels of GM ability, depending on the person's role on the development team.
Note that the primary purpose of this server is to allow developers and testers to test new and unfinished content. To keep it open to the public, we've restricted access to certain GM commands which have been abused to interfere with testing.

;Everyone: To get access to this commands type "@gm gm" in normal chat.
*@warp to map locations
*@item and @zeny to make items for your character
*@heal, @alive, @die
*@hide to avoid being attacked by monsters
Use the Debug NPCs in each town to set levels and skills

;Official Testers
*all the above plus
*@spawn monsters to fight
*@broadcast announcements to others on the server
*@pvpon/pvpoff on maps
*@killmonster
*@blvl and @jlvl to change level

;Official Content Developers
*access to almost all GM commands

===Location===
Our server is located at caliban.homeip.net port 6901.

===See Also===
* [[How to Develop]]
* [[Projects and Teams]]

Development:Projects and Teams

2011-08-31T17:34:09Z

Jenalya: /* Projects */

==<div class="center">'''Projects'''</div>==

Here is a list of the current projects under development.
{| border="1" cellspacing="0" cellpadding="5"
! style="background:#efdead;" | Project
! style="background:#efdead;" | Team
! style="background:#efdead;" | Description
! style="background:#efdead;" | Monster Reservations
! style="background:#efdead;" | Item Reservations
! style="background:#efdead;" | Map Reservations
! style="background:#efdead;" | New NPCs
|-
| '''Alpha Server'''
| Frost, Jenalya, alastrim, Wombat
| First line of defense against bugs. Pulls from the server-test repository.
|
|
|
| Watch out for debugging NPCs on the Alpha server, they can help with testing.
|-
| '''Hide and Seek'''
| Ali-G, Dark_Mage
| A labyrinth adventure to get the Four Leaf Clover to the enchanted silver pool.
| elemental boss monster (shadow?)
| Four Leaf Clover Necklace
| 024-3 to 024-8
|
|-
| '''Barbarian Hunting Grounds'''
| Jenalya, alastrim, o11c
| Barbarians hunt large game as a way of life.
| Hungry Fluffy, Wolf monster
| Yeti Skin Shirt
| 033 & 034
| Barbarian NPCs
|-
| '''Thermin'''
| Lien, Jenalya, Ali-G, alastrim
| Kaizei area town. Once a large town that mined the firerock stones beneath the town, it was devastated by a poison gas leak. During the crisis to survive, they collaborated on several new technologies to both defend the town from the rampaging Yeti surrounding the town and to find ways to get back to using the mine, despite the poison gas problem.
|
| GasMask, Monocle
|
| Gasmask steam punk NPC, clockwork armor NPC, barbarian NPCs, [http://forums.themanaworld.org/viewtopic.php?f=8&t=12839 generic pose NPCs]
|-
| '''Thermin Poisonous Mine'''
| Ali-G, Dark_Mage,
| Poison gas mine. A constant moving adventure with puzzles and traps to solve and disarm along the way. Suggestions: Barriers of some type, puzzle mini-games (input code words chosen at random, arrange items, push buttons in a certain order, kill a certain monster on the map), a poison map flag, the use of event monster scripting instead of _mobs.txt spawning.
| Ice Skull, Purple Slime, Acid Goblin, Longjohn, Serqet, Fire Lizard
| Firerock, Savior Chest Armor, Savior Leg Armor, Overlord Helmet, Paladin Helmet, 1,000 bone arrows
| 043
|
|-
| '''Crypt'''
| Nmaligec, Argul
| Reaper boss quest
| Reaper, scythe, the lost, ball lightning, vampire bat
| Death's Hand, Reaper blade
|
|
|-
| '''Lumber Camp'''
| Poison Ivy, O11c
| Southern Argaes expansion. Quests include: Help the Lumberjacks/Save the Dell (a choice); the Naturalist's Studies; ?
|
|
| 035-039
|
|-
| '''Kageville'''
| Kage
| TBA
|
|
| 040
|
|}

==<div class="center">'''Teams'''</div>==

{| border="1" cellspacing="0" cellpadding="5"
! style="background:#efdead;" | Name
! style="background:#efdead;" | Member(s)
! style="background:#efdead;" | Role
|-
| '''The Mana World - Athena Leader'''
| Wombat
|Coordinate tmwA. Network and delegate tasks. Increase participation.
|-
| '''Sound Lead'''
| Yubabax116
| Determines if sound on the forums is ready for the game. Encourages people to get involved in sound and encourage players to try their hand at sound. Attempts to meet the [REQ]s of content developers as well as creates any sound that may seem to add to the project, from monsters to maps to battle and beyond.
|-
| '''Art Director'''
| Poison_Ivy
| Determines if art on the forums is ready for the game. Adds tags to be put on art topics. Encourage artists contribute to the game and encourage players to try their hand at art. Understand content priorities and attempt to steer art to meeting content [REQ]s when an artist is open to suggestion.
|-
| '''Source Lead'''
| o11c
| Adjusts and coordinates Athena source code. Meets content team requests for source code adjustments to further content. Research and development of Athena source code and scripting conventions.
|-
| '''General Content Team'''
| Argul, Wombat, Jenalya, Alastrim, theKandiman, Poison_Ivy
| Coordinates non-sound/non-art related content, adds content to the gitorious repositories. Review content for mainline release. Give reservations for requested maps. Give reservations for existing items, equipment and monsters in their respective databases. Communicates through IRC with the General Content Team, the Content Lead and Administration. Channel: #tmw-dev Server: irc.themanaworld.org
|-
| '''Monster Skills Lead'''
| Nmaligec
| Research and development with monster skills for complex monsters.
|-
| '''XML Team'''
| Poison Ivy, Wombat, Ali-G
| Fixes item, equipment, monsters, particles, player-set etc. images and xml for game animation.
|-
| '''Mapping Team'''
| Ali-G
| Given maps by the General Content Team for review. Check for proper use of black border, collision tiles, and application of tiles onto the correct layers they belong on. Fix mapping errors. If map has many errors, the Mapping team can return the map to its creator for fixing.
|-
| '''Skills and Magic Team'''
| Jenalya, Argul
| Research and development of skills and magic.
|-
| '''Balance'''
| General Content Team
| Create a new balance system that can be understood by present and future tmwAthena developers and uses equipment tiers.
|-
| '''Battle Systems Team'''
| Phoenix Council (theKandiman)
| Research and development of a working battle system for the game using various balance parameters as guidelines.
|}

Shannon's Bowler Hat

2011-07-22T13:42:04Z

Jenalya:

{{Quest
|img = [[Image:Shanon.png]]
|Start = 010-2 First floor of Dimond's Cove
|Redoable = No, only once
|Reward = 1 Bowler Hat
|Cost = 20 items of the list
}}

'''This is an annual quest, open from the 24th of January 2011 to the 26th January 2011. So if you missed it this year, come back next year!'''

'''What To Do:'''

# Head southwest of Hurnscald down to Dimond's Cove, the big house in the middle of the forst. At the first floor, talk to Shanon.
# Talk to Shanon. You have the choice of giving her a total of twenty of the following items: Steaks, Chicken Legs, Red Apples, Green Apples or Beers. This can be for example 15 Red Apples and 5 Green Apples.
# Then listen to her poem by giving her one item each time

'''Hints:'''

* You cannot complete the quest with a full inventory!
* Your level doesn't matter but your account has to be 2 weeks old to be able to do the quest.

'''Steaks are dropped by:'''

* Grass Snakes (5%)

'''Red Apples are dropped by:'''

* Sea Slime (8%)
* Green Slimes (7,5%)
* Red Slimes (7,5%)
* Evil Mushroom (5%)
* Fluffies (4%)
* Bandits (2%)
* Archants (1%)
* Pink Flower (1%)
* Spider (1%)

'''Reward:'''

* 1 Bowler Hat

'''Total Cost:'''

You will need to give '''only twenty''' items that belong to the list below:

* Steaks
* Chicken Legs
* Red Apples
* Green Apples
* Beers

[[Category:Quest]]