Resources & Examples

Discord

The #modding channel is the best way to ask modding-related questions, as it will get the fastest response, between developers and other modders.

Example Mods

Simple

Hello World

• Registers: messages
• Hooks: onGameScreenVisible, onItemEquip, onMove
• Overrides mod loading cycle methods
• Logging
• Sends messages to the player
• Contains language

Ridiculous Hairdos

Adds a few custom hairdos, hair colors, and skin tones, demonstrating customizations.json.

Pirate Language

Adds a pirate-themed language.

Argus

Adds a new item that allows you to see the entire map.

• Registers: a bindable, an action, and an item
• Hooks: onGameStart, onBindLoop

Alpha Tracks

Adds two music tracks to the game.

• Registers: two music tracks, a dictionary, and an options section
• Saves data globally

Trees on Fire

Overrides the default game textures for some trees to make them appear as if they were ablaze.

Literally a Language

Literally all this does is add "literally" in front of most dictionary strings in the game, literally.

• Demonstrates using "article rules" in languages

Reincarnate

Causes the player to respawn with a random appearance, stats, and skills on death.

• Registers: a message
• Hooks: onPlayerDeath

OwO Whats This?

A silly language created programmatically.

Advanced

Starter Quest

A guided quest for newer players to understand and discover the most important game mechanics in Wayward.

Troposphere

Adds a magical world of clouds!

• Registers: items, doodads, terrain, creatures, actions, a skill, messages, a note, a help article
• Hooks: onCreateWorld, preLoadWorldDifferences, preRenderWorld, shouldRender, onGameStart, onPlayerJoin, onMove, onMoveComplete, onSpawnCreatureFromGroup, getTilePenalty
• Event handlers: Human.canConsumeItem, Creature.canMove, Creature.canAttack, WorldRenderer.canSeeCreature, WorldRenderer.getFogColor
• Saves data

Challenge Server

A script allowing dedicated servers to auto-run challenge games.

• A mod that can only be run serverside

Very Complex

Debug Tools

Adds a lot of debug utilities to the game for inspecting and manipulating the world.

• Registers: registries, inter-mod registries, bindables, a dictionary, a message, a message source, interrupt choices, actions, dialogs, menu bar buttons, overlays
• Hooks: postFieldOfView, onGameScreenVisible, getZoomLevel, getCameraPosition, onPlayerDamage, onMove, onNoInputReceived, getPlayerWeightMovementPenalty, getPlayerSpriteBatchLayer, isHumanSwimming, getPlayerMaxWeight, onBindLoop
• Event handlers: Creature.canAttack, MovementHandler.canMove, WorldRenderer.getMaxSpritesForLayer
• Injections: WorldRenderer.calculateAmbientColor, Game.calculateAmbientLightLevel, Game.calculateTileLightLevel
• Many files
• A lot of UI & actions
• Custom CSS

TARS

TARS is a bot that will play Wayward by itself, doing tasks such as gathering resources, setting up a camp, hunting, getting food/water, and more!

Balancing Tools

Adds a set of balancing tools to the Debug Tools dialog.

• Registers: two dictionaries, a registry of actions, and an inter-mod registration to Debug Tools' "MainDialogPanel" registry
• Hooks: Creature.canMove, NPC.canMove