Skip to content

Prerequisites

Mackenzie McClane edited this page Oct 13, 2019 · 7 revisions

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).

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.
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 from the repository and use them in another editor/IDE.

Getting Started

Mod Content

Script Documentation

(apologies for all the missing guides, we'll get to them at some point)

Clone this wiki locally