ArmA3Sync Wiki English

De Wiki SoE

ArmA3Sync.png

By the [S.o.E] Team - Sons of Exiled

About

ArmA3Sync is both a launcher and adddons synchronization software for ArmA 3. It is intend to be used by players, server administrators and ArmA 3 teams. ArmA3Sync development has been inspired from ArmA 2 Game Launcher (SpiritedMachine) and AddonSync 2009 (Yoma).

Main features are:

- Game configuration and launch with addons.

- Server configuration and launch with addons for both Windows see and Linux see platforms.

- Build and management of custom addon repositories FTP or HTTP (Web) servers.

- Reliable and easily configurable addon synchronization with checking integrity of files (SHA1).

- Minimization of the amount of downloaded data. Web hosted addon repositories will thus benefit from differential updates (ZSYNC).

- Events broadcast system which can help organizing multiplayer games along with addons see.

- Brings native supports for @AllInArmA, @ACRE, @ACRE2 and @TFAR.

Credits

Authors

[S.o.E] Major_Shepard: Software Conception

[S.o.E] Matt2507: Graphic Conception & Web Development

[S.o.E], [BWF] & [F27] members: Testing


[S.o.E] team, http://www.sonsofexiled.fr

[BWF] team, http://www.blackwater.fr

[F27] team, http://www.force27.com


Terms Of Use

ArmA3Sync is a free software distributed under the GNU Global Public Licence (GPL), version 3. Authors and the [S.o.E] team reject any responsibility in the use of this software. Commercial benefit from this software is forbidden.

Developers

Source code of this software is available on our SVN Server at: svn://www.sonsofexiled.fr/repository/ArmA3Sync/releases

ArmA3Sync includes:

- libraries Commons.Net, Commons.io from The Apache Free Software Foundation see (GPL)

- library Dom4j. see (GPL)

- library org-netbeans-swing-outline from NetBeans project see (GPL).

- source code of Jazsync application by Tomáš Hlavnička see (GPL).

Installation

Requirements

Runtime environment Java (JRE) Oracle 7 or 8 must be installed (download). Linux users may need to replace default runtime environment openJDK (see here).


Download

- Windows automatic installer: http://www.armaholic.com/page.php?id=22199

- Manual installation archive: ftp://www.sonsofexiled.fr/ArmA3/ArmA3Sync/download/


Installation guideline

- Automatic installer for Windows: run ArmA3Sync-installer.exe

- Archive for manual installation: uncompress the archive then place it at the destination of your choice. Make a shortcut to ArmA3Sync.exe or ArmA3Sync.sh depending of your operating system.


Launch

- Windows: run ArmA3Sync.exe (administrator privileges required)

- Linux: run ArmA3Sync.sh


Configuration

When ArmA3ync starts, please give the path to ArmA 3 executable location as follow:

- ArmA 3 player: arma3.exe.

- Windows administrator: arma3server.exe.

- Linux administrator: to be released by BIS.

Updates

New software available updates are indicated at software startup. You can check for updates manually by using Help menu then Check for Updates. Software will be automatically updated by the ArmA3Sync Updater see.

Use as a player

Launch addons with the game

1. Put addons into ArmA 3 directory or any other directory you can specified in the section Addon Search Directories of the Addon Options panel see. Folders containing addons can also be placed.

2. Push the Refresh button in the Avaible Addons section of the Addons panel.

3. Do a right click into Addon Groups section and select Add Group see. Drag and drop addons into the newly created folder. Displayed folders inside the Available addons section can also be dragged and dropped see.

4. Select the wanted addons in the Addon Groups section then choose Start Game button.


Create profiles

Profiles for launching the game with addons can be created without limitation. These profiles can save the entire Addon Groups section as long as Additional Parameters from Launcher Options panel.

1. Select Profiles menu then choose Edit.

2. Do New, give a name then choose OK.


Join a server

1. In the Online panel select the add button named Add a new favorite server then fill in the required informations see.

2. Into the combo box Join server select your server then choose Start Game button.


Run external applications

1. In the Extenal Apps panel select Add a new application button.

2. Select the new entry into the table then choose Edit button.

3. Enable or disable an application to run at game start with the button Set the selected application to run at game launch see.


Launch in AiA mode

1. Install the @AllinArma addon.

2. Select the Tools menu then AiA tweaker. Checkout the exactness of the paths. see.

3. Select Game version ArmA 3 - AiA then Start Game see.


Add an addons repository

1. In the Repositories panel select the Add a new repository button see.

2. Fill in the required informations. You can also copy-paste the link to the auto-config url and select the Import button. In this case, the Connection success message must appeared see.

3. Select the OK button. A new entry should be added into the Addon Repositories table see.

4. Select the Notify check box if you want to be alerted about repository changes at ArmA3Sync startup.


Synchronize addons with a repository

1. Select and entry into the Addons Repositories panel then select the Connect to repositorty button see. The management repository interface should open see.

2. Select the Check for Addons button see. The section Repository content should display the content of the repository see. Blue color indicates files to delete and red color the new or updated files.

3. Select the Advanced Configuration button if you like to change the destination folder for and addon see.

4. You can hide extra local files in a folder to be excluded from synchronization see.

5. Select the wanted addons then choose the Start button see.

6. Once the download is finished, select the Addons panel and choose Modsets button.

