This website documents the "types" of Wayward — basically, the structure of the game's code.
Sometimes, while modding, you'll see examples which reference something you don't have, such as ItemType
,
and VSCode will put a red underline under it because you haven't imported it yet. In cases where VSCode is unable to automatically
import it for you, you can find the path in this documentation.
Clicking on the magnifying glass icon at the top allows you to search the documentation for the export you're looking for.
In the case of ItemType
, one of the suggestions is game/item/IItem.ItemType
. Clicking on it goes to the definition.
Your import will be import { NAME } from "PATH";
, where NAME is the export you were looking for (ie ItemType
),
and PATH is the text of the second link in the breadcrumbs (ie at the top it might say, for example, Wayward Types Viewer / game/item/IItem / ItemType /).
For example import { ItemType } from "game/item/IItem";
.
Some imports will be the "default" export from a module. In that case the import will be, for example, import Register from "mod/ModRegistry";
Notice how the import is the name without the {}
curly braces.
The Module Index contains a list of every single file in the game, and therefore all possible paths for you to import from.
The Common Modules section of the sidebar lists some commonly-referenced things for Wayward modding. Take a look!
You can visit https://waywardgame.github.io/development/ to see a copy of the types specific for the "development" branch in the Steam betas.
Learn how to mod Wayward.
+mod create
& +mod update
— Documentation on the commands used to generate starter files for modding, and updating script mods.mod.json
— Documentation on what all can be declared in the main mod metadata file.A pretty, searchable list of all the type definitions in Wayward. For the raw form of these type definitions, see the types
repository on GitHub.
Every official mod created for Wayward, and some other Wayward-related projects.
Where Wayward mods are published.
Generated using TypeDoc