Quick Start

Quick Start Guide

Get VellumFE running in 5 minutes!

1. Download

Get the latest release from GitHub Releases.

Platform	File
Windows	vellum-fe-windows.zip
macOS	vellum-fe-macos.tar.gz
Linux	vellum-fe-linux.tar.gz

2. Connect

Option A: Via Lich (Recommended)

# Start Lich first, then:
vellum-fe --host 127.0.0.1 --port 8000

Option B: Direct eAccess

vellum-fe --direct \
  --account YOUR_ACCOUNT \
  --password YOUR_PASSWORD \
  --game prime \
  --character CHARACTER_NAME

3. Basic Controls

Key	Action
Enter	Send command
↑ / ↓	Command history
Ctrl+L	Clear screen
Ctrl+Q	Quit
Tab	Next window
Shift+Tab	Previous window
PgUp / PgDn	Scroll window
F1	Open menu

4. Configuration Files

Located in your config directory:

~/.config/vellum-fe/          # Linux
~/Library/Application Support/vellum-fe/  # macOS
%APPDATA%\vellum-fe\          # Windows

File	Purpose
config.toml	Main settings
layout.toml	Window layout
keybinds.toml	Key bindings
highlights.toml	Text highlighting
colors.toml	Color theme

5. First Steps

1. Try the menu: Press F1
2. Edit layout: F1 → Layout → Edit Windows
3. Add highlights: F1 → Highlights → Add Pattern
4. Set keybinds: F1 → Keybinds → Add Binding

Next Steps

• Full Documentation
• Keybind Cheatsheet
• Widget Reference