7. Select the wanted repository and choose OK button. A new group is created containing the required addons for the repository see. The addon list within the Addons panel will be updated everytime check for addons is performed from the download panel.


Get the repository changelog

1. Choose the Repository button see.

2. In the Infos section choose the View button see.


Synchronize and launch addons with an event

1. In the Repositories panel select the wanted event then select the Check Event button see.

2. The Repository Content section shows all of the needed addons for the game. The optional indicates the non necessary addons see. Select the Start button to start downloading.

3. Once the download is finished, select the Addons panel and choose Modsets button.

4. Select the wanted event and choose OK button. A new group is created containing the required addons for the mission see.

Use as a server administrator

Launch an ArmA 3 server

1. In the Launcher Options panel give the path to arma3server.exe for Windows platforms or (incoming) for Linux platforms.

2. In the Aditional Parameters section add the configuration files paths see. More parameters can also be added see.

3. Select the Start Game button. Server console should appear. Several click on Start Game button will launch as much ArmA 3 servers.You can use profiles to create many server configurations (Additional parameters are saved into the current profile).


Update addons for the ArmA 3 server

Just proceed with synchronization the same way as described for a player.


Build an addons repository

1. In the Repositories panel, select the Add a new repository button. Fill in the required informations. The url must address the shared folder that will contain the addons see.

2. Select the new entry in the table then choose Connect to repository button see.

3. On the new panel displayed, select the Repository button see.

4. Give the path to the folder provided at step 1. Add addons into the shared folder. You can also place them into folders see.

5. Select the Options button from Build repository section:

- Clients connections: define the maximum number of files that can be downloaded simultaneously. Ensure the server is configruated properly if this number is superior to 1.

- Favorite server set to autoconfig: the favorite servers informations defined into Online panel can be attached to the autoconfig file this way. Also when user will connect to the repository or import the autoconfig url, the user's Online panel will be automatically updated with these informations.

- Repository files excluded from build: this option is typically useful for the Web server administrators who like to add an empty index.html file at root of the repository see.

- Repository folders with excluded extra local when sync: this option is typically useful for the userconfig folder see. Thus the local content will not be marked as to be deleted on user synchronisation see.

6. Select the Build button. The system will create a .a3s folder inside the repository which contains the needed data for the synchronization see.

6. Give the auto-config url to the users (public access only).

7. The Check repository synchronization command allow to check for files repository and synchronization data correspondence at any time see.


Update addons repository

1. Add, change or remove addons inside the root shared folder.

2. Do a build repository.


Administrate a repository using command line

1. On the terminal, run the script ArmA3Sync-console.bat (Windows) or ArmA3Sync-console.sh (Linux).

2. Then enter one of the command line see.


Administrate a repository using custom script

Custom script can be use to perform automatized operations on the repository.

Create a .bat (Windows) or .sh (Linux) script at root of ArmA3Sync installation directory with one of the following command:

- Build repository: Java -jar ArmA3Sync.jar -BUILD "RepositoryName"

- Check repository synchronization: Java -jar ArmA3Sync.jar -CHECK "RepositoryName"

- Synchronize a target folder content with a repository: Java -jar ArmA3Sync.jar -SYNC "RepositoryName" "DestinationFolderPath" True/False (with/without exact content matching)

- Check for ArmA3Sync updates: Java -jar ArmA3Sync.jar -UPDATE

Use as a mission maker

Create an event

1. Select an entry into the Repositories table see.

2. Select the Edit button. Give the informations for an account that have read and write permissions on the repository.

3. Select the Connect to repository button see. The repository management interface should open.

4. Select the Events button see.

5. Select the Add a new event button. Add a name and a description see.

6. Select the wanted addons for the mission. It is possible to indicate that an addon is optional. To do so, select the addon and do a right click see.

7. Select the Upload Events informations button see.

8. Select the Repositories panel. A new entry showing name and description of the mission must appear see.

Miscellaneous

ACRE installer

This wizard will help installing @ACRE addon for ArmA 3 and TS3. It will detect the operating system and TS3 versions and perform installation of ACRE userconfig folder and TS3 plugin.

1. Install @ACRE and @JayArmAXlib addons.

2. Turn off TS3 if running.

3. Select the Tools menu then choose ACRE installer.

4. Check out the paths to the directories then choose Proceed button see.

5. Installation finished successfully see.


TFAR installer

This wizard will help installing @tak_force_radio addon for ArmA 3 and TS3. It will detect the operating system and TS3 versions and perform installation of task force radio userconfig folder and TS3 plugin.

1. Install @task_force_radio addon.

2. Turn off TS3 if running.

3. Select the Tools menu then choose TFAR installer.

4. Check out the paths to the directories then choose Proceed button see.

5. Installation finished successfully see.


AiA Tweaker

This wizard will help you configurate paths for ArmA 2, ArmA 1 and TOH for correct usage of @AllInArmA addon.

1. Select the Tools menu and choose AiA Tweaker.

2. Check out the paths to the directories and press the OK button see.

3. In the Game Version section select ArmA 3 - AiA then Start Game see.

4. Look into the mission editor and check out that previous ArmA maps are displayed see.


RPT Viewer

This tool can display in a console the content of the RPT file as game is writing.

1. Select Tools menu and choose RPT Viewer.

2. Select File then choose Select RPT.

3. The content of the RPT file should be displayed see.