NoitaWandTemplate

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

_{Built by NoitaModSDK and contributors}

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

Table of Contents

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

About

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

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

Features

• Basic wand template ready for customization.
• Comprehensive tutorial on how to create and modify wands in Noita.
• Animated wand template available in the "animated_wand" branch.

~~~~~ 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

I recommend using VSCode and Aseprite, as that’s what I use, and they work perfectly! 🙂

• 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/NoitaWandTemplate.git
   

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

2. If you want to work with the animated wand template, you can clone the animated-wand branch:

   git clone -b animated-wand https://github.com/NoitaModSDK/NoitaWandTemplate.git NoitaWandTemplate-Animated
   

   This will create a new folder named NoitaWandTemplate-Animated with the contents of the animated-wand branch.

3. You can edit the project's PNG, XML, and LUA files to customize wand values, graphics, and Lua script actions."

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/NoitaWandTemplate.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 wand creation process.
2. Use the provided template as a base for your custom wand.
3. Modify the scripts/graphics to achieve your desired wand 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 wand code itself is taken directly from 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.
• The fonts "Noita Blackletter" used in images were created by the Reddit user Viowlet. You can download them via this Reddit link: https://www.reddit.com/r/noita/comments/jp56ub/a_while_ago_i_made_noita_blackletter_this_is_now/

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

Tip

I trust you'll find this project enjoyable. Should you appreciate the project, bestowing a small ⭐ on it is a meaningful gesture, signifying: My efforts are recognized. Your support would be greatly valued. Many thanks!