far-far-west-build

Build planner for Far Far West: plan the hero, weapons, jokers, upgrades and spells of a build, check that it is valid, and see the level and prestiges it needs. Game texts in the game's 15 languages, the planner's own texts in English and French.

Live site: https://fastfire001.github.io/far-far-west-build/

Fan project, not affiliated with Evil Raptor. The icons are the game's own.

Development

Only Docker is required: every command runs in a container.

bin/dev          # dev server: http://localhost:5173/
bin/test         # unit tests (bin/test --watch)
bin/build-site   # type check and static site in web/dist/
bin/web <cmd>    # any command in the Node container, e.g. bin/web npm install <package>

The application (Vue 3 + TypeScript + Vite) is in web/. Every push to main deploys the site to GitHub Pages (.github/workflows/deploy.yml).

Game data

The game data (data/*.json) and the icons (assets/game/icons/) are extracted from the installed game files. Both are committed, so you only need the game to update them after a game update:

cp .env.example .env   # once, then set FFW_GAME_DIR (game install folder)
bin/extract-game

The game is only read; the extracted files stay in .cache/, which is not versioned. data/manual.json is the exception: values that cannot be extracted (spell cooldowns, spell school colours), entered by hand.

Documentation

• docs/game-mechanics.md: game rules used by the planner, where each value comes from, extraction method.
• docs/build-planner.md: design decisions and open questions.
• CLAUDE.md: repository layout and conventions.

Contributions are welcome: see CONTRIBUTING.md.

License

The code, the documentation and the images of assets/ (except assets/game/) are under the MIT License.

The game texts in data/ (item names and descriptions, menu labels and their official translations) and the game's icons in assets/game/ belong to Evil Raptor and are not covered by this license.