How Do I Upload to the Steam Workshop

Contents

• 1 Publishing user content (mods and campaigns)
• 2 User interface
  • 2.one Published items listing
  • 2.2 Item Metadata
  • 2.3 Description
  • ii.four Tags
  • 2.5 Change notes
  • two.vi Paradigm
  • 2.7 SteamWorks licence
  • 2.8 Publish
  • 2.9 Options
    • 2.ix.one Other buttons
• 3 Boring technical stuff
• 4 Logs
• v Notes

1.24

The purpose of this tools is to publish and manage items in the Steam Workshop. It allows you to upload your mods and change the information that is displayed on their Steam Workshop folio. Published mods (and other items) tin be so subscribed by other players and loaded to the game by Arma 3 Launcher.

The official Publisher was launched July xiv, 2014 with the Bootcamp update one.24. http://arma3.com/news/bohemia-interactive-deploys-arma-3-bootcamp-update.

Publishing user content (mods and campaigns)

To publish the content to Steam Workshop, y'all have to have the modernistic prepared and tested. Offset with clicking a button "SELECT Mod Folder" and selecting the folder that contains your mod.

So yous should name select the name for it (information technology should be unique and descriptive for users to identify information technology hands) and select it is type:

• Mod: a game modification, an addon or a new terrain;
• Campaign: a series of connected missions;
• Scenario: simple mission are published directly from Eden Editor and can't be published past Publisher.

Based on the selected item type, you tin choose from the multiple tags that are used on Workshop to filter the items. We recommend to utilise the tags that the best describes your item. Using misleading tags or all tags will result in Workshop moderators changing them or removal of the entire detail from Steam Workshop.

If you're updating the existing item, you should fill the change notes to let your users know what's new.

Before the mods is published or updated on Workshop, the structure bank check is washed to ensure that the modernistic can exist loaded by the game.
Following requirements must be met in society to publish the mod:

• addons folder needs to be directly in the root (tiptop level) to be loaded in the game;
• addons folder has to comprise the PBO files;
• all signatures demand to be in the aforementioned folder as their corresponding PBOs.

Publishing a mod with PBO files outside of addons folder (such as an presence of Optional folder) will produce a alarm, because swapping of files in mods acquired through Steam client is not recommended. ^{[note i]}

User interface

Published items list

Displays your new and published items.

• Unpublished detail: Select this item when you want to publish a new item in the Workshop.
• Listing of published items: lists all your existing items. Publishing with a selected particular on this listing will overwrite all data and meta-data on Steam with your local re-create. Scenarios published from the game's editor are likewise listed.
• Search field: allows full-text search in the listing
• Web: opens the workshop folio of the selected published item. Not available for the unpublished detail.
• Delete: removes the item from the workshop. Utilize carefully, does not have disengage.

Item Metadata

• Mod content: Drag and drop a file or a folder onto the box. Remove added items by clicking 10.
  • Included folders automatically include whatsoever files or sub-folders
  • Items can contain multiple files and folders
  • Item size is not limited
  • Buttons:
    • Add file, Add folder: opens windows dialog to select files or folder
    • Clear all - removes all included files and folders from the mod content box
  • Behavior
    • A file or a folder can exist included only once (based on its path)
    • Files of the aforementioned proper noun but unlike size can be included even in the same directory, they will be enumerated (myMod.pbo; myMod.pbo > myMod.pbo; myMod1.pbo)
    • Tooltip shows the full path and size
    • Including simply one folder will not promote information technology equally root, the input field is the root and will be published as @name
  • Signatures
    • signatures are required for multiplayer with mods and tin can be generated in Addon architect [Addon Builder]
    • with a multiple files philosophy, signatures tin now be included in the workshop items
    • they should to exist in the aforementioned folder equally the respective PBO
    • Publisher options now allows automobile-including signatures

• Author: Reads the author specified in the PBO or from Steam
• Name: Name of the Workshop item.
• Size: Size of the particular on Steam or a size of the file to be uploaded (xanthous color).
  • Displays file and folder count for an item to be published.
• Published: For existing items only, the original published date.
• Concluding Update: For existing items simply, the last update fourth dimension.
• Visibility: There are three options to choose from:
  • Public - visible to anyone, anyone tin can subscribe to your item
  • Friends - visible only to your Steam friends
  • Private - (Default), visible only to y'all

Description

Text field for your description of the published item. Limit: 8000 bytes (~ 8000 characters]

Annotation: If your mod requires other content to run properly (dependency), information technology is a good practice to list all the required content here including a links how to go it and a proper load order, if necessary.

In add-on, required items present in the workshop tin can be defined from the page of your detail (Add/Remove Required Items).

Tags

Steam tags used for categorizing content. Skilful tags improve content discovery.

Notation: Information technology's better to tag your content sparsely (with tags from the same category) and employ your tag to embrace the nigh prominent qualities or elements. More tags = more confusion for the subscribers.

By Steam category: Data Type - specifies data blazon.

• Modernistic - for single or multiple PBOs. Needs to exist loaded on the game start. Content with tag Modern is displayed in Arma three Launcher.
• Server - special server type addon.

