Changes: Modding

Revision as of 02:53, 3 February 2021

Modding Pages
Getting started • Basics • Lua Scripting • Data.wak • Useful Tools
Audio • Enemies • Environments • Perks • Spells • Spritesheets • Materials • Image Emitters
Lua API • Enums • Special Tags • List of all tags • Utility Scripts • Sound Events • Enemy Information Table • Spell and Perk IDs

Notice: This page is written for aspiring modders. For installing mods, see the page How to install mods.

Modding Noita is quite straightforward and fun, but can still hide many implementation details in itself. These pages hope to lower the barrier of entry and address any common pitfalls.

All the tools you need to get started are:

a proper text editor (eg. VSCode, Notepad++, Sublime, Vim)
a proper image editor (eg. Aseprite, Gimp, Paint.net, Photoshop)

Noita gameplay logic is mostly implemented in Lua and XML, as an Entity Component system (ECS). Every separate "thing" in the game (enemies, bullets, wands, items, even the player) are just entities, composed of different components. A good understanding of Lua is recommended, but a lot can be done without any programming knowledge at all, simply by editing the entity XMLs or associated spritesheets.

Getting Started

First step before moving on, is to find the Noita base folder (most likely in C:\Program Files (x86)\Steam\steamapps\common\Noita) then go and read the tools_modding\READ_ME_FIRST.txt.

Extracting data files

All of Noita's base assets (spritesheets, scripts, entity definitions) are packed inside Noita\data\data.wak. It is not technically required to have these extracted, but seeing the file structure and any example code is immensely helpful.

On Windows

To access Noita's data files, do the following:

Copy all of the files inside of the tools_modding\ folder into Noita's root folder.
Run data_wak_unpack.bat. A terminal window should open.
A File Explorer window opened to Noita's resources should appear: (%UserProfile%\AppData\LocalLow\Nolla_Games_Noita).
Bookmark or copy this folder somewhere for easy later access.
Many of the resources might be hidden. Click the "View" button and check "Hidden items" to see all them.

Now you have plain access to all of Noita's Lua code, entity XML definitions and spritesheets. You can now literally go and check out any gameplay secrets, so keep a spoiler alert in mind aswell.

On Linux

Start Noita on Steam, once, using -wizard_unpak as a launch parameter. (I.e. Right-click, Properties, General, Launch options)
This will extract the data files into .steam/steam/steamapps/compatdata/881100/pfx/drive_c/users/steamuser/AppData/LocalLow/Nolla_Games_Noita/
Remove the launch parameter again.
Bookmark or copy this folder somewhere for easy later access.

Next steps

Good starting points and further reading:

Go through Modding basics, debugging & best practices
Make a copy of the mod mods\example and make some changes to it, familiarize yourself with the file structure.
Familiarize yourself with the documentation under tools_modding\:
- component_documentation.txt
- lua_api_documentation.txt
- These are always the most up-to-date documentation you can find. They are your best friends now.
Download and see what other modders have done, edit their mods, get a feeling for what is going on.
- https://modworkshop.net/game/noita
- https://steamcommunity.com/workshop/browse/?appid=881100&

Need help?

Noita Discord server has an active and friendly modding community on #modding-general and #modding-support. Don't be afraid to join and ask questions!

@@ Line 1: / Line 1: @@
+{{Modding Navigation}}
+'''Notice: This page is written for aspiring modders. For installing mods, see the page [[How to install mods]].'''
 Modding Noita is quite straightforward and '''''fun''''', but can still hide many implementation details in itself. These pages hope to lower the barrier of entry and address any common pitfalls.
@@ Line 10: / Line 15: @@
 First step before moving on, is to find the Noita base folder (most likely in  <code>C:\Program Files (x86)\Steam\steamapps\common\Noita</code>) then go and read the <code>tools_modding\READ_ME_FIRST.txt</code>.
-<br />
 === Extracting data files ===
