Welcome to the Lich 5 scripting documentation for GemStone IV and DragonRealms.
Lich is a scripting engine that allows players to automate and enhance their gameplay experience in Simutronics text games. It provides a Ruby-based API for interacting with the game.
| Guide |
Description |
| {file:guides/scripting-basics.md Scripting Basics} |
Core concepts for writing Lich scripts |
| Guide |
Description |
| {file:guides/character-stats.md Character Stats} |
Stats, Skills, and character resources |
| {file:guides/spells-guide.md Spells} |
Working with spells and magic |
| {file:guides/effects-guide.md Effects} |
Active spells, buffs, debuffs, and cooldowns |
| {file:guides/psm-reference.md PSM Reference} |
Combat Maneuvers, Shield skills, Feats, Warcries |
| {file:guides/society-guide.md Societies} |
Voln, Council of Light, Guardians of Sunfist |
| Guide |
Description |
| {file:guides/game-data.md Game Data} |
Rooms, Maps, NPCs, Items, and Players |
| {file:guides/bounty-guide.md Bounty System} |
Adventurer's Guild bounty tasks |
| Module |
Description |
| {Lich::Common::Char} |
Character health, mana, stamina |
| {Lich::Gemstone::Stats} |
Character statistics (STR, DEX, etc.) |
| {Lich::Gemstone::Skills} |
Trained skills and ranks |
| Module |
Description |
| {Lich::Gemstone::PSMS} |
Player System Manager skills |
| {Lich::Gemstone::CMan} |
Combat Maneuvers |
| {Lich::Gemstone::Shield} |
Shield Specializations |
| {Lich::Gemstone::Feat} |
Character Feats |
| {Lich::Gemstone::Weapon} |
Weapon Techniques |
| {Lich::Gemstone::Armor} |
Armor Specializations |
| {Lich::Gemstone::Warcry} |
Battle Cries |
| Module |
Description |
| {Lich::Common::Spell} |
Spell management and casting |
| {Lich::Gemstone::Spells} |
Spell circle utilities |
| {Lich::Gemstone::Effects} |
Active effects tracking (spells, buffs, debuffs, cooldowns) |
| Module |
Description |
| {Lich::Common::GameObj} |
Game objects (NPCs, items, players) |
| {Lich::Common::Map} |
Map and room navigation |
| Module |
Description |
| {Lich::Gemstone::Bounty} |
Adventurer's Guild bounties |
| {Lich::Gemstone::Society} |
Society membership and abilities |
This documentation is auto-generated from the Lich 5 source code using YARD. The guides are written for players who want to use Lich's features in their scripts.
Documentation generated by lich-5-docs