Consider this historical reference

Abstract: eAthena is not part of the medium-term development perspective for tmw. Consequently, changes to eAthena are subject to a short lifespan and little hope of re-use. As a result, there is no discernible feature development for eAthena to extend the player experience on this server. However, some enhancements that would benefit the player community (and might thereby serve to attract new testers and developers) depend on such extensions; one particular prominent example of this is magic. This document proposes a simple magic system as an addition to the eAthena system. The magic system satisfies the following requirements: (a) it is easy to implement and integrate into eAthena, (b) it can be easily configured and fine-tuned, (c) it requires no client-side extensions to function properly. This document presents the system together with fifteen spells as well as their intended behaviour and describes the system would work in regular gameplay. The document further sketches a prototype of the system. [http://mantis.themanaworld.org/view.php?id=303 Mantis entry for this proposal.]

(The following discussion applies to the updated v9 version of the patch)

Introduction

eAthena conceptually supports a magic system; however, this magic system requires client support. Furthermore, if there are bugs in the system, the generally low quality of code in eAthena would make debugging a less than pleasant experience. Since plans on the tmw side further expect eAthena to be retired soon, it seems wasteful to spend much time on a feature-rich magic system. As an alternative, tmw could adopt a simple magic system that provides the `bare-bones magic experience' as quickly as possible before eAthena support is retired: players can cast spells, but will not be required to wait for a new client to become available. As an interface, the existing chat system appears to provide sufficient expressive power to communicate many interesting spells to the server, while player location and heading can affect spell effects more or less subtly. While these interface choices are limiting, they (a) do not require players to familiarise themselves with a new interface, (b) do not require the implementation of `throw-away' interface and protocol code, and (c) (as mentioned) are already sufficient for a number of interesting spells.

In the following, the basics of the magic system are summarised, specifically the notions of `spell power', `magic defence', `magic absorption' and `spell requirements'. The document then discusses a number of spells that can be expressed with the proposed interface; all of the listed spells are also implemented as part of the prototype. A high-level overview over the implementation of the prototype follows, then a description of how `spell requirements' can be configured. The document concludes with a list of possible approaches towards improving the visualisation of these spells by means of altering the client, and with observations about extensions to and applications of the system.

Basics

The proposed system is based on the idea of implementing magic by means of atomic spells, i.e., magical effects arise by triggering a particular effect-- while some spells may interact, there is no foundational mechanism that allows players to construct new spells, largely because such a mechanism would likely be hard to balance. Spells are parameterised by spell power, which is a derived attribute of each player:

spell power = experience level + intelligence

This definition of spell power (in addition to being simple) permits magic usage by established players without a (second) stat reset, while giving sufficiently significant meaning to intelligence to make it of some interest. Intelligence also affects one of the two defensive properties for magic:

magic absorption = experience level / 8 + intelligence

`magic absorption' describes how many points of magical damage to subtract each time magical damage is dealt to a character-- this derived stat therefore works similarly to vitality. A third stat, `magic defence', is already present in eAthena and describes (as a percentage) how much magical damage is absorbed. `magic defence' is applied first, then `magic absorption'.

Each individual spell consists of the following attributes:

• Name: The spell's name. This name need not be known to players; its principal purpose is for reference. As such, it serves as the primary key in the configuration file (see below).
• Invocation: The spell's invocation. This phrase triggers the spell (see `casting', below). Knowing the invocation is the principal differentiator between players who can cast a given spell and players who can't.
• Level: The spell's difficulty level. This level corresponds directly to player experience levels.
• Cost: The spell's mana cost.
• Prerequisites: A set of items that a player must possess in order to be able to cast the spell.
• Material Components: A set of items that are consumed to power the spell.
• Effect: The effect triggered by the spell.

Invocation, level, cost, prerequisites, and (material) components are together referred to as spell requirements, as they guard whether or not the spell effect will be triggered.

Casting

To cast a spell, a player must satisfy all relevant requirements:

• Invocation: The player must type the invocation into the game's chat mechanism.
• Level: The player's experience level must be equal to or greater than the spell level.
• Cost: The player must have at least as many mana points as indicated by the spell cost. If the spell is successful, all of these mana points are consumed.
• Prerequisites: The player must possess all prerequisites for the spell as inventory items.
• Material Components: The player must also have all material components in his or her inventory. If the spell is successful, all of these components are consumed.

If the player types in an invocation that matches the invocation of a given spell, all of the above are checked. Only if all requirements are met is the spell effect triggered. In that case, mana points are subtracted and material components consumed as mentioned above. In all situations (no matter whether the spell requirements are fully met or not) a correct invocation results in part of the spell being starred out. Assume that a given spell has the invocation `foo'. Whenever a player types in `foo', the chat message sent to other players might be `**o' or `***' or `f**' instead. Starring out is decided individually for each character based on the obscure factor. This allows spellcasters to maintain some level of secrecy regarding the invocation.

Spell list

The list below contains a number of spells that can be handled by the proposed system within the previously described requirements. Note that the spells do not list level, cost, prerequisites or material components, as determining these is not part of the implementation of the magic system per se, but rather of applying it in practice.

Since it may be desirable to vary spell power in practice, the spells do not have predetermined durations, ranges etc.; these should be part of spell configuration. Instead, we list all configuration options that would be of interest to the specified spell.

Shroud

• short name: `shroud'
• visual effect: MAGIC_CAST_DEFAULT (2)
• affects: self
• option `parameter': A set of flags that narrow down the exact shroud behaviour

This spell obscures the player's identity: any other players observing a thusly shrouded player will not be able to determine the player's name. The precise behaviour is determined by the flags specified as `parameter':

• 1: If set, the player's name is hidden when (s)he talks
• 2: If set, the shroud disappears as soon as the player tries to pick up an item
• 4: If set, the shroud disappears as soon as the player talks (excluding spellcasting)

For example, setting `parameter' to 6 will make the shroud disappear whenever the player tries to pick up an item OR tries to talk.

Reveal

• short name: `reveal'
• visual effect: MAGIC_CAST_DEFAULT (2), MAGIC_EFFECT_REVEAL (10) (on subjects)
• affects: all in range, including self, unless they resist (see below)
• option `power': Maximum caster experience level that can be revealed
• option `range': Effective spell range

This spell cancels all shroud spells in the area of effect if the caster's spell power is at least as great as the shrouded player's level.

Detect Players

• short name: `detect-players'
• visual effect: MAGIC_CAST_DEFAULT (2)
• affects: self
• option `range': Effective spell range

This spell detects all players in the area of effect and lists them to the caster. Only the current map is affected. Note: This spell will also list the correct names of shrouded players.

Wind

• short name: `wind'
• visual effect: MAGIC_CAST_DEFAULT (2)
• affects: all PCs and monsters in range
• option `range': Effective spell range
• option `duration': Effective spell duration (cycles)
• option `power': Cycle length in game ticks

This spell creates a `wind' area immediately in front of the player. All PCs and monsters are blown in the direction the caster was facing at the time the spell was cast. By walking directly against the wind, players are able to overcome this obstacle, but only with considerable delay. A second `wind' spell near the area of the first will result in neither spell taking effect. If one of the spells finishes before the other, however, the remaining spell will take effect immediately. Note: Visualisation for this spell is less than ideal at this point, particularly for PCs that are being pushed around. See section `Improving visualisation in the client', below.

Protect

• short name: `protect'
• visual effect: MAGIC_CAST_ENHANCE (3), MAGIC_EFFECT_SHIELD (11) on the subject, MAGIC_EFFECT_SHIELD_ENDS (111) when finished
• affects: self or an optional subject specified as parameter
• option `range': if not cast on self, maximum distance for the spell subject
• option `duration': effective spell duration
• option `power': Number of HP to absorb each time the subject is injured

This spell absorbs, each time the subject is injured by weapons, some points of damage. The subject is slowed down by an equal percentage.

Haste

• short name: `haste'
• visual effect: MAGIC_CAST_ENHANCE (3), MAGIC_EFFECT_HASTE (12) on the subject, MAGIC_EFFECT_HASTE_ENDS (112) when finished
• affects: self or an optional subject specified as parameter
• option `range': if not cast on self, maximum distance for the spell subject
• option `duration': effective spell duration
• option `power': percentage the subject should be sped up by

This spell speeds up the subject's attacks as per a speed potion. However, the subject becomes highly vulnerable during this period: every time the subject receives physical damage that bypasses its armour and defences, the suffered damage is doubled for every sixteen points of speedup (tripled for a speedup of 32, multiplied by 3.5 for a speedup of 40 etc.)

Barrier

• short name: `barrier'
• visual effect: MAGIC_CAST_ENHANCE (3), MAGIC_EFFECT_BARRIER (20) on subjects, MAGIC_EFFECT_BARRIER_ENDS (120) when finished
• option `range': if not cast on self, maximum distance for the spell subject
• option `duration': effective spell duration
• option `power': the percentage of magical damage absorbed

During the duration of this spell, magic defence is increased, thereby absorbing all damage from offensive spells such as the three previous ones, but also from healing magic, curses, and `haste'/`protect'.

Flying Backpack

• short name : `flying-backpack'
• visual effect: MAGIC_CAST_ENHANCE (3), MAGIC_EFFECT_FLYING_BACKPACK (23) on subjects, MAGIC_EFFECT_FLYING_BACKPACK_ENDS (123) when finished
• option `duration': effective spell duration

During the duration of this spell, the subject is not affected by being burdened, i.e., can regenerate normally. Note: Suggested by Vink.

Heal

• short name: `heal'
• visual effect: MAGIC_CAST_WHITE (4), MAGIC_EFFECT_HEAL (13) on subjects
• affects: all PCs in range
• option `range': effective spell range
• option `hpcost': percentage of HP the caster must pay out of his/her own HP

Heals hit points from all OTHER players within the area of effect. The caster has to a certain percentage of the health given to those players from his or her own health. If this would kill the caster, the healing effect is reduced to an appropriate fraction; e.g., if a caster with 11/11 HP tries to heal a player with 20/30 HP and another with 10/110 HP at a cost of 100%, then the second player will receive one HP (-> 21/30) and the secon will receive nine (-> 19/110 HP).

Life

• short name: `life'
• visual effect: MAGIC_CAST_WHITE (4), MAGIC_EFFECT_RESURRECT (16) on subjects
• affects: one dead PC in range
• option `range': effective spell range
• option `power': maximum experience level of the player to be resurrected

Resurrects a dead player.

Aggravate

• short name: `aggravate'
• visual effect: MAGIC_CAST_DEFAULT (2), MAGIC_EFFECT_AGGRAVATE (18) on subjects
• affects: all monsters in range
• option `range': effective spell range
• option `parameter': precise spell effect:
  • 0: Attack caster
  • 1: Permanently make agressive
  • 2: Both of the above

Aggravates all monsters in range. Each monster tries to attack the caster.

Peace

• short name: `peace'
• visual effect: MAGIC_CAST_DEFAULT (2), MAGIC_EFFECT_PEACE (17) on subjects
• affects: all monsters in range, unless their level is too high
• option `range': effective spell range
• option `power': effective spell power (see below).

All monsters in range may become peaceful, stopping their current attacks and no longer auto-attacking (the latter effect is permanent for the given monster). This effect is only guaranteed if the player's modified spell power (i.e., the spell power modified by the configuration option `power') is greater than or equal to the subject's monster level; otherwise the spell may or may not take effect (whether the spell takes effect is determined solely by who the caster is and who the monster is, i.e., re-casting the spell will not change the outcome). The spell will never take effect against monsters whose level is more than twice the modified spell power.