-All of Noita's base assets (spritesheets, scripts, entity definitions) are packed inside <code>Noita\data\data.wak</code>. It is not ''technically required'' to have these extracted, but seeing the file structure and any example code is immensely helpful.
+All of Noita's base assets (spritesheets, scripts, entity definitions) are packed inside <code>[[Data.wak|Noita\data\data.wak]]</code>. It is not ''technically required'' to have these extracted, but seeing the file structure and any example code is immensely helpful.
+==== On Windows ====
 To access Noita's data files, do the following:
-# Copy all of the files inside of the <code>tools_modding</code> folder into Noita's root folder.
+# Copy all of the files inside of the <code>tools_modding\</code> folder into Noita's root folder.
 # Run <code>data_wak_unpack.bat</code>. A terminal window should open.
 # A File Explorer window opened to Noita's resources should appear: (<code>%UserProfile%\AppData\LocalLow\Nolla_Games_Noita</code>).
@@ Line 24: / Line 28: @@
 #<small>Many of the resources might be hidden. Click the "View" button and check "Hidden items" to see all them.</small>
-Now you have plain access to all of Noita's Lua code, entity XML definitions and spritesheets. You can now literally go and check out any gameplay secrets, so a keep a spoiler alert in mind aswell.
+Now you have plain access to all of Noita's Lua code, entity XML definitions and spritesheets. You can now literally go and check out any gameplay secrets, so keep a spoiler alert in mind aswell.
+==== On Linux ====
+# Start Noita on Steam, once, using  <code>-wizard_unpak</code> as a launch parameter. (I.e. Right-click, Properties, General, Launch options)
+# This will extract the data files into <code>.steam/steam/steamapps/compatdata/881100/pfx/drive_c/users/steamuser/AppData/LocalLow/Nolla_Games_Noita/</code>
+# Remove the launch parameter again.
+# Bookmark or copy this folder somewhere for easy later access.
-<br />
 === Next steps ===
 Good starting points and further reading:
+* Go through [[Modding: Basics|Modding basics, debugging & best practices]]
-* Make a copy of the mod <code>mods\example</code> and make some changes to it, familiarize yourself with the file structure.
+*Make a copy of the mod <code>mods\example</code> and make some changes to it, familiarize yourself with the file structure.
-* Familiarize yourself with the documentation under <code>tools_modding:</code>
+* Familiarize yourself with the '''documentation''' under <code>tools_modding\</code>:
-** <code>component_documentation.txt</code>
+**<code>component_documentation.txt</code>
 ** <code>lua_api_documentation.txt</code>
 ** These are always the most up-to-date documentation you can find. They are your best friends now.
 *Download and see what other modders have done, edit their mods, get a feeling for what is going on.
 **https://modworkshop.net/game/noita
+**https://steamcommunity.com/workshop/browse/?appid=881100&
+== Need help? ==
-<br />
+[https://discord.gg/SZtrP2r Noita Discord server] has an active and friendly modding community on <code>#modding-general</code> and <code>#modding-support</code>. Don't be afraid to join and ask questions!
-=== Diving deeper [WIP] ===
-* [[Modding basics|Modding basics, paths & best practices]]
-* [[Modding: Making a custom wand]]
-** For now you can start with [https://github.com/TheHorscht/EZWand this awesome helper (by Horscht)]
-* [[Modding: Making a custom enemy]]
-* [[Modding: Sounds]]
-* [[Modding: Making a custom environment]]
-** [https://gist.github.com/TheHorscht/1befe590a5777d82cbcfab01dd397a4a Great guide to biomes (by Horscht)]
-** [https://thehorscht.github.io/NoitaWangTiler/ Test how your wang tiles will look like (by Horscht)]
-== Help with modding ==
-[https://discord.gg/SZtrP2r Noita Discord server] has an active and friendly modding community on #modding-general and #modding-support. Don't be afraid to ask questions!
 == Related ==
 * [[How to install mods]]
+*[[data.wak]]
-==Other resources==
-*[[ID|List of spell and perk IDs]]
-*[[:Category:Lua global functions|List of Lua global functions]]
-*[[Enemy Information Table|Enemy Information Table with ID listing]]
 [[Category:Modding]]