Skip to main content

​
Lich 5

A GTK3 scripting framework for DragonRealms and Gemstone IV

Get StartedAPI Reference

​
Key Features

Ruby Scripting Engine

Write powerful scripts in Ruby to automate gameplay and enhance your experience

XML Stream Parsing

Real-time parsing of game data streams for accurate state tracking

GTK3 Interface

Modern graphical interface with GTK3 support for enhanced usability

Multi-Frontend Proxy

Acts as a proxy between game servers and your chosen front-end client

Hook System

Upstream and downstream hooks for extending functionality

Game-Specific Modules

Specialized support for Gemstone IV and DragonRealms

​
Quick Start

1

Install Lich 5

Follow the installation guide for your operating system to get Lich 5 running
# See full installation instructions
2

Write Your First Script

Create a simple script using Lich’s Ruby API
# hello.lic
echo "Hello from Lich!"
3

Run the Script

Launch your script from within the game
;hello

Script Development

Learn how to write scripts that automate tasks and enhance gameplay

Game State Tracking

Access real-time game state through GameObj and XMLData

Settings Management

Manage per-character and per-game settings for your scripts

Advanced Automation

Create sophisticated multi-threaded automation scripts

​
Community and Support

GitHub Repository

Visit the GitHub repository for source code, issues, and contributions

Build docs developers (and LLMs) love

Get started for freeTalk to us