NOTE: Mod and Scenario tags are mutually exclusive.

Mod Type - specifies modern blazon based on it is content

• Animation - modifies animations in game
• Boat - modifies boats in game
• Campaign - several (connected) missions
• Graphic symbol - modifies characters in game
• Equipment - modifies equipment in game
• Helicopter - modifies helicopters in game
• Mechanics - modifies game mechanics, user interface or other similar elements in game (scripts)
• Plane - modifies planes in game
• Audio - modifies sounds or music in game
• Structure - modifies structures (buildings, props) in game
• Terrain - modifies terrains in game
• Tracked - modifies tracked vehicles in game
• Weapon - modifies weapons in game
• Wheeled - modifies wheeled vehicles in games

DLC

• KartsDLC - mod recommends owning Karts DLC
• HelicopterDLC - mod recommends owning Helicopter DLC
• MarksmenDLC - mod recommends owning Marksmen DLC

Meta

• Dependency - mod requires other user mods
• Drove - mod created as a role of larger, simply not inter-dependent, collection or theme

Review These tags are added automatically by Publisher when corresponding conditions are met. They cannot be removed by the user. Their purpose is to make administering workshop easier.

• Tag Review - added when the detail has over 7 tags. The aim here is to reduce the number of tags per detail to ameliorate discoverability.
• Content Review - added when the detail contains a file type that could contain malicious content. Included extensions are .exe, .dll, .cmd, .com, .bat, .py, .ps, .jar, .lib, .src.

Change notes

Text field, limited to 8000 bytes (~ 8000 characters). Only relevant when updating an existing detail with a PBO.

Notation: When updating an item, provide data what changed so that users feel informed.

Image

Previews an included image to be visible on Steam Workshop.

• Predefined: provides a selection of existing images roofing master tags.
• Browse: opens file open up dialog. Immune file types are .jpg, .jpeg, .png, .gif, .bmp. Image is downscaled to 0,95 MB to meet the Steam limit.

SteamWorks licence

Checkbox - Earlier publishing, each writer must explicitly hold with SteamWorks license. The whole text of the license is available online. When agreement was non confirmed, Publisher provides an error dialog on Publish attempt.

Publish

Click this button to publish or update your item with the provided files and/or information.

Note: Publishing handles all the data to the Steam Client and displays the progress window. Y'all can rails the progress bar, but be aware that there are several steps like compressing and extracting that are handled past the Steam back-end and non communicated over the API - this ways the publishing can take longer even on a solid connection.

Options

• Temp folder path: define a temporary folder where mods with multiple files are copied and prepared before their publishing. Provide an absolute path or utilize [...] to open up the Open folder dialog. Contents of the binder is deleted after a successful publishing.
  • Use default: default temporary folder is user documments dir\AppData\Local\Temp e.g. c:\Users\cooper\AppData\Local\Temp\
  • When adding files, a new binder is created in Temp with the Name of the mod (example: ...\Temp\MyFirstMod ). When such binder already exists, the new folder cannot be created and publishing fails with error. Please, remove such folder manually before retrying.

NOTE: copying large or multiple files between drives tin can have longer

• Auto-include signatures
  • When a PBO is existence added to the modern content, Publisher searches the source folder for a relevant signature (<pbofilename>.<string>.bisign) and adds it to the modernistic content. If more than then 1 signature files friction match the condition, all of them are included.
  • When a PBO is beingness removed from the mod content, Publisher automatically removes the matching signature, if present.
  • Default: on
• Open workshop page after publishing
  • When publishing is successful, Publisher automatically opens the published item's workshop page. Usable for visual checks and subscribes.
  • Default: on
• Use Steam Client instead of spider web browser
  • When opening workshop pages using the Web push or automatically after publishing, opens the webpage in Steam Client instead of the default web browser
  • Default: on (Steam Client)

Other buttons

• Bohemia Interactive - opens company page in external spider web browser
• Workshop - open Arma 3 workshop page in external browser
• Support - open up Bohemia Interactive back up page in external browser
• Feedback - opens feedback tracker, Arma 3'due south community feedback and issue tracking service in external web browser

Boring technical stuff

To be candy later

• Publishing process - Be aware that publishing larger mods can have up a while. Hither is what has to happen:
  • Publisher sends the path to all files and folders in the temp [link] folder to Steam Customer
  • Steam Client archives the files locally into one archive
  • Steam Client uploads to SteamWorks database
  • Workshop stores the information and sends Publishing successful callback
  • Publisher receives the callback and lists the file as published

Logs

Publisher logs can be found in steamapps\common\Arma three Tools\Logs
When something goes wrong (in several attempts, because Steam can have a bad moment sometimes :) ), please, create an effect on the tracker in Tools category and include these logs.

Notes

1. ↑ Steam is managing the downloaded files and keeps them synchronized with data uploaded to Workshop. If the users motility the files, Steam will revert these changes with next update making the beliefs of the modern unpredictable. Likewise historically this kind of manipulation has broken the Steam and forced re-download of the entire mod.

roneybuttle.blogspot.com

Source: https://community.bistudio.com/wiki/Arma_3:_Publisher

Share this post