Skip to main content

​
Installation

FG Character Extractor is easy to install on any platform. Choose the method that works best for you.

​
Prerequisites

If you’re using pre-built binaries, you don’t need Go installed. For building from source, you’ll need Go 1.25.7 or later.
1

Verify Go Installation (Optional)

If you plan to build from source, verify your Go installation:
go version
You should see output like go version go1.25.7 darwin/arm64 or similar. If you need to install Go, visit go.dev/dl.

​
Installation Methods

# Install directly from source using Go
go install github.com/sdelrio/fg-char-extract@latest

# Verify installation by running without arguments (uses db.xml in current dir)
fg-char-extract

​
Platform-Specific Instructions

​
macOS

1

Install Using Go

The easiest method is using go install:
go install github.com/sdelrio/fg-char-extract@latest
2

Or Download Pre-built Binary

Choose the correct architecture for your Mac:Apple Silicon (M1/M2/M3):
curl -LO https://github.com/sdelrio/fg-char-extract/releases/latest/download/fg-char-extract-darwin-arm64
chmod +x fg-char-extract-darwin-arm64
sudo mv fg-char-extract-darwin-arm64 /usr/local/bin/fg-char-extract
Intel Macs:
curl -LO https://github.com/sdelrio/fg-char-extract/releases/latest/download/fg-char-extract-darwin-amd64
chmod +x fg-char-extract-darwin-amd64
sudo mv fg-char-extract-darwin-amd64 /usr/local/bin/fg-char-extract
3

Verify Installation

Run the tool to verify it’s installed:
fg-char-extract
You should see an error about missing db.xml if run in an empty directory, which confirms the tool is working.
On macOS, you may see a security warning when first running the binary. Go to System Preferences > Security & Privacy and click “Allow Anyway”.

​
Windows

1

Download Windows Binary

Download the Windows executable from GitHub Releases:
# Using PowerShell
Invoke-WebRequest -Uri "https://github.com/sdelrio/fg-char-extract/releases/latest/download/fg-char-extract-windows-amd64.exe" -OutFile "fg-char-extract.exe"
2

Add to PATH (Optional)

Move the executable to a directory in your PATH, such as C:\Program Files\FGCharExtract\, and add that directory to your system PATH.Or simply run it from the download directory.
3

Verify Installation

Run the tool to verify it’s working:
.\fg-char-extract.exe
You should see an error about missing db.xml if run in an empty directory, which confirms the tool is working.

​
Linux

1

Install Using Go

go install github.com/sdelrio/fg-char-extract@latest

# Ensure ~/go/bin is in your PATH
export PATH=$PATH:~/go/bin
2

Build from Source

Pre-built Linux binaries are not currently available. Build from source:
git clone https://github.com/sdelrio/fg-char-extract.git
cd fg-char-extract
go build -o fg-char-extract main.go
sudo mv fg-char-extract /usr/local/bin/
3

Verify Installation

Run the tool to verify it’s installed correctly:
fg-char-extract
You should see an error about missing db.xml if run in an empty directory, which confirms the tool is working.

​
Building from Source with Task

For advanced users, the project includes a Taskfile.yml for task automation:
1

Install Task

Follow instructions at taskfile.dev or:
# macOS
brew install go-task

# Linux
sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b /usr/local/bin
2

Clone and Build

git clone https://github.com/sdelrio/fg-char-extract.git
cd fg-char-extract

# Build for current platform
task build

# Or build for all platforms (macOS x86_64, macOS arm64, Windows x86_64)
task build-all
Binaries will be created in the dist/ directory.
3

Run Tests

task test

​
Using Devbox (Development)

If you’re contributing to the project or want a reproducible development environment: 
# Install Devbox
curl -fsSL https://get.jetpack.io/devbox/install.sh | bash

# Clone and enter the environment
git clone https://github.com/sdelrio/fg-char-extract.git
cd fg-char-extract
devbox shell

# Build using Task
task build
Devbox ensures you have the exact Go version (1.25.7) and environment variables configured correctly.

​
Verify Installation

Regardless of your installation method, verify everything works:
1

Check Tool is Available

Run the tool without arguments:
fg-char-extract
You should see an error about missing db.xml if run in an empty directory, which confirms the tool is in your PATH and working.
2

Test with Sample File

If you have a Fantasy Grounds db.xml file handy, try a quick extraction:
fg-char-extract /path/to/db.xml

​
Troubleshooting

​
Command Not Found

If you get a “command not found” error:
  1. Check your PATH: Ensure ~/go/bin (for go install) or your installation directory is in your PATH
  2. Use full path: Try running with the full path to the binary
  3. Check permissions: Ensure the binary is executable (chmod +x)

​
Permission Denied

On macOS or Linux, if you get permission errors: 
chmod +x fg-char-extract

​
Go Version Mismatch

If building from source with an older Go version, you may see errors. Upgrade to Go 1.25.7 or later: 
# Check current version
go version

# Update Go from go.dev/dl

​
Next Steps

Now that you have FG Character Extractor installed, let’s extract your first character!

Quickstart Guide

Extract your first character in 2 minutes

Build docs developers (and LLMs) love

Get started for freeTalk to us