Emote Curse

• short name: `emote-curse'
• visual effect: MAGIC_CAST_DEFAULT (2)
• affects: self or subject standing immediately in front of the caster
• option `duration': effective spell duration
• option `parameter': particular smiley to emote

During the duration of the spell, the subject will constantly emote. The precise emote must be specified as a spell parameter. Note: Based on a suggestion by Vink.

Delayed Teleport

• short name: `delayed-teleport'
• visual effect: MAGIC_CAST_DEFAULT (2), MAGIC_EFFECT_TELEPORT (19) after the delay completes
• affects: self
• option `duration': delay until the spell takes effect

After the duration has expired, the caster is teleported back to the location he/she was at when casting the spell.

Teleport

• short name: `teleport'
• visual effect: MAGIC_CAST_DEFAULT (2), MAGIC_EFFECT_TELEPORT (19) when triggered
• affects: self
• option `duration': effective spell duration

This spell teleports the caster to a pre-defined `teleport anchor' (specified in the configuration file) after a short delay. Each anchor may add further requirements (MP, level, prerequisites, components) to the spell.

Magic Mouth

• short name: `magic-mouth'
• visual effect: MAGIC_CAST_DEFAULT (2), both on the caster and the magic mouth
• affects: self
• option `duration': amount of game ticks the magic mouth stays alive
• option `range': minimum distance from the next magic mouth

This spell must be invoked together with a phrase to be spoken by the magic mouth. It will summon a magic mouth NPC that will repeat that phrase (tagged with the caster's name) to everyone who decides to listen. Magic mouths cannot be placed within walls or too close to each other. Note: This spell really demands a material component.

Kill

• short name: `kill'
• visual effect: MAGIC_CAST_BLACK (5), MAGIC_EFFECT_EVIL (15) on subjects
• affects: all PCs (if pvp) and monsters standing immediately in front of the caster, or in a nearby square in the direction the caster is facing
• option `power': maximum damage the spell will deal
• option `hpcost': percentage of damage dealt that the caster must pay from his/her HP

