NoitaPerkTemplate

About | Requirements | Installation | Usage | References | Contributing | License

_{Built by NoitaModSDK contributors}

🧙‍♂️ A tutorial and template for creating custom perks in Noita.

Table of Contents

• About
• Requirements
• Installation
• Usage
• References
• Contributing
• License

About

NoitaPerkTemplate is a project aimed at helping Noita modders create their own custom perks. It provides a basic template and tutorial that you can use as a starting point for your perk creation process.

~~~~~ back to top ~~~~~

Features

• Basic perk template ready for customization.
• Comprehensive tutorial on how to create and modify perks in Noita.
• Example custom perk implementation.

~~~~~ back to top ~~~~~

Requirements

• All the tools you need to get started are:

1. A good text editor (e.g., VSCode, Notepad++, Sublime Text, Vim)
2. A reliable image editor (e.g., Aseprite, GIMP, Paint.net, Photoshop)

Tip

We recommend using VSCode and Aseprite, as they work perfectly for this kind of modding! 🙂

• First of all, if you want to create a mod for the game Noita, you'll need to start by extracting the game's data files by following the procedure outlined at this link: https://noita.fandom.com/wiki/Modding#Getting_Started

~~~~~ back to top ~~~~~

Installation

Cloning the project (code only)

1. Clone this repository directly into your Noita/mods/ folder:

git clone https://github.com/NoitaModSDK/NoitaPerkTemplate.git

Note

the steamapps/workshop/content/881100/ folder is not recommended as it is intended for mods downloaded from the Steam Workshop.

2. You can edit the project's PNG, LUA, and XML files to customize perk values, graphics, and behaviors.

Cloning the documentation (Wiki)

If you want to have a local copy of the documentation:

1. Clone the Wiki repository:

git clone https://github.com/NoitaModSDK/NoitaPerkTemplate.wiki.git

This will give you a local copy of all the Wiki pages that you can browse offline.

~~~~~ back to top ~~~~~

Usage

1. Study the tutorial in our Wiki to understand the perk creation process.
2. Use the provided template as a base for your custom perk.
3. Modify the scripts and graphics to achieve your desired perk behavior and appearance.

~~~~~ back to top ~~~~~

References

• The modding section of the Noita wiki, available here: https://noita.fandom.com/wiki/Modding

~~~~~ back to top ~~~~~

Contributing

We welcome your contributions to improve the tutorial or template.

To contribute:

1. Fork the repository.
2. Create a new branch: git checkout -b [branch-name].
3. Make your changes and commit them: git commit -m '[commit-message]'.
4. Push to the original branch: git push origin [project-name]/[location].
5. Create the pull request.

~~~~~ back to top ~~~~~

License

The tutorial text in this project is released under the MIT license © NoitaModSDK.

Note: The perk code itself is based on the game files and is not covered under this license. All rights for the game code belong to the original creators of Noita.

~~~~~ back to top ~~~~~

Disclaimer

• This project is a fan-made tool and is not officially associated with or endorsed by © Nolla Games, the creators of Noita.

~~~~~ back to top ~~~~~