Folder Structure

Mod folders need to adhere to a strict structure to ensure all data is loaded properly. If this list is unclear, see the Core mod for reference. The paths are as follows:

• Axu
  • StreamingAssets
    • Mods
      • ModName (Your mod)
        • ModSettings.txt (1)
        • Art (2)
        • Dialogue (3)
        • Entities (4)
        • Items (5)
        • Lua (6)
        • Maps (7)
        • Quests.json (8)

1. ModSettings.txt - Required for all mods. It contains data on the mod's name, ID, load order, creator, and description. All other files are optional.
2. Art folder - This folder contains all the art for your mod. It is separated into several folders:
   • Abilities (Ability icons that display on the ability hotbar.)
   • NPCs (Sprites for NPC characters.)
   • Objects (Contains all sprites for objects on the map. It has a sub-folder containing all item sprites as well.)
   • Player (Contains sprites that are displayed on the player character. Has sub-folders for each layer.)
3. Dialogue folder - Contains all dialogue and translation files. If you want to add/edit non-quest text, you'll find it all here.
4. Entities folder - Contains data relevant to all NPCs, Abilities, Items, Felonies, Traits, etc.
5. Items folder - Contains items, modifiers and liquids.
6. Lua folder - All Lua files to be used in the mod. This folder does not need to appear, as Lua files can be loaded from anywhere in the mod folder.
7. Maps folder - Contains special location and custom map files.
8. Quests.json - A JSON file containing all quest data.

ModSettings.txt is required for all mods it contains the following data:

• ID - A unique ID associated with the mod.
• Name - The displayed name of the mod.
• Load Order - (Optional) Specifies the order this mod is loaded in. Starts at 1, after Core.
• Description - A viewable description of the mod.
• Creator - Who created the mod.