Deals considerable damage to each monster standing immediately in the selected target square (either the square directly in front of the caster or one nearby, in the direction the caster is facing). The caster loses an appropriate amount of hitpoints and may die. If the caster dies, his/her hair turns white. Note: Based on a suggestion by Vink. Note 2: Combined with Life, this spell can be used to rather great effect by a pair of sorcerers. One possible way to combat such abuse would be to require expensive material components for either; another would be to alter Life in such a way that it cannot resurrect those who were slain by their own dark magic.

Dragon Slave

• short name: `dragon-slave'
• visual effect: MAGIC_CAST_BLACK (5), MAGIC_EFFECT_INJURE (14) on subjects
• affects: all PCs (if in pvp) and monsters in range
• option `duration': number of attack waves
• option `power': maximum damage to deal; this is divided by the range of each wave
• option `range': range of each wave
• option `hpcost': percentage of damage the caster must pay from his/her own HP

Deals damage to the caster's surroundings in multiple rounds. Monsters/pvp players nearby may be hit multiple times, once for each round. The caster must pay a certain amount of the damage dealt. If dealing this damage would kill the caster, the damage is reduced proportionally (as per the `heal' spell). If the caster gets very close to dying, his/her hair will turn white.

Death's Door

• short name: `deaths-door'
• visual effect: MAGIC_CAST_BLACK (5), MAGIC_EFFECT_EVIL (15) on subjects
• affects: all PCs (even outside of pvp!) and monsters in range
• option `range': effecive spell range
• option `power': percentage chance of success per subject

The health of all player characters and monsters in the specified area of effect is set to one (modified by magic defence, as usual). The success chance for the caster (who does not get magic defence) is 100%, but for any other creature is as determined by the option `power'. Note: This spell is the only means for injuring another player outside of a pvp zone. It is possible to abuse this spell to aid monsters in killing other players. Furthermore this spell may deal a significant amount of damage for a comparatively small cost.

