Skip to content
Chiri Vulpes edited this page Sep 4, 2024 · 8 revisions

Wayward Modding Guide

Background

Wayward is primarily built using HTML5 technologies and uses TypeScript (a strict superset of JavaScript), which compiles down to normal JavaScript. This is then run through Electron, a cross-platform application that runs browser languages as a desktop app, outside of your browser.

Wayward uses a combination of HTML, CSS, JavaScript, and WebGL (shaders) for all rendering and UI. It is not necessary to have skills and knowledge in these things to begin modding, although it wouldn't hurt.

Notes

  1. Wayward modding support is Early Access (or beta), just like Wayward itself. Many things will change and improve over time. Let us know any issues you run into or if you have any ideas for us.
  2. This guide is only tailored towards building TypeScript mods for Wayward.
    • Although you can technically mod Wayward with normal JS, it will not be particularly pleasant, so we do not recommend it.

To continue the modding guide, click the above link.


Other Useful Links

Every official mod created for Wayward, and some other Wayward-related projects.

Where Wayward mods are published.

Getting Started

Mod Content

Script Documentation

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

Clone this wiki locally