A modern, multi-frontend client for GemStone IV — play in the terminal, in a native desktop GUI, or from your phone.
One core, four ways to play:
- Terminal (TUI) — the classic experience, built on Ratatui
- Desktop GUI — native egui app with a Wrayth-style look, graphics skins, and in-app editors for every setting
- Mobile Web — the desktop client (or headless mode) serves a phone-friendly web UI; your phone becomes a second screen or a full client
- Android / iOS apps — the core and web UI bundled into native mobile apps
- Customizable widget system — progress bars, countdowns, compass, hands, injury doll, active effects, targets, players, inventory, spells, room window, and more
- Maps and native travel — in-client map rendering with click/tap-to-travel and a native
.go2pathfinding engine - Tabbed text windows and stream routing — route any game stream to any window, with in-app stream pickers on every frontend
- Highlight system — regex-based highlighting with Aho-Corasick fast matching, plus sound alerts
- Hotkey bars — command buttons with condition-driven styling and cooldown countdowns
- Text-to-speech accessibility — per-window speech, voice/rate control, gag and pronunciation rules, on desktop and phone
- Fully themeable — color themes plus optional GUI graphics skins; everything editable in-app, no config-file hand-editing required
- Lich integration — connect through Lich (including its WebUI panels rendered natively in the GUI) or skip it entirely
- Direct eAccess authentication — connect straight to GemStone IV with no proxy
# Start Lich with your character, then:
vellum-fe --port 8000 --character YourCharacter
# Or launch the desktop GUI:
vellum-fe --frontend gui --port 8000 --character YourCharactervellum-fe --direct \
--account YOUR_ACCOUNT \
--password YOUR_PASSWORD \
--game prime \
--character CHARACTER_NAMEDownload from Releases.
git clone https://github.com/Nisugi/VellumFE.git
cd VellumFE
cargo build --releaseRequirements:
- Rust stable
- No TLS setup needed: Windows/macOS use the OS-native stack; Linux builds a bundled OpenSSL automatically (requires Perl, preinstalled on virtually all distros)
Full Documentation — guides, tutorials, and reference
Quick links:
Settings live in TOML files under ~/.vellum-fe/, but you rarely need to touch them — every setting has an in-app editor (GUI settings panels, TUI editors and dot-commands). Saves are atomic with automatic backups.
~/.vellum-fe/
├── config.toml # Main configuration
├── layout.toml # Widget layout
├── keybinds.toml # Key bindings
├── highlights.toml # Text highlighting rules
├── colors.toml # Theme colors
├── hotbars.toml # Hotkey bars
└── macros.toml # Macros
┌─────────────────────────────────────────────────────────┐
│ Network Layer │
│ (Lich Proxy / Direct eAccess / WebUI) │
└─────────────────────┬───────────────────────────────────┘
│
┌─────────────────────▼───────────────────────────────────┐
│ Parser (XML) │
│ Wrayth Protocol Handler │
└─────────────────────┬───────────────────────────────────┘
│
┌─────────────────────▼───────────────────────────────────┐
│ Core (AppCore) │
│ State Management & Message Processing │
└──────┬───────────────┬───────────────┬──────────────────┘
│ │ │
┌──────▼──────┐ ┌──────▼──────┐ ┌──────▼──────────────────┐
│ TUI │ │ Desktop GUI │ │ Web Server │
│ (Ratatui) │ │ (egui) │ │ (phone / Android / iOS) │
└─────────────┘ └─────────────┘ └─────────────────────────┘
Join the VellumFE Discord — help and setup questions, layout/skin/wheel showcases, accessibility and controller talk, beta testing, and release announcements.
Contributions welcome! See CONTRIBUTING.md for development setup and contribution licensing terms.
# Run tests
cargo test
# Run with logging
RUST_LOG=debug cargo run -- --port 8000Copyright © 2026 Nisugi
Licensed under the GNU General Public License v3.0 or later (LICENSE). You may use, modify, and redistribute VellumFE freely; any distributed version, modified or not, must remain under the same license with source code available.
Windows releases are signed with a certificate provided by the SignPath Foundation, with free code signing provided by SignPath.io.
- Team roles: Nisugi is the project author, reviewer, and release approver.
- Signing process: binaries are built from this repository's source by GitHub Actions (beta-release.yml); each release is manually approved for signing by the approver.
- Privacy: this program will not transfer any information to other networked systems unless specifically requested by the user or the person installing or operating it. See the privacy policy.
- Built with Ratatui and egui
- Inspired by ProfanityFE and Wrayth
- Thanks to the Lich community