Usage documentation

 

Six Updater 2.0 is based on the previous updater and therefore the mechanics currently are much the same.

All features are documented within the program, just hover over an option, button, textbox or any number of other UI elements to get information.

 

Check Basics below, and the +FAQ.

 

 

Basics

 

The updater is designed as a multi-purpose tool. It does not only support client-side mod update, but also running and configuring (dedicated) servers, multiple preferences and configurations.

 

The updater fetches server information from gamespy (Sync servers), as well as default presets, game profiles, mods, mirrors etc from the Updater Server Portal (Sync).

Additionally, the updater can fetch additional server configuration from servers with +CustomRepos setup.

 

The updater can function as a game launcher and server browser - with the ability to join a server with automatic mod selection, download and update.

Specific community / server guides+requirements are usually listed on the information webpage for that community / server.

 

Furthermore there is support for Automations, Modfolder conversions and Linux. Seethe +FAQfor more details.

 

Models

  • Presets are a combination of Mods, Game Profile, Server and Action.
    The checkboxes and selection boxes on the Home RibbonTab, Actions and Selections, function as overrides for selected preset.
  • Game Profiles determine the game edition, various paths, exe files, startup parameters and if Beta and/or server mode is enabled.
  • Serverscan contain mods and apps, automatically selected when joining a server. You can also save passwords.
  • Actionsare the various Updater actions that can be executed with selected preset and overrides. (Run updater button menu)
  • Apps are either ServerApps (TeamSpeak/Mumble), ModApps (e.g put Jayarmalib's dsound.dll into correct place) and LocalApps (e.g to start Track-IR, Fraps or other software with the game).
  • Mirrorsare SU official network servers, serving Mods.
  • Custom Reposare SU custom repositories (Community/Clan hosted Mods, Apps, Missions, etc)
  • Hostsare SU custom repository mirrors
  • Modsare the mods available on the official SU network
  • Local Modsare mods found in your game and mod installation folders, which are either not found on the SU networks or are not yet converted.

 

Game Editions

You can select different game editions in Profiles selection box. There are auto detect profiles and specific profiles.

  • Rv3- Real Virtuality 3 Engine (A2/OA/TOH)
    • Arma2 - The whole arma2 series
      • Arma2St - Arma2 original standalone
      • Arma2Ca - Arma2 original, so either standalone or combined ops
      • Arma2Oa - Whole OA series (OA standalone, combined ops..)
        • Arma2OaSt - OA Standalone
        • Arma2OaCo - OA Combined Ops (original + OA)
    • Takeonh - The whole Take on Helicopters series
      • TakeonhSt - Take on Helicopters Standalone
      • TakeonhRa - Take on Helicopters Rearmed
        • TakeonhRaA2 - Take on Helicopters Rearmed (A2)
        • TakeonhRaOA - Take on Helicopters Rearmed (OA)
        • TakeonhRaCO - Take on Helicopters Rearmed (CO)

 

Paths

You can configure these from the Options dialog, accessible from the app menu (blue button left up).

  • Game Path - Game folder
  • Mod Path - Custom mod installation folder. Defaults to Path.
  • Server Mods Path - Custom server mods installation folder. Defaults to ModPath.
  • Pack Path - Where should the mod archives be stored? Modarchives are used for updating and repairing modfolders. By default they are contained in each modfolder\.rsync\.pack.
Path is automatically detected from Registry, but can be overriden:
  • Globally in Options (Lowest priority)
  • Per Game Profile
ModPath can be set the same, but additionally also per mod, and supports relative paths (relative to Game Path).
ServerModsPath can be set the same, but additionally also per server, and supports also relative paths (relative to ModPath).
 

Local (Custom) Mods

Non SU mods can be added at the bottom of the Mods tab."Local Mods".
In case you have a server selected and a mod doesn't show up, disable the "Allowed Filter".
Click the refresh button to scan the game and mod installation folders for new mods.
 

Conversion

If you would like the updater to update a mod available on the SU network or some custom repository, while you already have the mod or a version of it installed, you can add the mod to your preset, and run the 'Convert' action, to first convert the modfolder to a usable format.

You can then use Install or Update action as usual, to update to the correct version.

 

Mod Status Colors

  • Special - Purple
  • Disabled-Gray
  • Check - Yellow
  • Install - Blue
  • Incompatible - Black
  • Not Updater Mod - Brown
  • Not Updater Mod and no Source found on SU network - White

 

Mod Status Signs

  • S - Server requirement
  • D - Dependency for other Mod(s)
  • L - Local Mod (not on the official or loaded custom repo)
  • C - Custom repository mod

 

 

Server Owners

 

Updating your server with SU

 

You can update your server in several ways with Six Updater.

 

Ideally you have a Windows server and can run the Six Updater software on it. The "Server" checkbox enables dedicated server exe and the Game Profile ribbontab contains several options to configure startup parameters.

Full dedicated server configuration options (difficulty settings, missions, server settings) are planned.

 

If you have a Linux server you can take a look at the old legacy Six Updater Suite+Linux which is also available on Linux.

It contains tools for console, as well as local and (optionally) remotely manageable webinterface.

 

If you have a server with only limited access (FTP / rSync Upload), you can use the SU's Upload Preset options, available on the Preset ribbontab, after enabling "Advanced Mode".

Check out: +Upload Preset.

 

Repository Hosting

 

You can host a custom repository with Mods (+versions)and Missions to your choosing, incl additional configuration like TeamSpeak server (auto-join, incl channel and password), etc.

 

Custom Repository:+CustomRepos Setup

Official Mirror: +Mirror Setup

 

rSync requires specific server setup with rSync daemon, where-as zSync only requires a simple web-server.

Hosting both should provides the best chance of successs even with elaborate firewall/antivirus/router types/configurations.

 

 

Tech Info

 

Configuration database / log files

  • Default location:C:\users\{username}\appdata\roaming\Six-Updater.
    Fall back:C:\users\{username}\appdata\local\temp\Six-Updater
  • XP Users:C:\Documents and Settings\{username}\application data\Six-Updater.
    Fall back:C:\Documents and Settings\{username}\local settings\temp\Six-Updater
Updater data is stored indb/production.sqlite3, while queue/configuration is stored insix-updater.yml.Reference.
 
UI State and other application settings
  • Vista/7 Users:
    C:\users\{username}\appdata\local\SIX_Projects\Six_Updater_GUI.exe_***************
  • XP Users:
    C:\Documents and Settings\{username}\local settings\application data\Six_Projects\Six_Updater_GUI.exe_***************
Stored in user.config
 
These folders areHidden by defaultand don't exist until the software has been started once.
 

 

Firewalls, ports and security/antivirus

Those with funky security systems, please note the following requirements

  • Six Updater GUI.exe (and/or Six Launcher.exe)will make outgoing connections to the updater-server-site, over port 80/TCP, and to various RubyGems sites to fetch the latest updater libraries.
  • SixUpdateCheck.exe will make outgoing connections to the updater-server-site, over port 80/TCP to fetch latest program data.
  • tools\bin\rsync.exewill make outgoing connections to various rsync servers, over port 873/TCP, and possibly 873/UDP.
  • tools\cygwin\bin\zsync.exewill make outgoing connections to various zsync (http web) servers, generally over port 80/TCP, yet any port is possible.
  • tools\gslist.exewill make outgoing connections to various arma servers, incl the gamespy master server.
For Server owners with custom repository, please note the following additional requirements
  • tools\cygwin\bin\lftp.exewill make outgoing connections to various ftp servers, generally over port 21/TCP, yet any port is possible.
  • tools\cygwin\bin\ssh.exewill make outgoing connections to various servers, generally over port 22/TCP, yet any port is possible. incase of FTP over SSH.
  • tools\bin\ssh.exewill make outgoing connections to various servers, generally over port 22/TCP, yet any port is possible. incase of rSync over SSH.

Please make sure the mentioned applications are fully allowed in your firewall software.

Please also check Software not working due to Antivirus.

 

Commandline parameters

Six Updater GUI.exe (GUI);

  • --skip-autoupdate
    • Do not run the auto-self-update program. Especially useful for use in automation tools
  • --preset=preset_id
    • Select preset
  • --server=192.168.0.1:2302
    • Select or create Server
  • --execute
    • Execute whatever preset is selected
  • --execute=action1,action2,action3...
    • Execute whatever preset is selected, but perform specified actions. E.g: convert,update,startgame
  • --shutdown
    • Shutdown the application after specified tasks have finished
Url handlers
These urls work from within web-browsers, start->run and command prompt / shortcuts (startup parmeters)
 

SixUpdateCheck.exe (Auto Self Updater)

  • --start-gui
    • Start the GUI after finishing self-update.
 

SixUpdater.exe (Console);

Usage: [config.yml] [options] -v, --[no-]verbose Run verbosely -i, --install Installs the mods, unless already installed -d, --uninstall Uninstalls the mods, unless not installed -u, --update Updates each mod to latest version -n, --convert Convert each mod available on the updater network to updater -r, --reset Resets the modfolders to latest commit status. All modifications lost -z, --userconfig Processes the userconfigs of each mod. Makes backups of previous files -k, --keys Processes the keys of each mod. Removes old keys automatically -l, --changelog Display Changelog after update -c, --cleanup Cleans up the modfolders git repositories -a, --afteraction Runs user-configurable after-action script -s, --createshortcut Creates shortcut to run the game with the mods, in installation folder -t, --createdesktopshortcut Creates shortcut to run the game with the mods, on the desktop -j, --join Starts the game with -noSplash -noFilePatching -showScriptErrors -mod= -connect= -port= -g, --startgame Starts the game with -noSplash -noFilePatching -showScriptErrors -mod= -w, --wait Waits at the end for user pressing ENTER -f, --force Forces to run tasks even though no changes were detected -q, --kill Kills the open processes --mods S Additional Mods --apppath S Destination folder

 

SixZsync.exe(Low level zSync, rSync, http/ftp functionality)

TODO

 

SixRsync.exe (Low level rSync functionality)

Deprecated - superseeded by SixZsync

Usage: six-rsync [folder] [options] -v, --[no-]verbose Run verbosely -i, --init Initializes Repository -s, --status Status of Repository -u, --update Updates Repository -c, --commit Commits changes to Repository -n, --convert Converts into repository --clone S Clones a Repository -o, --info Shows information from repository -l, --log Write logfile

 

Dev info

 

See +Development.

 

Components

  • Custom Icon Pack, logo - Paragraphic L
  • IronRuby - Microsoft / IR team
  • IREmbeddedApp
  • GeoIP
  • HashEncryption
  • NBug
  • ThreadSafeObservableCollection
  • UacHelper
  • ActiveRecord, ActiveSupport by Rails team
  • I18n
  • Log4r
  • Countries Library
  • DataGridFiltering Library


 

 

Personal Blog

 

Six Updater News moved to:

http://www.six-updater.net

 

 

Wheeled by Wagn v. 1.10.7