mirror/WoWee
1
0
Fork 0
mirror of https://github.com/Kelsidavis/WoWee.git synced 2026-05-24 16:51:51 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: remove vaporware FSR2 startup-safety; fix Turtle WoW version

Browse Source 
- docs/AMD_FSR2_INTEGRATION.md: removed 'Startup safety behavior'
  bullets — WOWEE_ALLOW_STARTUP_FSR2 has zero references in src/,
  include/, CMakeLists.txt, or any build script; the IN_WORLD-deferred
  FSR2 logic does not exist. Documenting a knob that nothing reads
  misleads users.
- README.md / docs/status.md / docs/server-setup.md / GETTING_STARTED.md:
  Turtle WoW version was 1.17 in four places, but
  Data/expansions/turtle/expansion.json declares major=1 minor=18
  (build 7234). Sync docs to the canonical config.
- docs/status.md: 'Last updated' bumped from 2026-04-14 to 2026-05-14
  to reflect the v1.9.1-preview-era body that has already replaced the
  v1.8.9 snapshot.
This commit is contained in:
Kelsi
2026-05-14 23:45:40 -07:00
parent 617fe0e907
commit dd552fa32e
5 changed files with 5 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
GETTING_STARTED.md
View File

@@ -185,7 +185,7 @@ Pick the expansion from the realm/auth screen at launch — the selection is wir
- **AzerothCore** - Full support, recommended for learning
- **TrinityCore** - Full support, extensive customization
- **Mangos** - Full support, solid foundation
- **Turtle WoW** - Full support, 1.17 custom content
- **Turtle WoW** - Full support, 1.18 custom content
### Server Requirements
- Must support Vanilla, TBC, or WotLK protocol

2
README.md
View File

@@ -22,7 +22,7 @@ Protocol Compatible with **Vanilla (Classic) 1.12 + TBC 2.4.3 + WotLK 3.3.5a**.
## Status & Direction (2026-05-13)
- **Compatibility**: **Vanilla (Classic) 1.12 + TBC 2.4.3 + WotLK 3.3.5a** are all supported via expansion profiles and per-expansion packet parsers. All three expansions are roughly on par.
- **Tested against**: AzerothCore/ChromieCraft, TrinityCore, Mangos, and Turtle WoW (1.17).
- **Tested against**: AzerothCore/ChromieCraft, TrinityCore, Mangos, and Turtle WoW (1.18).
- **Current focus**: stability hardening after a large god-object decomposition pass — chasing down behavioral regressions that crept in during the refactor (NPC/UI hitboxes, packet handlers, periodic-spam guards, optimistic-state syncs).
- **Warden**: Full module execution via Unicorn Engine CPU emulation. Decrypts (RC4→RSA→zlib), parses and relocates the PE module, executes via x86 emulation with Windows API interception. Module cache at `~/.local/share/wowee/warden_cache/`.
- **CI**: GitHub Actions builds for Linux (x86-64, ARM64), Windows (MSYS2 x86-64 + ARM64), and macOS (ARM64). Security scans via CodeQL, Semgrep, and sanitizers. 31 unit-test suites covering protocol parsers, animation FSMs, world-map state, chat markup, macro evaluator, and editor units.

3
docs/AMD_FSR2_INTEGRATION.md
View File

@@ -54,9 +54,6 @@ Runtime note:
- UI displays active backend in settings (`AMD FidelityFX SDK` or `Internal fallback`).
- Runtime settings include persisted FSR2 jitter tuning.
- FidelityFX-SDK extern is fetched across platforms (default: `Kelsidavis/FidelityFX-SDK` on `main`).
- Startup safety behavior remains enabled:
- persisted FSR2 is deferred until `IN_WORLD`
- startup falls back unless `WOWEE_ALLOW_STARTUP_FSR2=1`
## FSR Defaults

2
docs/server-setup.md
View File

@@ -614,4 +614,4 @@ Once you have a working local server connection:
**Status**: Ready for local server testing
**Last Updated**: 2026-03-30
**Client Version**: v1.9.1-preview
**Server Compatibility**: Vanilla 1.12, TBC 2.4.3, WotLK 3.3.5a (12340), Turtle WoW 1.17
**Server Compatibility**: Vanilla 1.12, TBC 2.4.3, WotLK 3.3.5a (12340), Turtle WoW 1.18

4
docs/status.md
View File

@@ -1,6 +1,6 @@
# Project Status
**Last updated**: 2026-04-14
**Last updated**: 2026-05-14
## What This Repo Is
@@ -33,7 +33,7 @@ Implemented (working in normal use):
- Audio: ambient, movement, combat, spell, and UI sound systems; NPC voice lines for all playable races (greeting/farewell/vendor/pissed/aggro/flee)
- Bag UI: independent bag windows (any bag closable independently), open-bag indicator on bag bar, server-synced bag sort, off-screen position reset, optional collapse-empty mode in aggregate view
- DBC auto-detection: CharSections.dbc field layout auto-detected at runtime (handles stock WotLK vs HD-textured clients)
- Multi-expansion: Classic/Vanilla, TBC, WotLK, and Turtle WoW (1.17) protocol and asset variants
- Multi-expansion: Classic/Vanilla, TBC, WotLK, and Turtle WoW (1.18) protocol and asset variants
- CI: GitHub Actions for Linux (x86-64, ARM64), Windows (MSYS2 x86-64 + ARM64), macOS (ARM64); container builds via Podman
Recent refactors (PRs #59-63, April 2026):