m (Remove most extra space) Tag: Visual edit |
(Move "diving deeper" into a bigger heading and add link to utilities) Tag: Visual edit |
||
Line 34: | Line 34: | ||
**https://modworkshop.net/game/noita |
**https://modworkshop.net/game/noita |
||
− | + | == Modding guides & topics == |
|
*[[Modding: Basics|Modding basics, debugging & best practices]] |
*[[Modding: Basics|Modding basics, debugging & best practices]] |
||
Line 49: | Line 49: | ||
**[https://thehorscht.github.io/NoitaWangTiler/ Test how your wang tiles will look like (by Horscht)] |
**[https://thehorscht.github.io/NoitaWangTiler/ Test how your wang tiles will look like (by Horscht)] |
||
*[[Modding: Audio|Customizing sounds]] |
*[[Modding: Audio|Customizing sounds]] |
||
+ | *[[Modding: Utilities|Collection of utility scripts]] |
||
== Help with modding == |
== Help with modding == |
Revision as of 06:50, 30 June 2020
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.
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 a keep a spoiler alert in mind aswell.
Next steps
Good starting points and further reading:
- 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.
Modding guides & topics
- Modding basics, debugging & best practices
- Making a custom spritesheet
- Making a custom spell
- Making a custom perk
- Making a custom status effect
- Making a custom material
- Making a custom enemy
- Making a custom wand
- For now you can start with this awesome helper (by Horscht)
- Making a custom environment
- Customizing sounds
- Collection of utility scripts
Help with modding
Noita Discord server has an active and friendly modding community on #modding-general and #modding-support. Don't be afraid to ask questions!