Create Item

• short name: `create-item'
• visual effect: MAGIC_CAST_DEFAULT (2)
• affects: self
• option `power': number of items to create
• option `parameter': item ID of the item to create

Creates an appropriate number of the indicated items. Note: In practice, this spell must have material components that are at least as valuable as the created item to avoid potential economical issues.

Summon

• short name: `summon'
• visual effect: MAGIC_CAST_DEFAULT (2), MAGIC_EFFECT_SUMMON_PREPARE (21) at the target location, MAGIC_EFFECT_SUMMON_EXECUTE (22) at the target location after the spell delay
• affects: world
• option `power': time until the summoned creatures disappear again
• option `range': number of creatures to summon
• option `duration': delay between casting and appearance of the summoned creatures
• option `hpcost': hp cost to pay for the summons (absolute value)
• optoin `parameter': monster ID to summon

This spell summons a number of creatures and makes them attack nearby enemies. If the caster attacks one of the creatures, that creature (and that creature alone) turns into an enemy and attacks the caster as a normal monster would.

Prototype implementation

The prototype implementation hooks into the existing chat handler messaging mechanism in eAthena. It processes all chat messages and tests whether they are identical to a given indication, then implementing the spell protocol as listed above. For each spell, the chat handler instructs the chat system that the spell was not spam, thereby allowing quick re-casting without automatic banning. To allow easy fine-tuning of spells, all spell requirements are read from a configuration file.

Spell configuration file

The spell configuration file (spell.conf) contains three kinds of declarations:

• obscure = <int>

This optionsets the `obscure percentage', an int. This defines how likely it is that an individual character in a spell invocation will be starred out (preventing casual listeners to figure out precisely what the proper invocation is). Note that the effectiveness of this measure also depends on the length of the invocation.

