How to Upload Arma Mod to the Workshop

Contents

• 1 Publishing user content (mods and campaigns)
• 2 User interface
  • 2.ane Published items list
  • 2.2 Item Metadata
  • two.3 Description
  • 2.4 Tags
  • two.five Modify notes
  • 2.6 Image
  • 2.7 SteamWorks licence
  • 2.8 Publish
  • 2.9 Options
    • 2.9.1 Other buttons
• 3 Tedious technical stuff
• 4 Logs
• five Notes

ane.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 page. Published mods (and other items) can be then subscribed by other players and loaded to the game by Arma three Launcher.

The official Publisher was launched July 14, 2014 with the Bootcamp update 1.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. Outset with clicking a button "SELECT Mod Folder" and selecting the folder that contains your modern.

Then you lot should proper noun select the name for it (it should be unique and descriptive for users to place information technology hands) and select it is type:

• Modern: a game modification, an addon or a new terrain;
• Campaign: a serial of connected missions;
• Scenario: unproblematic mission are published directly from Eden Editor and can't be published by Publisher.

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

If y'all're updating the existing detail, 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 check is done to ensure that the modernistic tin be loaded by the game.
Post-obit requirements must be met in social club to publish the modernistic:

• addons folder needs to exist directly in the root (top level) to be loaded in the game;
• addons folder has to contain the PBO files;
• all signatures demand to be in the same folder as their respective PBOs.

Publishing a mod with PBO files outside of addons folder (such as an presence of Optional folder) will produce a warning, considering swapping of files in mods acquired through Steam client is non recommended. ^{[notation 1]}

User interface

Published items list

Displays your new and published items.

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

Item Metadata

• Modern content: Drag and driblet a file or a folder onto the box. Remove added items by clicking Ten.
  • Included folders automatically include any files or sub-folders
  • Items can contain multiple files and folders
  • Particular size is non limited
  • Buttons:
    • Add file, Add together binder: opens windows dialog to select files or folder
    • Clear all - removes all included files and folders from the modern content box
  • Behavior
    • A file or a folder can be included only one time (based on its path)
    • Files of the same name but unlike size can be included fifty-fifty in the same directory, they will be enumerated (myMod.pbo; myMod.pbo > myMod.pbo; myMod1.pbo)
    • Tooltip shows the full path and size
    • Including but ane folder volition not promote it equally root, the input field is the root and volition exist published as @proper name
  • Signatures
    • signatures are required for multiplayer with mods and can be generated in Addon builder [Addon Builder]
    • with a multiple files philosophy, signatures can now be included in the workshop items
    • they should to be in the same 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 detail.
• Size: Size of the item on Steam or a size of the file to exist uploaded (yellow color).
  • Displays file and binder count for an particular to be published.
• Published: For existing items but, the original published appointment.
• Final Update: For existing items only, the last update time.
• Visibility: At that place are iii options to choose from:
  • Public - visible to anyone, anyone can subscribe to your item
  • Friends - visible only to your Steam friends
  • Private - (Default), visible merely to you lot

Description

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

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

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

Tags

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

Annotation: It's improve to tag your content sparsely (with tags from the same category) and employ your tag to embrace the well-nigh prominent qualities or elements. More than tags = more confusion for the subscribers.

Past Steam category: Data Type - specifies data type.

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

Note: Modernistic and Scenario tags are mutually sectional.

Mod Type - specifies mod type based on information technology is content

• Animation - modifies animations in game
• Gunkhole - modifies boats in game
• Entrada - several (connected) missions
• Grapheme - 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
• Sound - 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 - modern recommends owning Marksmen DLC

Meta

• Dependency - modern requires other user mods
• Collection - mod created as a function of larger, but non inter-dependent, collection or theme

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

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

Alter notes

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

Note: When updating an item, provide data what inverse so that users feel informed.

Prototype

Previews an included image to be visible on Steam Workshop.

• Predefined: provides a choice of existing images covering main tags.
• Browse: opens file open up dialog. Allowed file types are .jpg, .jpeg, .png, .gif, .bmp. Paradigm is downscaled to 0,95 MB to encounter the Steam limit.

SteamWorks licence

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

Publish

Click this button to publish or update your detail with the provided files and/or data.

Note: Publishing handles all the data to the Steam Client and displays the progress window. You lot can track the progress bar, but be aware that there are several steps like compressing and extracting that are handled past the Steam dorsum-end and not communicated over the API - this means the publishing can take longer even on a solid connexion.

Options

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

NOTE: copying large or multiple files between drives can take longer

• Automobile-include signatures
  • When a PBO is beingness added to the mod content, Publisher searches the source folder for a relevant signature (<pbofilename>.<cord>.bisign) and adds it to the modern content. If more so one signature files match the condition, all of them are included.
  • When a PBO is being removed from the mod content, Publisher automatically removes the matching signature, if present.
  • Default: on
• Open up workshop folio afterwards publishing
  • When publishing is successful, Publisher automatically opens the published item'south workshop page. Usable for visual checks and subscribes.
  • Default: on
• Use Steam Customer instead of web browser
  • When opening workshop pages using the Web button or automatically after publishing, opens the webpage in Steam Client instead of the default web browser
  • Default: on (Steam Customer)

Other buttons

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

Wearisome technical stuff

To be candy afterwards

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

Logs

Publisher logs can be establish in steamapps\common\Arma 3 Tools\Logs
When something goes wrong (in several attempts, because Steam can have a bad moment sometimes :) ), please, create an issue 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 move the files, Steam volition revert these changes with adjacent update making the behavior of the modernistic unpredictable. Also historically this kind of manipulation has broken the Steam and forced re-download of the entire modern.

garzakenterefored48.blogspot.com

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

Share this post