...
Type WorkshopTool and press Enter. This will give you an overview of the available commands and switches. Don't be afraid, the tool will ask for confirmation before it uploads anything.
Publishing an extension
Important: You have to agree to the Steam Workshop Legal Agreement to upload any item to the Steam Workshop.
Imagine you have prepared an extension in the game's extension folder:
...\steamapps\common\X Rebirth\extensions\my first mod
...
If your extension has dependencies on other Workshop items, players have to subscribe to all of them manually, otherwise they will get an error message in the game. The dependency extensions will be shown in the in-game extension menu and can also be subscribed there.
Updating an extension
For updating an existing Workshop item, your command line could look like this:
WorkshopTool update -path "..\X Rebirth\extensions\my first mod" -buildcat -changenote "This is my first update"Some things that are different from the publish command:
- The -changenote switch is required for all updates. Write -changenote "" if you do not want to provide a description. You can also edit the change notes on the Workshop page after updating.
- The WorkshopTool expects that you have increased the version number. If you deliberately keep the version number in your content.xml unchanged, use the -minor switch.
- Usually an update does not affect the Workshop title and description. To upload the name and description attributes from content.xml to the Steam Workshop anyway, use the switch "-namedesc up" (without the quotes).
- Changing the preview file is optional. If you want to change the preview file without uploading new content, use the command updatepreview instead of update.
- It's possible to change the folder name of the extension. Important: Make sure that you do not do this accidentally, e.g. by uploading from a different folder! The WorkshopTool will show old and new folder names before you confirm the upload. Please check this output carefully.
- After the upload, a few XML attributes will be written back to content.xml like when publishing, but the sync attribute is not added or changed. So in case you enabled updates after publishing the extension, they won't be disabled again.
When X Rebirth updates an extension, it checks the the downloaded content.xml for a game version requirement. If the extension requires a higher game version, the game discards the download (with a warning message) and continues to use the existing files on the disk. So if you as a Workshop author change the game version requirement, this will not break anyone's game. However, there are no such checks when you change dependencies on other Workshop extensions and their versions - the update will be applied anyway.