• teleport-anchor "<name>" = "<mapname>", <int>, <int>

This sets up a teleport destination at the specified map and the specified x and y co-ordinates. Teleport anchors may further be restricted by spell requirements that are added on top of the requirements already enforced for the teleport spell itself. Such options are listed as for a spell (see below).

• spell "<str>" = "<str>" : <options>

configures the specified spell with the specified invocation; e.g., `spell "xyzzy" = "teleport"' will bind the invocation "xyzzy" to the "teleport" spell. In this vein, spells may be bound with multiple names (and different options). The <options> adjust various spell properties; any option left open will be left at some unreasonable defualt. The options are below:

• • level = <int> (spell level. Minimum int+lvl a character must have to cast it.)
  • effect = <int> (spell casting graphical effect index number; overrides the default.)
  • mana = <int> (mana points that must be expended to cast the spell)
  • prerequisites = [ <int>, ..., <int> ] (Prerequisite items (specified as item IDs) to cast the spell; these will NOT be consumed.)
  • components = [ <int>, ..., <int> ] (Material components (specified as item IDs) to require for the spell; these will be consumed when the spell is cast. You can require the same item more than once to require multiple instances of that item to be consumed.)
  • parameter = <int> (a spell-dependent parameter)
  • master = <lmap> (master spell power modifier; applied before all other spell properties are applied. Defaults to the identify function.)
  • power = <lmap> (Modified spell power. Meaning varies by spell. Defaults to the identify function.)
  • range = <lmap> (Effective spell range. Meaning varies by spell. Defaults to the identify function.)
  • duration = <lmap> (Effective spell duration. Meaning varies by spell. Defaults to the identify function.)
  • hpcost = <lmap> (HP cost percentage. Meaning varies by spell. Defaults to the identify function.)

An <lmap> is a (bounded) linear map. Its syntax follows the grammar below:

 LMAP ::= PREBOUND '{' BODY '}' POSTBOUND
 PREBOUND ::= /* empty */ | <int> '<='
 POSTBOUND ::= /* empty */ | '<=' <int>
 BODY ::= <int> '+' <float> '*' 'x'

Here are some examples of ranges, with implied semantics:

• { 0 + 2 * x } # doubles the value
• { 1000 + 1 * x } # Increments the value by one
• { 1000 + -2 * x } # perfectly valid
• 0 <= { 0 + 1 * x } # The result is clipped at zero: no negatives
• { 0 + 1 * x } <= 9 # Result is clipped at 9: no greater values

Please note that in the current implementation most default values, particularly those for `mana' and `level', are inadequate and must be adjusted before practical adoption.

