spell-OLC.tbamud

Spell and skill online creation for Tba mud 2020.

https://github.com/tbamud/tbamud

Test spell and skill OLC server

telnet rescator7.com 4000

use the in game command 'god' to raise your level to 32, and have access 'spedit' and 'splist'

spedit

• spedit = To create a new spell or skill.
• spedit <vnum> = to edit spell, skill .
• spedit <text> = search and edit.

e.g: spedit he

500H 100M 82V (news) (motd) > spedit he
Do you want to edit 'control weather' (vnum: 11)? (y/n, q): n
Do you want to edit 'heal' (vnum: 28)? (y/n, q): n
Do you want to edit 'group heal' (vnum: 48)? (y/n): n
500H 100M 82V (news) (motd) > 

NOTE: You can create a spell or skill vnum from 56-130, by spedit vnum.

Main menu

This is an example from the spell poison vnum 33.

• Type: SPELL or SKILL. mostly, spell needs to be called by cast 'spell name', while SKILL act more like a command: bash someone.

• Status: Available / Unvailable. Turn on/off spells/skills on the fly.

• Name: Name of the spell/skill could be changed at will.

• Min position: Minimum position to cast a spell, or call a skill.

• Target flags: (see below)

• Magic FLAGS: (see below)

• Damages: (Does damage up to max damage to the victim)

  • Damage (string formula)

  • Max damage (integer)

  Require Magic FLAGS: DAMAGE VIOLENT

  Learn more about string formula: https://github.com/Rescator7/spell-OLC.tbamud/blob/master/src/formula.README

• Pulse delay (string formula): Make a delay after a spell/skill is called.

• Effectiveness (string formula): How effective, or dificult to call this spell/skill. 100% effectiveness doesn't imply 100% success rate. It's a mix of your spell/skill learned % * effectiveness / 100. for e.g: If you are learned at 66% in poison, and the effectiveness is 83%. The true effectiveness of that spell would be 66 * 83 / 100 = 54%. So, nearly 1 time out of 2 you'll receive the message: "You lost your concentration".

Menu colors

• Menu in white: Option not set.
• Menu in blue: Option is set.
• Menu in Yellow: Option should be set.
• Menu in Red: Option is disabled. This spell or skill use special build-in code.

Min position

The minimum position to cast a spell, or perform a skill. Usually, Fighting is used for in combat spell, and Standing for non-combat spell.

• Dead
• Mortally wounded
• Incapacitated
• Sleeping
• Resting
• Sitting
• Fighting
• Standing

Magic flags

• DAMAGE: This flag activate "6) Damages" effect.

• AFFECTS: This flag activate "A) Menu -> Applies & Affects" effects.

• UNAFFECTS: This flag activate "D) Menu -> Dispells" effects.

• POINTS: This flag activate "9) Menu -> Points" effects.

• ALTER OBJS: To modify objects. Only used by those original spells:

          - SPELL_BLESS
          - SPELL_CURSE
          - SPELL_INVISIBLE
          - SPELL_POISON
          - SPELL_REMOVE_CURSE
          - SPELL_REMOVE_POISON
  

  This version of spell OLC doesn't support ALTER OBJS execpt original spells, but it's possible to manually add support in magic.c (mag_alter_objs)

• GROUPS: Spells groups. Only used by those original spells:

          - SPELL_GROUP_HEAL
          - SPELL_GOUP_ARMOR
          - SPELL_GOUP_RECALL
  

  This version of spell OLC doesn't support GROUPS except original spells, but it's possible to manually add support in magic.c (perform_mag_groups)

• MASSES: This is unused in TBA MUD 2020 yet.

• AREAS: Activate damages to be done in the room. Original SPELL_EARTHQUAKE require it.

• SUMMONS: This flag activate "X) Menu -> Summon mobile" effects.

• CREATIONS: This flag activate "O) Menu -> Create objects" effects.

• MANUAL: This flag is used by special spells/skills with function.

• ROOMS: Differ from AREAS as it is used to modify a room. ONLY used by the original SPELL_DARKNESS.

This version of spell OLC doesn't support ROOMS except the original SPELL, but it's possible to manually add support in magic.c (mag_rooms)

• VIOLENT: This flag is required by spells/skills with violent actions. It will stop your action in peaceful rooms, and it will start a fight even if your spell/skill failed. This flags is also required if DAMAGES or AREAS flags are set.
• ACCDUR: Used in conjonction with AFFECTS or PROTECTIONS, it accumulate the duration.
• ACCMOD: Used in conjonction with AFFECTS and APPLIES only, it accumulate modifier.
• PROTECTION: This flag is activate "P) Menu -> Protection from" effects.

DON'T FORGET TO SET "Magic FLAGS" YOU NEED, OR YOU WILL SEARCH A LONG TIME FIGURING OUT WHY YOUR SPELL AS NO EFFECT.

Because, it's possible to create effects, and forget to activate them by using the proper "Magic FLAGS".

Menu Points

You can modify the player's points:

• Hit p. <value>
• Mana <value>
• Move <value>
• Gold <value>

Value is a string formula. The result of the formula will be added to the player's point.

• Hit p. can't go below 1, and not above MAX_HIT
• Mana can't go below 0, and not above MAX_MANA
• Move can't go below 0, and above MAX_MOVE
• Gold can't go below 0, no upper limits!

Affected by: Target FLAGS

Require Magic Flags : POINTS

Menu Protection from

This menu makes protection spells. Protection are NOT against an affect, but an entire spell ! The system accept upto 6 protections.

