A cross-platform toolset for Neverwinter Nights: Enhanced Edition
  • Rust 97.5%
  • Python 1%
  • Shell 0.6%
  • C 0.5%
  • WGSL 0.3%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-16 11:09:47 +01:00
.claude next-story: one epic at a time, optional epic argument, a loop ends when the epic is done 2026-11-10 20:14:05 +01:00
apps/nwfoundry Every camera uses one light cluster (ClusterConfig::Single): with no lights, Bevy's default cluster grid only cost a header per cluster each frame on the CPU; light_free_clusters(), spec, story, validation 2026-11-08 00:19:49 +01:00
crates Epic 04: Options Spell Checking wired: master toggle (Check Spelling says it is disabled), remember/clear Ignore All and Change All lists between checks (flow::keep_lists, held in the editor state), 'Spelling language' setting (our owner-approved extension, saved as options.spelling.language; NWFOUNDRY_SPELLING_LANGUAGE stays a dev override that wins); auto-check behaviour and F7 parked; driven live in a scratch config 2026-11-16 11:09:47 +01:00
data Render AABB Nodes: surface colours come from data/walkmesh-surface-colors.ini, keyed by surfacemat.2da label 2026-10-19 12:24:49 +02:00
docs Epic 04: Options Spell Checking wired: master toggle (Check Spelling says it is disabled), remember/clear Ignore All and Change All lists between checks (flow::keep_lists, held in the editor state), 'Spelling language' setting (our owner-approved extension, saved as options.spelling.language; NWFOUNDRY_SPELLING_LANGUAGE stays a dev override that wins); auto-check behaviour and F7 parked; driven live in a scratch config 2026-11-16 11:09:47 +01:00
fixtures Epic 04: conversation script parameters (ConditionParams on links, ActionParams on dialogs) read and written as the original saves them (conversation::ScriptParams, Link::params, Dialog::action_params + accessors); layout observed on the original, checked against its own scratch .dlg (fixtures/dlg/params-original.dlg); UI grid still open 2026-11-16 07:57:29 +01:00
tools Automation: go_to_object (queued as a tree row double click); triggers selected by tree / Find Instance path driven live 2026-11-12 15:21:57 +01:00
.gitignore Tests for gff getters, erf editing, emitter properties, creature accessories and levelup reads; quality gate measures coverage with the llvm engine 2026-11-03 18:31:10 +01:00
.mcp.json tools/local-llm: dev-time MCP server for OCR, icon location and an optional local coder (off by default); the coder failed the item-property trial 2026-10-28 19:14:38 +01:00
Cargo.lock Epic 04: Check Spelling slice 3: spellbook engine behind SpellChecker (spelling::engine::HunspellChecker, LoadError for unreadable or malformed dictionaries) and the word tokenizer (inner apostrophes kept, <Tag> and digit tokens skipped); tested with small synthetic dictionaries; original re-observed: the word window cannot be seen in the VM, Options Spell Checking page recorded in the spec 2026-11-16 10:42:06 +01:00
Cargo.toml Epic 04: Check Spelling slice 3: spellbook engine behind SpellChecker (spelling::engine::HunspellChecker, LoadError for unreadable or malformed dictionaries) and the word tokenizer (inner apostrophes kept, <Tag> and digit tokens skipped); tested with small synthetic dictionaries; original re-observed: the word window cannot be seen in the VM, Options Spell Checking page recorded in the spec 2026-11-16 10:42:06 +01:00
CLAUDE.md Epic 04: Options Spell Checking wired: master toggle (Check Spelling says it is disabled), remember/clear Ignore All and Change All lists between checks (flow::keep_lists, held in the editor state), 'Spelling language' setting (our owner-approved extension, saved as options.spelling.language; NWFOUNDRY_SPELLING_LANGUAGE stays a dev override that wins); auto-check behaviour and F7 parked; driven live in a scratch config 2026-11-16 11:09:47 +01:00
clippy.toml Shared dialog scaffold (sync_window, dialog_context, root_ui) replaces the window-system boilerplate copied across 45 dialogs; clippy too_many_lines warn at 150; CLAUDE.md code-reuse rules and docs/architecture/shared-helpers.md catalog 2026-11-03 16:23:10 +01:00
LICENSE Help > About: the original's layout with our own logo, the GPL v3 text and a notice that the licence covers the toolset and not what is made with it 2026-10-25 23:36:36 +01:00
Makefile Light clustering on the CPU by default (Bevy's GPU clustering took 12-18% of the process for lights the project does not have); [Render] Gpu Clustering / NWFOUNDRY_GPU_CLUSTERING bring it back; settings file renamed to <config>/nwfoundry/nwfoundry.ini; Makefile (build, build-automation, release, profile, ALSA stand-in); story, spec, validation 2026-11-07 19:30:51 +01:00
NOTICE Window and app name: Aurora NwN:EE Foundry (lowercase w) 2026-10-30 14:57:01 +01:00
README.md Epic 04: Options Spell Checking wired: master toggle (Check Spelling says it is disabled), remember/clear Ignore All and Change All lists between checks (flow::keep_lists, held in the editor state), 'Spelling language' setting (our owner-approved extension, saved as options.spelling.language; NWFOUNDRY_SPELLING_LANGUAGE stays a dev override that wins); auto-check behaviour and F7 parked; driven live in a scratch config 2026-11-16 11:09:47 +01:00

Aurora NwN:EE Foundry

Open-source, cross-platform reimplementation of BioWare's Aurora Toolset, targeting Neverwinter Nights: Enhanced Edition.

Status: pre-alpha, under active development. Not usable for real work yet: features land epic by epic and file formats, UI and behaviour may change without notice. Do not point it at modules you cannot afford to lose.

Phase 1 — 1:1 feature parity with the original toolset.
Phase 2 (scope TBD) — extend beyond it (e.g. support for scripting languages other than NWScript).

Progress

Where the work stands, per epic of the backlog. Regenerate with python3 tools/backlog-progress.py (--check verifies it is current); update it in the same change as the story checklists.

Epic Stories Criteria done Progress
00-toolset-shell Toolset shell 17 78 / 106 ███████░░░ 74%
01-module Module 4 20 / 25 ████████░░ 80%
02-areas Areas 21 107 / 129 ████████░░ 83%
03-creatures Creatures 16 128 / 128 ██████████ 100%
04-conversations Conversations 2 38 / 47 ████████░░ 81%
05-journal Journal 0 not started ░░░░░░░░░░
06-items Items 6 32 / 32 ██████████ 100%
07-placeables Placeables 2 4 / 16 ██░░░░░░░░ 25%
08-doors Doors 3 58 / 59 ██████████ 98%
09-encounters Encounters 0 not started ░░░░░░░░░░
10-sounds Sounds 0 not started ░░░░░░░░░░
11-triggers Triggers 7 66 / 66 ██████████ 100%
12-waypoints Waypoints 4 67 / 67 ██████████ 100%
13-merchants Merchants 1 8 / 9 █████████░ 89%
14-script-editor Script editor 0 not started ░░░░░░░░░░
15-2da-tlk-editors 2da tlk editors 0 not started ░░░░░░░░░░
16-palette-blueprints Palette blueprints 0 not started ░░░░░░░░░░
17-find-undo-validation Find undo validation 4 16 / 19 ████████░░ 84%
18-build-compile-nwsync Build compile nwsync 0 not started ░░░░░░░░░░
19-automation Automation 14 8 / 17 █████░░░░░ 47%
20-pipelines Pipelines 0 not started ░░░░░░░░░░
21-final-cleanup Final cleanup 1 0 / 3 ░░░░░░░░░░ 0%
Written so far 630 / 723 █████████░ 87%

Percentages count the criteria of the stories written so far; an epic's stories are written as the epic is taken up, so a high figure on a small epic is not a share of the whole toolset.

Requirements

  • Rust (latest stable)
  • A legitimately-owned NWN:EE install to run the toolset against (the build itself does not need the game).

Build

cargo build --release

The compiled binary is nwfoundry (package nwfoundry, in apps/nwfoundry).

Workspace layout

Crate Role
crates/aurora-formats BioWare/Aurora file format layer (GFF, ERF, KEY/BIF, 2DA, TLK, …)
crates/aurora-render 3D viewport and tile-grid rendering (Bevy)
crates/aurora-ui Shared egui widgets; main window chrome and OS-level dialogs
apps/nwfoundry Binary — wires the three crates together
tools/icons Generator for the project's own icons

License

GPL-3.0-only — see LICENSE.

This is not an arbitrary choice: the project depends on nwnrs-types (GPL-3.0-only), so the combined work must be GPL-3.0-compatible.