Improving visualisation in the client

While client visualisation should be fully functional at this point, it could use some improvement. The implementation sends different level-up like signals to the client, which the existing client interprets as `job level up' signals. A refined client could map these numbers to more appropriate particle effects. [http://mantis.themanaworld.org/view.php?id=305 Mantis entry with corresponding client-side improvements]. This would be accomplished by adding a new configuration file-- `being-effects.xml' in the prototype-- that has structure such as the following:

  <being-effects>
    <effect id="0" audio="sfx/levelup.ogg" particle="graphics/particles/levelup.particle.xml" />
    <effect id="1" audio="sfx/levelup.ogg" particle="graphics/particles/skillup.particle.xml" />
    <effect id="2" audio="sfx/foo.ogg" />
    <default particle="graphics/particles/default.xml" />
  </being-effects>

This file maps server-side effect IDs to client-side sound effects and particle effects. The first two entries (ids 0 and 1) replicate the existing effects. The third entry maps effect ID 2 to the sound effect "sfx/foo.ogg". The fourth and final entry is a default rule, indicating that all unidentified effects should not generate sound, but produce the particle effect "graphics/particles/default.xml".

Conclusions and Future Work

This document presents a magic system that is simple to use and easy to integrate with the existing infrastructure but offers players additional, `magical' operations. While not all of the spells presented herein are balanced in and by themselves, they can be balanced by adding appropriate material component requirements. This in turn creates new opportunities for money sinks and player-driven markets. Finally, the use of invocations as part of the spellcasting process allows spells to be guarded and/or propagated by social means rather than by developer-driven quests; depending on how the invocations are seeded, this may have interesting effects on existing and new social structures within the game.

Note that the magic system does not require all spells to be activated at the same time: by setting a spell's invocation to "", the spell can be effectively disabled. In this fashion, spells can be gradually added after they have survived testing. Similarly, that have been found exploitable or broken can be disabled quickly, while spells that have become more widely known than anticipated can be re-hidden by changing (and re-seeding) their invocation.

Acknowledgements

Thanks go out to Vink, who suggested several spells, peavey, who reviewed the patch and suggested making spell effects more easily configurable, and to Sanga, who provided numerous bug and experience reports, as well as several suggestions for improving spell usage.

Future extensions and spell ideas

Below are some ideas for improving existing spells:

• Dying from your own offensive spell should preclude resurrection

Below are some ideas for additional spells:

• Reversal: any spell cast on the subject (good or bad) backfires on the caster. For offensive spells, the computed damage backfires (making `Death's Door' suicidal.) Spells the caster casts on him/herself are instead cast on a random subject in the area. (HP draining for powering healing/offensive magic is unaffected.) Any spell can only be turned back once in such a fashion (as in Final Fantasy).
• Curse of the Pink Fluffy: a near-indestructible pink fluffy follows the subject around, making funny noises * Summon Ether Serpent: summons a cyan-ish snake (semi-transparent, if possible) that is significantly tougher than most monsters in the game but deals most of its damage by draining mana. Impervious to `peace', will not (at first) attack its summoner.
• Banish: banishes a summoned creature (Ether Serpent, Pink Fluffy).
• Delay: the next spell cast by the caster will be delayed by ten seconds. (Note that this spell can also be applied to other spellcasters via Reversal...).
• Dispel: cancels any spells currently active/in range and any spells cast in the next 5 seconds.
• Gate: as teleport, but creates a temporary gate to that location that other people can follow through (the gate could be visualised as an NPC).
• Anchor: creates a temporary teleport anchor (a name bound to a location). Can only override existing bindings if the caster is more powerful than the one of the existing binding.
• Bless: increases accuracy and slightly increases damage (eAthena might already have this one.)
• Blink: short-range teleport in the direction the caster is facing; does not pass through walls but may pass through monsters/players.
• Boost: temporarily increases the caster's spell power.