Publisher: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Added stub for the Publisher tool for Arma 3)
 
m (Text replacement - "[[Arma 3 " to "[[Arma 3: ")
 
(27 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Tool|=
{{Tool
____________________________________________________________________________________________


|AUTHOR=
|AUTHOR=
Line 9: Line 8:
|COMPATIBILITY=[[:Category: Arma 3|Arma 3]]
|COMPATIBILITY=[[:Category: Arma 3|Arma 3]]


|DOWNLOAD=Part of Arma 3 Tools package on Steam
|DOWNLOAD={{Link|link= http://store.steampowered.com/app/233800/|text= Part of Arma 3 Tools package on Steam}}


|DESCRIPTION=
|DESCRIPTION= Publisher is a content publishing tool created by Bohemia Interactive.
Publisher is an addon publishing tool created by Bohemia Interactive.


The purpose of this tool is to publish addons (later possibly whole mods) into Steam Workshop to be used with the game.
The purpose of this tool is to publish whole Mods onto {{Link|link= http://steamcommunity.com/workshop/browse/?appid=107410|text= Steam Workshop}} to be used with the game.


|COMMAND=
|COMMAND=
     Publisher.exe<br/>
     Publisher.exe<br>
|OPTIONS=
|OPTIONS=
 
<!--
     [-pbo PBO_file] - pre-selects a PBO to be published
     [-pbo PBO_file] - pre-selects a PBO to be published
 
-->
|EXAMPLE=
|EXAMPLE=
 
<!--
     Publisher.exe -pbo="pathToPBOFile.pbo"
     Publisher.exe -pbo="pathToPBOFile.pbo"
   
-->


|NOTES=
|NOTES=


     Running Publisher with -pbo parameter containing non-existent PBO could cause it's crash to desktop
     Running Publisher with -pbo parameter containing non-existent PBO could cause it is crash to desktop


|LICENSING=
|LICENSING=
Line 36: Line 34:


|SEEALSO=
|SEEALSO=
[[Addon Builder]]
[[Addon Builder]], [[A3 Launcher]], [[Arma 3: Publisher| Publisher, user manual]]


}}
}}
[[Category:Tools]][[Category:Arma 3 Official Tools]]
 
=== Command Line Interface ===
==== Command ====
: <code style="display: block">PublisherCmd update /id:<workshop id> {/changeNote:<change note>|/changeNoteFile:<path to a text file>} /path:<folder with mod content> [/nologo] [/nosummary]</code>
==== Options ====
: /id            - Id of the workshop item to update (required).<br>
: /changeNote    - Text describing the update (required).<br>
: /changeNoteFile - Path to a file with change note (required).<br>
: /path          - Path to the folder with new mod content (required).<br>
: /nologo        - Suppresses display of the sign-on banner.<br>
: /nosummary      - Suppresses display of the parameter summary.<br>
 
==== Return code ====
Zero means the operation has completed successfully, non-zero value means something went wrong. Please consult the documentation for the error codes.
 
: 0: Success.<br>
: 0x0001: Unknown command.<br>
: 0x0002: Invalid parameters.<br>
: 0x0003: Change note is not set and change note file is empty.<br>
: 0x0004: Change note file can't be accessed.<br>
: 0x0010: Unable to initialize Steam API (generic error).<br>
: 0x0011: Steam client is not running.<br>
: 0x0012: Steam client is offline.<br>
: 0x0013: Steam API initialization failed.<br>
: 0x0100: Generic publishing error.<br>
: 0x0101: Details about Workshop item can't be retrieved.<br>
: 0x0102: Workshop item doesn't have the MOD tag.<br>
: 0x0103: Content validation has failed, the content is not a valid mod.<br>
: 0x02XX: Steam Error 0xXX.<br>
: 0xFFFF: Fatal failure.
 
 
{{GameCategory|arma3|Official Tools}}

Latest revision as of 10:38, 6 May 2024

Basic information

Author:
Bohemia Interactive
Compatibility:
Arma 3
Download:
Part of Arma 3 Tools package on Steam

Description

Description:
Publisher is a content publishing tool created by Bohemia Interactive. The purpose of this tool is to publish whole Mods onto Steam Workshop to be used with the game.
Notes:
Running Publisher with -pbo parameter containing non-existent PBO could cause it is crash to desktop

Usage

Line call:
Publisher.exe

Licenses

Licensing:
Bohemia Interactive End User License Agreement
See also:
Addon Builder, A3 Launcher, Publisher, user manual


Command Line Interface

Command

PublisherCmd update /id:<workshop id> {/changeNote:<change note>|/changeNoteFile:<path to a text file>} /path:<folder with mod content> [/nologo] [/nosummary]

Options

/id - Id of the workshop item to update (required).
/changeNote - Text describing the update (required).
/changeNoteFile - Path to a file with change note (required).
/path - Path to the folder with new mod content (required).
/nologo - Suppresses display of the sign-on banner.
/nosummary - Suppresses display of the parameter summary.

Return code

Zero means the operation has completed successfully, non-zero value means something went wrong. Please consult the documentation for the error codes.

0: Success.
0x0001: Unknown command.
0x0002: Invalid parameters.
0x0003: Change note is not set and change note file is empty.
0x0004: Change note file can't be accessed.
0x0010: Unable to initialize Steam API (generic error).
0x0011: Steam client is not running.
0x0012: Steam client is offline.
0x0013: Steam API initialization failed.
0x0100: Generic publishing error.
0x0101: Details about Workshop item can't be retrieved.
0x0102: Workshop item doesn't have the MOD tag.
0x0103: Content validation has failed, the content is not a valid mod.
0x02XX: Steam Error 0xXX.
0xFFFF: Fatal failure.