Skip to content

Installation

Aperture Development edited this page May 12, 2020 · 6 revisions

Workshop ( recommended )

For this way you need to add a workshop collection to your server and add MSync 2 to it. This way your server will automatically update to the newest MSync 2 version when it gets released and you restart your server.

  1. First create a workshop collection and add all Workshop addons to it that you need. You can also add ULib and ULX to it. Then add MSync 2 ( https://steamcommunity.com/sharedfiles/filedetails/?id=1636008512 ) to the collection.

  2. Setup a steamAPI key, you need that for the server to be able to download Workshop addons. To do that navigate here and log in with your steam account. Then enter a domain name and click "Register". You should not be presented with a key. Note the key down as we need it later.

  3. Add the parameters +host_workshop_collection <collection id> -authkey <steam api key> to your servers startup options. Replace <collection id> with your collection id, you can find it by copying the link to your collection, the number at the end of the link is your workshop collection id ( https://steamcommunity.com/sharedfiles/filedetails/?id=1193880553 => CollectionID: 1193880553 ). When you added your collection ID, just replace <steam api key> with your steam api key. The Result should look simelar to this: +host_workshop_collection 1193880553 -authkey E8000000000001

  4. Done, when you start your server it should automatically download and install all addons from your collection

GitClone

Another way of setting up MSync is using GitClone, that way you can update MSync using one command. For this you need to have Git installed on your server. You can get it for Windows and Linux

  1. Navigate to the garrysmod/addons folder and open a terminal here.

  2. Use git clone https://github.com/Aperture-Development/MSync-2.git in your console to download MSync into the addons folder.

  3. Done! now you should have a folder called "MSync-2-master" in your addons folder

To update MSync 2, stop your server and navigate to the garrysmod/addons/MSync-2-master folder. Now open a terminal here and type git pull origin master

Manually

This way does not require any additional software or setup steps, but it also does not support automatic or easy updating.

  1. Download the latest MSync-2 release from here: https://github.com/Aperture-Development/MSync-2/releases

  2. Open the zip file and Drag & Drop the MSync-2-master folder into garrysmod/addons

  3. Done! The addon is now installed and will be avaiable at the next server start

Clone this wiki locally