1. Name : poison (33) Duration : 4 Resist % : 20

• Name (integer)
• Duration (string formula)
• Resist % (string formula)

Require Magic Flags: PROTECTION

Menu Applies & Affects

This menu add applies and affects to a spell/skill. This is a 6 slot menu.

• APPLIES (1 - 25)

  • NONE(1): should not be used. it does nothing.
  • CLASS(8): should not be used. it does nothing.
  • LEVEL(9): should not be used. it does nothing.
  • GOLD(16): should not be used. it does nothing.
  • EXP(17): should not be used. it does nothing.

• AFFECTS (26 - 48)

  • UNUSED(46): should not be used.
  • PROT_SPELL(48): should not be used. it is reserved for Protection Menu system.

APPLIES require a modifier and a duration. Both are string formula. AFFECTS only require the duration.

Require Magic Flags: AFFECTS

Menu Dispel

This menu is used to create a spell or skill that will remove all affects and applies from a specific spell.

This is a 3 slots menu.

• spell(string formula)

Require Magic Flags: UNAFFECTS

Menu Create objects

This menu is used to create an object. Up to 3 objects. The object is a string formula. Examples:

1. Object : 1200 + self.class
2. Object : 1300 + (self.good ? 1 : (self.evil ? 2 : 3))

Example #1 will create:

• object vnum 1200 if caster is Magical User
• object vnum 1201 if caster is Cleric
• object vnum 1202 if caster is a Thief
• object vnum 1203 if caster is a Warrior

Example #2 will create:

• object 1301 if the caster is good
• object 1302 if the caster is evil
• object 1303 if the caster is neutral

Require Magic Flags: CREATIONS

NOTE: Object vnum <= 0 is not considered valid.

Menu Summon mobile

This menu is used to summon a mobile. It may or not require an object item to succeed

• Spell Clone(9)

1. Mobile : 10
2. Required item : 161

This exemple is from spell clone(9). It load mobile(10) "the clone". If the object(161) "sacrificial entrails" is in the inventory of the caster, the spell will succeed and the object will be deleted. The mobile will be affected by CHARM.

Info: Both "Mobile" and "Required item" are string formula.

Require Magic Flags: SUMMONS

NOTE: Mobile vnum <= 0 is not considered valid.

Menu Classes

You can assign a class to your spell or skill in this menu. You can assign all the 4 originals classes if needed.

1. Class : Magic User ( 3)
   • Prac gain % : <empty>
   • Mana : (25 - (1 * self.level)) > 10 ? (25 - (1 * self.level)) : 10
2. Class : Cleric ( 7)
   • Prac gain % : <empty>
   • Mana : (25 - (1 * self.level)) > 10 ? (25 - (1 * self.level)) : 10
3. Class : <empty> ( 0)

• Class(integer) = Class name (# i) it is assigned to.
• Prac gain %(string formula): Which % gain you receive toward learning a spell/skill by practice (at the guild). IF NOT SET the TBA mud build-in learning system would be used. NOTE: Minimum gain is 5%, to avoid having formula that return negative or NULL value.
• Mana(string formula): Spell mana cost. This option is disabled for SKILL

PLEASE NOTES:

1. From the main menu switching from Type: SPELL to SKILL will unset all Menu -> Classes: Mana settings!
2. There is a mininmum mana cost per spell of 5 mana. Even, if Mana is set to 0.

Menu Messages

In this menu you can set the basic spell and skill messages. The messages support act codes.

1. Wear off : You feel less righteous.
2. To self : $b glows briefly.
3. To victim : You feel righteous.
4. To room : <empty>

• Wear off message: This message is sent when an affect or apply wear off. If Applies & Affects isn't set it does nothing.
• To self: Send this message to the caster. Used in particuliar spell or skill, when there is no victim, or the caster isn't the victim.
• To victim: Send this message to the victim. The caster is sometime the victim. For e.g: in SELF_ONLY spell.
• To room: Send this message to the room.

read more about act code: https://github.com/tbamud/tbamud/blob/master/doc/act.txt

NOTES:

1. Spell OLC created a new act code $b this code act like $p when the target of the spell is an object, and act like $N when the target is a MOB/PC. In this exemple spell bless(23) will send the message $b glows briedfly to the caster. $b = will be either the name of the object or victim's name.

2. It's still possible to send more messages using "Menu -> Script".

Menu Script

The menu script is more a list of commands that spell or skill will execute at the end of it execution. The list support currenty those commands:

Communication:

SAY_TO_ROOM {"message"};
SAY_TO_SELF {"message"};
SAY_TO_CHAR {"message"};
SAY_TO_VICT {"message"};

Those messages functions are complementary to the "M) Menu -> Messages".

Action:

TELEPORT {"where"};

where = room vnum or mobile name.

Will teleport either the caster or the victiom to the room "where". Depend on MAG_FLAGS: SELF_ONLY, CHAR_ROOM.

LOAD_MOBILE {"mob, where"};

• mob = mobile vnum.
• where = room vnum or a second mobile name.

Will load mobile "mob" to "where". The mobile will NOT be affected by AFF_CHARM.

For a charmed mobile use "X) Menu -> Summon mobile".

That's it for now. More script commands could easily be added in spells_script.c

Warnings

Print a list of warnings about spell or skill bad setup.

for e.g: If you create an apply or affects. Menu A, but you don't set Magic Flags: AFFECTS

you'll receive that warning:

Magic flags: MAG_AFFECTS is required. (Affects and applies are set).

splist command

List of spells and skills. The command accept 1 filter option.