Documentation
WokGen Docs
How to install, run, and contribute to WokGen.
Overview
WokGen is a command-line and web-based asset generation toolkit primarily targeting pixel art for games. It wraps AI generation models with structured prompting, batching, and export pipelines. Everything is logged so your asset history is auditable.
Status: early development. Core pipeline works. UI and additional exporters are in progress.
Installation
git clone https://github.com/WokSpec/WokGen cd WokGen npm install
Node.js 18+ is required.
Quick start
# Start the local UI server npm start # Or run a generation from CLI npm run gen:cpu -- --prompt "32x32 pixel knight sprite" --count 4
The web UI will be available at http://localhost:3100.
Configuration
Configuration lives in .env. Copy .env.example to get started.
| Variable | Description |
|---|---|
| PORT | UI server port (default: 3100) |
| MODEL_PATH | Path to local model weights |
| EXPORT_DIR | Output directory for generated assets |
| LOG_LEVEL | info | debug | warn | error |
Architecture
WokGen is structured as a monolith with the following layers:
- Generator coreWraps AI model inference, handles prompts and seeds
- Pipeline runnerOrchestrates batches, retries, and post-processing
- Export engineConverts raw outputs to target formats (PNG spritesheet, JSON manifest, etc.)
- Audit logSQLite database recording every generation with its parameters
- Web UIExpress + React local interface for browsing assets and running jobs
Contributing
Read the CONTRIBUTING.md in the repo for setup instructions and contribution guidelines.