Mod Publishing Process – Arma Reforger

From Bohemia Interactive Community
Jump to navigation Jump to search
(Page creation (placeholder))
 
No edit summary
Line 1: Line 1:
{{Wiki|TODO|placeholder}}
{{Wiki|TODO|placeholder}}
= Publishing a Mod =
== Prerequisites ==
To publish mod on the Workshop, following things are necessary:
* '''Working mod''' (if it was published before, you have be '''owner''' of that mod)
* '''Bohemia Account'''
If you already have '''Bohemia Account''', then you can login to Bohemia backend by using '''Workbench > Login option.''' This option should open new pop up window where it is possible to type email & password associated with '''Bohemia Account'''. After that was typed in, you can click on '''Login''' button.
[[File:armareforger-publishing-mod-window.png]]  [[File:armareforger-publishing-mod-login.png]]
{{Clear}}
If you don't have account or you don't remember password to it, it is possible to click on '''Forgot Password?''' link, to initiate password recovery or use '''Create Account''' link, to create a new '''Bohemia Account'''.
== Interface ==
Publishing a mod is the process of making the mod available on the Workshop. A bundled mod is required.
In order to do so, click on '''Workbench > Publish Project'''
This will open the following interface:
[[File:armareforger-publishing-mod-interface.png|left|thumb|700px|Publish project window]]
[[File:armareforger-publishing-mod-workshop-game-interface.png|thumb|right|600px|Workshop in-game interface]]
The following fields are offered:
[[File:armareforger-publishing-mod-workshop-categories.png|thumb|right|600px|Workshop categories]]
* '''Project Name:''' Project's workshop name. max 30 characters
* '''Working dir:''' directory where bundled version of the project will be stored. By default it is ''%userprofile%\Documents\My Games\ArmaReforger\publish\addonName''
* '''Preview Image:''' the project's workshop preview image. Maximum allowed size of the image is 2MB, can be JPG or PNG.
* '''Screenshots:''' a gallery of pictures for the users to browse. Maximum allowed size of the image is 2MB, can be JPG or PNG.
* '''Category:'''One or multiple categories in which the mod fit. At least one category has to be selected.
* '''Tags:''' search tags used to get a more precise search result (e.g WW2, CTF, Survival etc). Tags are separated by space
* '''Version:''' the project's version. In the format <major>.<minor>.<bugfix>, should ideally be incremented on every update, with the exception of workshop information fix.
* '''Visibility:'''
** '''Public:''' make the project visible to everyone
** '''Private:''' makes the project visible only to the uploader
** '''Unlisted:''' hides the project in search results. Mod can be still used on dedicated server and downloaded by other users
** '''Test:''' makes the project visible only in Test mods category
* '''Summary:''' the project's workshop '''short''' text preview
* '''Description:''' the project's workshop '''full''' description. It is possible to open larger, pop up window, for longer descriptions.
{{Clear}}
{{Clear}}
== Bundling process ==
Bundling creates '''packed data''', where any unneeded source files are removed, '''manifset.json'''  - where backend related data is stored, '''copies pictures''' (''preview image, screenshots, mission previews'') and '''prepares zip''' '''file,''' with all previously generated data''','''  which is ready to be uploaded to '''Workshop'''.
The editable data set is called the '''source files'''. Once packaged, this is called '''packaged files''' or '''package''' – the data is compressed, indexed and encrypted.
* Packaged files are meant for public distribution
* Packaged files cannot be extracted back to source files – so be sure to keep them safe and with backups!
* Source files are ignored:
** .meta
** .txa (text animation)
** .txo (text model) see File Types and Extensions for full list
* Deflate compression is applied to the resulting files
** .anm, .data, .edds, .et, .nmn, .wav, and .xob are excluded from compression
* Encryption
Depending on the size of the project, bundling process can take from few seconds to couple minutes.
== Publishing process ==
When everything needed is filled and bundle was prepared, click on '''Publish''' to publish the package to the workshop.
= Updating a mod =
To update an already published mod, open the mod project again with the Workbench. Apply any changes needed (data, metadata), fill the new '''Change Notes''' field with the changes applied, and press '''Bundle''' to update the data.
Once bundling is completed, push '''Publish''' button to send your changes to the server.
Any change to description, visibility, pictures, etc has to be '''bundled first''' and then '''published as new version'''.
= Using CLI parameters =
Mods can be bundled and packed using following command line parameters
https://community.bistudio.com/wiki/Arma_Reforger:Startup_Parameters#Workbench
= Troubleshooting =
If you have problems with logging to Bohemia Account or publishing mod, first thing to do is to look at '''Console Log.'''
==== You are not the owner of the asset ====
Make sure that the account that you are using is owner of the given asset. If you are using Samples as the base,
==== Failed to load metafile of mission config image ====
<code>RESOURCES    : Packaging project successful
RESOURCES (E): Failed to load metafile of mission config image:
DEFAULT  (E): Cannot copy image:
RESOURCES (E): Creating bundle failed</code>
https://community.bistudio.com/wiki/Arma_Reforger:Known_Issues




{{GameCategory|armaR|Modding|Tutorials|Assets}}
{{GameCategory|armaR|Modding|Tutorials|Assets}}

Revision as of 15:08, 30 May 2022

🚧
TODO: placeholder

Publishing a Mod

Prerequisites

To publish mod on the Workshop, following things are necessary:

  • Working mod (if it was published before, you have be owner of that mod)
  • Bohemia Account

If you already have Bohemia Account, then you can login to Bohemia backend by using Workbench > Login option. This option should open new pop up window where it is possible to type email & password associated with Bohemia Account. After that was typed in, you can click on Login button.

armareforger-publishing-mod-window.png armareforger-publishing-mod-login.png

If you don't have account or you don't remember password to it, it is possible to click on Forgot Password? link, to initiate password recovery or use Create Account link, to create a new Bohemia Account.

Interface

Publishing a mod is the process of making the mod available on the Workshop. A bundled mod is required.

In order to do so, click on Workbench > Publish Project


This will open the following interface:

Publish project window
Workshop in-game interface

The following fields are offered:

Workshop categories
  • Project Name: Project's workshop name. max 30 characters
  • Working dir: directory where bundled version of the project will be stored. By default it is %userprofile%\Documents\My Games\ArmaReforger\publish\addonName
  • Preview Image: the project's workshop preview image. Maximum allowed size of the image is 2MB, can be JPG or PNG.
  • Screenshots: a gallery of pictures for the users to browse. Maximum allowed size of the image is 2MB, can be JPG or PNG.
  • Category:One or multiple categories in which the mod fit. At least one category has to be selected.
  • Tags: search tags used to get a more precise search result (e.g WW2, CTF, Survival etc). Tags are separated by space
  • Version: the project's version. In the format <major>.<minor>.<bugfix>, should ideally be incremented on every update, with the exception of workshop information fix.
  • Visibility:
    • Public: make the project visible to everyone
    • Private: makes the project visible only to the uploader
    • Unlisted: hides the project in search results. Mod can be still used on dedicated server and downloaded by other users
    • Test: makes the project visible only in Test mods category
  • Summary: the project's workshop short text preview
  • Description: the project's workshop full description. It is possible to open larger, pop up window, for longer descriptions.

Bundling process

Bundling creates packed data, where any unneeded source files are removed, manifset.json - where backend related data is stored, copies pictures (preview image, screenshots, mission previews) and prepares zip file, with all previously generated data, which is ready to be uploaded to Workshop. The editable data set is called the source files. Once packaged, this is called packaged files or package – the data is compressed, indexed and encrypted.

  • Packaged files are meant for public distribution
  • Packaged files cannot be extracted back to source files – so be sure to keep them safe and with backups!
  • Source files are ignored:
    • .meta
    • .txa (text animation)
    • .txo (text model) see File Types and Extensions for full list
  • Deflate compression is applied to the resulting files
    • .anm, .data, .edds, .et, .nmn, .wav, and .xob are excluded from compression
  • Encryption

Depending on the size of the project, bundling process can take from few seconds to couple minutes.

Publishing process

When everything needed is filled and bundle was prepared, click on Publish to publish the package to the workshop.

Updating a mod

To update an already published mod, open the mod project again with the Workbench. Apply any changes needed (data, metadata), fill the new Change Notes field with the changes applied, and press Bundle to update the data.

Once bundling is completed, push Publish button to send your changes to the server.

Any change to description, visibility, pictures, etc has to be bundled first and then published as new version.

Using CLI parameters

Mods can be bundled and packed using following command line parameters

https://community.bistudio.com/wiki/Arma_Reforger:Startup_Parameters#Workbench

Troubleshooting

If you have problems with logging to Bohemia Account or publishing mod, first thing to do is to look at Console Log.

You are not the owner of the asset

Make sure that the account that you are using is owner of the given asset. If you are using Samples as the base,

Failed to load metafile of mission config image

RESOURCES  : Packaging project successful RESOURCES (E): Failed to load metafile of mission config image: DEFAULT (E): Cannot copy image: RESOURCES (E): Creating bundle failed

https://community.bistudio.com/wiki/Arma_Reforger:Known_Issues

Retrieved from "https://community.bistudio.com/wiki?title=Arma_Reforger:Mod_Publishing_Process&oldid=322319"