NOITA SPELL ROOM (noita_spelltest)
===================================

A spell test room built on a GPU (Vulkan) rebuild of Noita's engine: a big brick hall in endless
rock with three training dummies, where every wand can be edited and any spell spawned. It runs
the game's own files (data.wak: spells, sprites, Lua scripts) and the game's own sound, so you
need the official Noita from Steam installed. Nothing of the game is included in this package.


WHAT IT IS FOR
--------------
The goal is to find where this rebuild differs from the real game. Please report:
  - inconsistencies: a spell or a wand that behaves, looks or damages differently than in
    Noita (compare with the same wand in the game when you can),
  - lag wands: wands that make the frame rate drop (F10 writes a performance report).

Record the problem as a GIF (F9 saves the last 20 seconds, F11 cuts a clip) and post it, with
the wand's spells and what you expected, on:

    https://noitagpu.zep.best/


REQUIREMENTS
------------
- Windows 10 or 11, 64-bit.
- A GPU with a Vulkan 1.1 driver (any recent NVIDIA / AMD / Intel driver).
- Noita installed from Steam (it gives data.wak and the FMOD sound libraries).


INSTALL
-------
Unzip the folder anywhere. The easiest place is inside the Noita install folder, for example:

    C:\Program Files (x86)\Steam\steamapps\common\Noita\noita_spelltest\

Then start noita_spelltest.exe.

Where it looks for the game's data.wak (the first one found wins):
  1. the path given on the command line (or a data.wak dragged onto noita_spelltest.exe),
  2. next to the exe, or in data\ next to it, or in the folders above it (..\data\data.wak:
     the place inside the Noita folder above),
  3. the Noita folder of every Steam library (read from Steam's registry entry and
     steamapps\libraryfolders.vdf).

If it is not found, start it with the path, for example from a command prompt:

    noita_spelltest.exe "D:\SteamLibrary\steamapps\common\Noita\data\data.wak"


SOUND
-----
audio_host.exe plays the game's sounds with the FMOD libraries of your Noita install
(fmod.dll and fmodstudio.dll in the Noita folder, the banks in Noita\data\audio\Desktop). They are
loaded from there at run time and are never copied. The Noita folder is the one above the data
folder of the data.wak in use. If they are not found, the room runs without sound.


YOUR SAVE AND MODS
------------------
- Your Noita profile (AppData\LocalLow\Nolla_Games_Noita\save00) is only read, never written:
  the persistent flags decide which spells are unlocked, as in the game. Its own files go to the
  save\ folder next to the exe.
- The local mods (Noita\mods) enabled in your Noita mod list are loaded. Steam Workshop mods
  are not.


CONTROLS
--------
F1 shows all controls in the game. The main ones:
  A / D, W / Space      walk, jump (hold in the air to levitate)
  mouse, LMB            aim, fire
  Tab or I              inventory: drag spells into and out of the wands
  C                     spell panel: type to filter, click a spell to spawn it
  M                     wand maker: stats, deck and always-cast spells of a new wand
  K                     a new empty test wand
  E                     pick up,  Q drop,  RMB throw
  F9                    save the last 20 s as PNGs and a GIF (clips\ folder)
  F11                   clip editor: cut and save a GIF
  F10                   performance report (perf\ folder)
  P                     pause,  Esc quit

Above each dummy: its hp, the total of the last burst and the damage per second. A dead dummy
comes back after 2 seconds.


FILES
-----
  noita_spelltest.exe      the program
  *.spv                    its GPU shaders (must stay next to the exe)
  audio_host.exe           the sound helper (32-bit, loads the game's FMOD)
  msvcp140*.dll, vcruntime140*.dll
                           the Microsoft C++ runtime (redistributable)
  README.txt               this file

This is a fan project, not made or supported by Nolla Games. Noita and its data belong to
Nolla Games.
