How To Publish Mods
Hello Riftbreaker Tinkerers!
The latest Riftbreaker update includes something we promised you quite some time ago - an integrated modding manager. Thanks to this new functionality, players will be able to browse your creations in-game and download them with just a couple of clicks. Here is a screenshot of what it looks like in the game:
But what good would it be if you didn’t have any way of getting your mods to show up in the manager? Well - you don’t have to worry about that at all. We have updated The Riftbreaker World Editor Suite with all the tools you need to share your mods with the world (plus a lot of new features and bug fixes)! This article will tell you how to prepare your mods to conquer the world step-by-step. Enjoy!
The first thing you need to get is the World Editor Suite. You can do so either by going to your Steam Library and downloading the package from there (you need to enable tools viewing first, see gif) or by going to our GitHub at https://github.com/exorstudios/riftbreaker-tools. If you are new to the Riftbreaker Modding scene, this article should cover the very basics: https://store.steampowered.com/news/app/780310/view/3109170041988719336. If you’ve got that covered, let’s move on to the next part - getting your mod to show up in the Manager.
The first thing you need to do is open up the Workspace Editor and set up a new workspace.
You can name it anything you like - this name is only for your internal use. Immediately after setting up the workspace, a brand-new window will pop up - Update Manifest. This is where you can fill in all the information about your mod: your author name (visible to others), your website if you have one, your mod’s name, its description, and tags. The tags are pre-configured by us and will be consistent across all mod hosting websites we aim to support (Steam Workshop for now, Mod.io, and Curse Forge to be added later). You can also set up a thumbnail for your mod by clicking the image on the right of the window. The preview image is a PNG with the size of 512x288, a 16:9 aspect ratio, and up to 2MB.
If you’ve got an older mod you want to adapt to the new flow, you can also do so. Open your old Workspace and click Export - this option will display the Update Manifest window, where you can fill in all the info. You can also access the Update Manifest option at any time by choosing the option in the Workspace menu.
After that, it is business as usual. On the left side of the Workspace Editor window, you will see the internal file structure of The Riftbreaker. You can copy the files you want to edit to the right side (or just simple drag and drop a file from the left window to the right) - your little modding sandbox. Edit all the files you want, add new ones - go nuts! When you’re ready to release your mod to the public, it is time to make it public.
Click the green ‘Export Workspace’ button at the bottom of your workspace. The Editor will give you a chance to update your Manifest once more before you make the mod public. If you are happy with all the metadata, simply click ‘OK’. That will open a new window called ‘Export Workspace’. In that window, you can add more information about your mod. The first piece of info is the version number of your mod. The convention we’ve gone for is X.Y.Z, where X denotes the major release number, Y is the minor version, and Z is a patch. Try to stick to that, don’t go to version 6.6.6 on day one. The next important piece of info to fill out are the change notes.
After you’ve provided all the information, you’re good to go! Press publish, and your mod will make its way to the Steam Workshop! Whenever you would like to publish an update to your mod, simply click the Export Workspace button again, increment your version number, and fill in the patch notes.
In the coming weeks, we will also expand this option with the ability to publish mods to Mod.io and Curse Forge to enable non-Steam users to access mods as well. In the meantime, we are waiting for your feedback and suggestions on how we can improve the process for you. We’re waiting for you over at www.discord.gg/exorstudios.com and in the comment section below! We can't wait to hear from you!
EXOR Studios
The latest Riftbreaker update includes something we promised you quite some time ago - an integrated modding manager. Thanks to this new functionality, players will be able to browse your creations in-game and download them with just a couple of clicks. Here is a screenshot of what it looks like in the game:
But what good would it be if you didn’t have any way of getting your mods to show up in the manager? Well - you don’t have to worry about that at all. We have updated The Riftbreaker World Editor Suite with all the tools you need to share your mods with the world (plus a lot of new features and bug fixes)! This article will tell you how to prepare your mods to conquer the world step-by-step. Enjoy!
The first thing you need to get is the World Editor Suite. You can do so either by going to your Steam Library and downloading the package from there (you need to enable tools viewing first, see gif) or by going to our GitHub at https://github.com/exorstudios/riftbreaker-tools. If you are new to the Riftbreaker Modding scene, this article should cover the very basics: https://store.steampowered.com/news/app/780310/view/3109170041988719336. If you’ve got that covered, let’s move on to the next part - getting your mod to show up in the Manager.
The first thing you need to do is open up the Workspace Editor and set up a new workspace.
You can name it anything you like - this name is only for your internal use. Immediately after setting up the workspace, a brand-new window will pop up - Update Manifest. This is where you can fill in all the information about your mod: your author name (visible to others), your website if you have one, your mod’s name, its description, and tags. The tags are pre-configured by us and will be consistent across all mod hosting websites we aim to support (Steam Workshop for now, Mod.io, and Curse Forge to be added later). You can also set up a thumbnail for your mod by clicking the image on the right of the window. The preview image is a PNG with the size of 512x288, a 16:9 aspect ratio, and up to 2MB.
If you’ve got an older mod you want to adapt to the new flow, you can also do so. Open your old Workspace and click Export - this option will display the Update Manifest window, where you can fill in all the info. You can also access the Update Manifest option at any time by choosing the option in the Workspace menu.
After that, it is business as usual. On the left side of the Workspace Editor window, you will see the internal file structure of The Riftbreaker. You can copy the files you want to edit to the right side (or just simple drag and drop a file from the left window to the right) - your little modding sandbox. Edit all the files you want, add new ones - go nuts! When you’re ready to release your mod to the public, it is time to make it public.
Click the green ‘Export Workspace’ button at the bottom of your workspace. The Editor will give you a chance to update your Manifest once more before you make the mod public. If you are happy with all the metadata, simply click ‘OK’. That will open a new window called ‘Export Workspace’. In that window, you can add more information about your mod. The first piece of info is the version number of your mod. The convention we’ve gone for is X.Y.Z, where X denotes the major release number, Y is the minor version, and Z is a patch. Try to stick to that, don’t go to version 6.6.6 on day one. The next important piece of info to fill out are the change notes.
After you’ve provided all the information, you’re good to go! Press publish, and your mod will make its way to the Steam Workshop! Whenever you would like to publish an update to your mod, simply click the Export Workspace button again, increment your version number, and fill in the patch notes.
In the coming weeks, we will also expand this option with the ability to publish mods to Mod.io and Curse Forge to enable non-Steam users to access mods as well. In the meantime, we are waiting for your feedback and suggestions on how we can improve the process for you. We’re waiting for you over at www.discord.gg/exorstudios.com and in the comment section below! We can't wait to hear from you!
EXOR Studios