Lich 5 Documentation
Welcome to the Lich 5 scripting documentation for GemStone IV and DragonRealms.
What is Lich?
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.
Guides
Getting Started
| Guide | Description |
|---|---|
| Scripting Basics | Core concepts for writing Lich scripts |
Character & Combat
| Guide | Description |
|---|---|
| Character Stats | Stats, Skills, and character resources |
| Spells | Working with spells and magic |
| Effects | Active spells, buffs, debuffs, and cooldowns |
| PSM Reference | Combat Maneuvers, Shield skills, Feats, Warcries |
| Societies | Voln, Council of Light, Guardians of Sunfist |
Game World
| Guide | Description |
|---|---|
| Game Data | Rooms, Maps, NPCs, Items, and Players |
| Bounty System | Adventurer’s Guild bounty tasks |
Module Reference
Character
| Module | Description |
|---|---|
| Lich::Common::Char | Character health, mana, stamina |
| Lich::Gemstone::Stats | Character statistics (STR, DEX, etc.) |
| Lich::Gemstone::Skills | Trained skills and ranks |
Combat
| 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 |
Magic
| 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) |
Game World
| Module | Description |
|---|---|
| Lich::Common::GameObj | Game objects (NPCs, items, players) |
| Lich::Common::Map | Map and room navigation |
Systems
| Module | Description |
|---|---|
| Lich::Gemstone::Bounty | Adventurer’s Guild bounties |
| Lich::Gemstone::Society | Society membership and abilities |
Getting Help
-
In-game:
;helpfor Lich commands -
Discord: Join the Lich community
-
GitHub: elanthia-online/lich-5
About This Documentation
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[https://github.com/Nisugi/lich-5-docs]