-
Couldn't load subscription status.
- Fork 1
Prerequisites
Node.js (required)
Node.js will be used by Wayward to install the latest version of the Wayward "types" (used to compile your mod & give you errors, hints, & suggestions through VSCode).
Note: Installing Node.js will prompt you to install Python, Visual Studio Build Tools, and Chocolatey. These are not necessary to install for Wayward modding.
VSCode (recommended)
VSCode is a light-weight IDE that has very good TypeScript support. Technically VSCode is not required to build a Wayward mod, but it's highly recommended, and this guide will assume you have it.
TypeScript (required)
Install: npm install typescript -g
This can be done in VSCode (Terminal > New Terminal), or if your IDE doesn't support it, you can use a Command Prompt.
Wayward Schemas (recommended)
- Adds schemas (hints, explanations, and errors) for JSON files used in mods.
- Adds syntax highlighting for translation interpolation in all JSON-with-comments files. (Files matching
/lang/file.jsonare loaded as that type)
Install: Search for "Wayward Schemas" in the "Extensions" tab of VSCode.
If you're not using VSCode, you can feel free to extract our schemas or textmate grammar injection from the repository and use them in another editor/IDE.
Getting Started
- Introduction
- Prerequisites
+mod create&+mod update- mod.json
- Extracting Assets
- Resources & Examples
- Frequently Asked Questions
Mod Content
Script Documentation
- Using Translations
- Registrations
- Event Handlers
- Injection
- Adding Items
- Adding Doodads
- Adding Creatures
- Adding Magical Properties
- Actions & Multiplayer
- Adding Dialogs
- Context Menu/Action Bar Actions
- Inter-mod Registries
(apologies for all the missing guides, we'll get to them at some point)