The Steam Workshop Tool

The Platypus Reclayed Workshop tool is where you go to start a new mod and upload your creations to share with the world.

Installing

You should find the Platypus Reclayed Workshop Tool in your Steam Library alongside the game. If it's not vibisle, make sure to check your Steam Library Filter at the top and ensure "Tools" is included.

Overview

The app is a simple tool to help initialise a new mod folder, provide access to the Platypus Reclayed source assets and finally upload your creation onto Steam.

Creating a new mod

Use Create Mod… to select a new empty folder to initialise with the core mod files. Please see the main modding documentation on details on how to customise the content and configure your modmeta.json file that describes the kind of mod you're making.

The source assets from the main game, examples and docs are available from the Starter Pack… button on the main panel.

Uploading a mod

When the time comes to upload your mod to Steam, use Open Mod… to select your mod folder. You're then able to give the mod a description - this will appear in the workshop and lets everyone know what your mod is about. You must also provide a cover image that helps demonstrate your mod. Once that's done, simply press Upload Mod to Steam Workshop to send it to Steam. Once the upload has succeeded, a browser window should open at your new workshop item page.

Here you can change the visibility of the mod to share it with your friends or make it entirely public. You can also add additional screenshots. Note: if you change the description in Steam, those changes will be lost if you upload from the tool again so it's best to change the description in the tool.

Under-the-hood

In modmeta.json there will be a field called "name" (if its missing don't worry, it will be created after the first time you upload to the workshop). This name is separate to the display name and is used to identify the mod. If there is no name field present during development, the game will use the parent folder's name instead.

Once you upload to Steam Workshop you will be given a unique item ID that is used as the name. This allows you to make modifications and update your mod without creating a new one each time. To ease development, the name locally will be saved to disk with "-local" appended e.g. "12345678-local" allowing you to load the mod locally as well as be subscribed for testing.