WebSync – How to (Deutsch)

— English version —

Instructions for the use of the WebSync

Contents

 

Creating a Series

To create a series in the sync several steps are necessary.

  1. Creating a directory on the Sync Server with an FTP (do not use spaces or special characters in the directory name!).
  2. Data upload
  3. Using the WebSync in order to define a series
  4. Indexing the series
  5. Test run
  6. Finishing touches

We recommend the use of an ftp-client like FileZilla to connect to the ftp-server. The use of an browser like Internet Explorer, Firefox, etc. is inadvisable and will issue problems!

 

1. Creating a directory on the Sync Server with an FTP client

Your password will grant you access to your area of the sync server with an FTP client. The server is located at the address “ftp.simsync.de”. Once you have established a connection you will find yourself in your FTP root directory.

Now, create a new directory (for example: alms), which will be used as the series basefolder. Do not use spaces or special characters in the directory name. Capital letters are allowed, but lower case letters are preferred.

 

2. Data upload

Hint!
Unfortunately, FTP uploads loose the timestamp of the file during transfer and the server usually assigns current date / time. Due to that, the sync recognize this file as “newer” as the local file and overwrites it during the syncing operation.
To prevent this, you should use an FTP client, which is able to keep the timestamp of the transferred files (eg FileZilla).
If you use such a client, do not forget to enable this option… 😉

Upload your data into the new directory (the series basefolder).
The structure of the data must be similar to the way it is in a mod, car and track pack. I.e., that all the files must use the same relative path starting from the series basefolder just as it would be on a local machine starting from the game directory.
For example, if tracks are located on the local machine at C:\Games\rFactor\gamedata\locations, they must be placed on the server into /<series basefolder>/gamedata/locations.
If you need to place data outside the game basefolder, for example in the games documents folder C:\User\<username>\Documents\Assetto Corsa Competizione\Customs\, than there are so called specialfolders that you can use to manage the data there. For example, the path in the previous example needs to use the specialfolder _DOCUMENTS_ to access the documents folder: /<series basefolder>/_DOCUMENTS_/Customs/. Click here to learn more about specialfolders.
This applies to all data that is transmitted.

 

3. Using the WebSync in order to define a series

While the data is being copied to the server (or afterwards), use the WebSync to define the series.

  1. Click on the button [New Series].
  2. Enter the required data and set the options to your likings:
    1. Series enabled?
      As long as “No” is selected, the series will not be displayed in the SimSync PRO (sync).
    2. Game
      Choose the right game. An rFactor series will only be displayed in the SimSync PRO, if the sync is located in the rFactor root directory.
    3. Name
      Enter the name of the series the way you want it to be displayed in the sync. Each name can only be used once.
    4. Series basefolder
      Select the name of the created series basefolder (i.e., alms).
    5. Delete unused mods, tracks, etc.?
      If set to “YES”, all files that are not in the sync and that are not protected by the setting “Undeletable”, will be deleted. Use with caution!
    6. Delete sub-folders
      Here you can specify, in which folders the sync is allowed to delete unused sub-folders. The entered path MUST ALWAYS be relative to the basefolder of the game, except it starts with a specialfolder like _DOCUMENTS_, that is supported by the game! The specialfolders _ROOT_ is not allowed to be used here!
      Unknown files will be deleted anyway, as long as if “Delete unused mods / tracks?” is set to “YES”. However, directories below the specified directories are deleted only if the files in the directories are managed by the sync.
      This setting is only used, if “Delete Unused Mods / tracks?” is set to YES.
      Please note: 1 path per line! Max 1 wildcard (*) per path! _ROOT_ is not allowed! Use only specialfolderss that are supported by the game (see Series basefolder, Supported specialfolders)!
    7. Undeleteable
      Directories given here will be definitely NOT be deleted. specialfolderss, except _ROOT_ can also be used here.
      In rFactor this should apply for: UIData, RFM, gamedata/vehicles, gamedata/locations
      In GTR2 and GTL this should apply for: gamedata, gamedata/locations
      Please note: 1 path per line! Wildcards (*) are not allowed! _ROOT_ is not allowed! Use only specialfolderss that are supported by the game (see Series basefolder, Supported specialfolders)!
    8. Local configuration files to protect
      Enter here a list of local configuration files, which shouldn’t be overwritten by the sync, even if they do not match the server content.
      Example: app1/app1.ini
      Please note: 1 file incl. relative path per row! 1 Wildcard (*) are permitted in the filename (NOT the path!) e.g. app1/*.ini is OK; app*/app1.ini is wrong! _ROOT_ is not allowed! Use only specialfolderss that are supported by the game (see Series basefolder, Supported specialfolders)!
    9. Scan & Delete
      Enter here those folders which the sync MUST scan for unknown files and folders, even if no file is located in that folder. The sync “knows” folders only, if files are located in that folder or the folder is located in a folder with files managed by the sync.
      This parameter is useful, if you remove a mod from your series and the sync doesn’t recognize it. By adding the basefolder of the mod to this field, the sync will scan it and delete the removed files.
      Please note: 1 path per line! Wildcards (*) are not allowed! _ROOT_ is not allowed! Use only specialfolderss that are supported by the game (see Series basefolder, Supported specialfolders)!
    10. Protect original game files?
      If set to “YES”, the sync will protect all original game files from being deleted by the sync. This setting is not available for all games. In that case this setting will be greyed out. The most uptodate list of the supported games is displayed below the setting.
    11. Password
      The series can be protected by a password. The user will be asked to enter the password, BEFORE syncing any files. This means, if the password is wrong, no files will be transferred. This option should be used at least during testing.
    12. SteamIDs
      Enter here a list of SteamIDs (SteamID64), that should have access to this series. Users with a SteamID not listed here, will not be able to sync the series!
      Use the buttons “Sort & Count” and “Check names” to verify, if the entered SteamIDs are valid and sort the numbers ascending.
      If you do not know how to find the SteamID, click on the following link to view a tutorial video about How to find the SteamID. Thanks to “Killerturcky” for sharing this video.
    13. Changelog mode
      Should the changelog be displayed on syncing and if yes, when? Choose between Manual (open the changelog manually from the series context menu), Before (the syncing starts) and After (the sync has finished).
      This option is always available in the websync, but if the changelog is empty, this setting has no influence.
    14. Readme mode
      Should the readme (if available) be displayed on syncing and if yes, when? Choose between Manual (open the changelog manually from the series context menu), Before (the syncing starts) and After (the sync has finished).
      Readme’s must be saved to the series basefolder and can be either in .txt or .md (Markdown) format. e.g. readme.txt or readme.md
      Localized versions of the readme must me named according the following scheme: readme_xx.txt (or .md) where xx is the 2-char language code like “de”, “en” or “fr”. So the final filename looks like this: readme_fr.txt
      If both, a general and a localized version of the readme are available, the localized version will be used. If no localized version for your language is available, you will get the general readme.txt (or .md).
      This option is always available in the websync, but if no readme is available, this setting has no influence.
  3. Click [Save] to save the series.

 

4. Indexing the series

After all the data has been uploaded and the series has been created in the WebSync, you need to create the file index. Click [Index] for the corresponding series in order to create/update the file index.

The index is necessary because it makes the Sync recognize which files are new (or have been modified) and therefore need to be downloaded.

 

5. Test run

Before you release a series to the public you should test it.

In order to do this, protect the series with a password that only you know.
Enable in the the sync the option “Show preview”, so you get a list of file that will be downloded or deleted. Check this list exactly, especially the files and folders which the sync will delete. Check if there are files/folders, that you don’t expect to get deleted.
In that case, try to modify the settings, so that no files or folders get deleted, that shouldn’t get deleted…
Once you have optimized the settings, do not forget to remove the password (or to replace it with the previous one).

Hint!
If you have the chance to create a copy of your game installation, you should do this and run your tests on this installation, because wrong settings or a faulty data structure can lead to errors in the game and/or loss of data and consequently force you to reinstall everything.

A backup of the game installation can save a lot of time … 😉

 

6. Finishing touches

After all the important steps have been checked and a successful test run carried out, it is now time to let the drivers synchronize the series.
If you have not yet deleted or restored the password, you should do so. Or you can forward the new password to the drivers.

Do not forget to sync the game server as well! 😉

 

Modifying a Series

  1. Data Transfer
  2. Editing
  3. Indexing
  4. Test run
  5. Finishing touches
1. Data Transfer

First, you should disable the series you want to update. This makes sure, that nobody is syncing the series while you are updating it. After that, you can start to upload the new or changed data via an FTP client to the sync server. If you find unnecessary files, you should delete them from the server.

 

2. Editing

If you need to change any setting of the series, click on the [Edit] button to open the series in edit mode. Apply your changes and do not forget to save the series. A description of the fields can be found in the “Create a series” section.

 

3. Indexing

Whenever new or changed files have been uploaded or files were deleted from the server, the file index of the series MUST be recreated.

Do not forget forget to index the series, if the content of the series has changed!

 

4. Test run

See the “Test run” section in the “Create a series” area.

 

5. Finishing touches

In case you disabled the series in step 1, do not forget to enable it again… 😉

Do not forget to sync the game server as well! 😉

 

Deleting a Series

  1. How to delete a series in the WebSync
  2. How to delete the series data via an FTP client

 

1. How to delete a series in the WebSync

To delete a series in WebSync, click on [Edit] for the corresponding Series.
On the next page you will find a [DELETE] button at the bottom right of the page. Click on the button to start the deletion process.
After you confirm the following prompt, the series is removed from WebSync. However, the files on the server still exist!

 

2. How to delete the series data via an FTP client

The second step is to delete the files of the series using an FTP client. Simply delete the base directory of the series on the sync server.
Attention! There is NO Undelete function! Files that have been deleted are lost!

 — Deutsche Version —

Anleitungen für den Gebrauch des WebSync

Inhaltsverzeichnis

  • Serie anlegen
  • Serie ändern
  • Serie löschen

Serie anlegen

Um eine Serie im Sync anzulegen, sind verschiedene Schnitte notwendig.

  1. Per FTP ein Verzeichnis auf dem Sync-Server anlegen. (Keine Leer- und Sonderzeichen für den Verzeichnisnamen verwenden.)
  2. Daten hochladen
  3. Im WebSync die Serie definieren
  4. Die Serie indizieren
  5. Testen
  6. Fertig

Wir empfehlen für den Zugriff auf den FTP-Server ein FTP-Programm wie z.B. FileZilla http://filezilla-project.org/ . Die Verwendung eines Browsers wie Internet Explorer, Firefox, etc. ist nicht zu empfehlen!

1. Per FTP ein Verzeichnis auf dem Sync-Server anlegen.

Mit deinen Zugangsdaten bekommst du FTP-Zugriff auf deinen Bereich des Sync-Servers. Erreichbar ist er über die Adresse “ftp.simsync.de”. Nach dem du die Verbindung aufgebaut hast, landest du in deinem FTP Basisverzeichnis.

Lege nun ein neues Verzeichnis an (z.b. alms). Verwende für den Verzeichnisnamen keine Leerzeichen oder andere Sonderzeichen. Großbuchstaben sind erlaubt, allerdings sollte Kleinschreibung bevorzugt werden.

 

2. Daten hochladen

Hinweis!
Leider ist es beim FTP-Upload üblich, daß der Zeitstempel der Datei verloren geht und die Datei auf dem Server normalerweise immer das aktuelle Datum/Zeit erhält. Das bedeutet, das der Sync beim späteren Syncen davon ausgeht, das die Datei auf dem Server “neuer” ist, als die lokale Datei und diese überschreiben wird.
Um das zu verhindern sollte man die Dateien mit einem FTP-Client hochladen, der den Zeitstempel der übertragenen Datei beibehalten kann (z.B. FileZilla).
Wenn Sie so ein Programm verwenden, vergessen Sie nicht diese Option zu aktivieren… 😉

Lade nun deine Daten in das neu erzeugte Verzeichnis (Serienbasis) hoch.
Die Struktur der Daten muss dabei ähnlich wie bei einem Mod-, Car- oder Trackpack sein. Soll heißen, das sämtliche Dateien den gleichen relativen Pfad ab der Serienbasis haben müssen wie auf dem lokalen Rechner ab dem Spielverzeichnis.
Zum Beispiel, wenn Strecken auf dem lokalen Computer unter C:\Games\rFactor\gamedata\locations sind, dann müssen Sie auf dem Server unter /<Serien Basisordner>/gamedata/locations gespeichert werden.
Wenn Daten ausserhalb Basisordner des Spiels gespeichert werden müssen, z.b. C:\User\<Benutzer>\Dokumente\Assetto Corsa Competizione\Customs\, dann musst Du sogenannte Spezialordner verwenden, um deine Daten dort zu speichern und zu managen. Der genannte Pfad kann erreicht werden durch den Spezialordner _DOCUMENTS_. Auf dem Server wäre der Pfad folgendermaßen: /<Serien Basisordner>/_DOCUMENTS_/Customs/. Klicken Sie hier um mehr über Spezialordner zu erfahren.
Das gleiche gilt für sämtliche zu übertragenden Daten.

3. Im WebSync die Serie definieren

Während, bzw. nachdem die Daten auf den Server kopiert werden/wurden, kann per WebSync die Serie für den Sync angelegt werden.

  1. Klicke auf [Neue Serie].
  2. Trage die geforderten Angaben ein:
    1. Serie aktiv?
      Solange hier “Nein” gewählt ist, wird die Serie im Sync nicht angezeigt.
    2. Spiel:
      Wähle das richtige Spiel aus. Eine rFactor Serie, für die hier beispielsweise GTR2 angegeben wurde, wird im Sync nur unter GTR2 angezeigt.
    3. Name:
      Gib’ hier den Namen der Serie, wie Sie im Sync angezeigt werden soll ein. Jeder Name kann nur 1x verwendet werden
    4. Serien-Basisverzeichnis:
      Hier kommt der Name des per FTP angelegten Verzeichnisses rein (z.B. alms)
    5. Ungenutzte Mods/Strecken löschen?
      Wenn der Schalter auf “JA” steht, werden alle Dateien, die nicht im Sync stehen und durch den Parameter “Unlöschbar” geschützt sind, gelöscht. Hier also besondere Vorsicht walten lassen!!!
    6. Unterverzeichnisse löschen:
      Hier kann man festlegen, in welchen Unterverzeichnissen der Sync unbenutzte Unterverzeichnisse löschen darf. Dateien werden (sofern “Ungenutzte Mods/Strecken löschen?” auf “JA” steht) immer gelöscht. Allerdings werden Verzeichnisse, die unterhalb der angegebenen Verzeichnis liegen nur dann gelöscht, wenn vom Sync verwaltete Dateien in den Verzeichnissen stehen.
      Wird nur verwendet, wenn “Ungenutzte Mods/Strecken löschen?” auf JA steht.
      Bei der Eingabe beachten: 1 Pfad pro Zeile! Max. 1 Wildcard (*) pro Pfad
    7. Unlöschbar:
      Hier werden die Verzeichnisse angegeben, die definitiv NICHT gelöscht werden dürfen und deren Inhalt nicht gelöscht werden darf.
      Für rFactor ist das im allgemeinen: UIData, rFM, gamedata/vehicles, gamedata/locations
      Für GTR2 und GTL: gamedata, gamedata/locations
      Bei der Eingabe beachten: 1 Pfad pro Zeile! Wildcards (*) sind nicht erlaubt!
    8. Zu schützende lokale Konfigurationsdateien:
      Geben Sie hier eine Liste der lokalen Konfigurationsdateien ein, die nicht durch den Sync überschrieben werden sollen, auch wenn sie nicht mit dem Inhalt des Servers übereinstimmen.
    9. Scannen & Löschen:
      Hier werden Verzeichnisse angegeben, die auf alle Fälle nach unbekannten Dateien und Verzeichnissen durchsucht werden sollen. Der Sync “erkennt” Ordner nur dann, wenn Dateien darin liegen, bzw. der Ordner in einem Ordner liegt der Dateien enthält.
    10. Original Dateien des Spiels schützen?
      Ist diese Option aktiv (JA), werden die Originaldateien des Spiels gegen Löschen geschützt.
      Diese Funktion ist zur Zeit u.a. für folgende Spiele verfügbar: rFactor, GTR2, GT Legends, F1 Challenge 99-02, NASCAR Racing 2003. Die aktuelle Liste der unterstützten Spiele wird Ihnen unterhalb der Funktion angezeigt.
    11. Kennwort:
      Hierüber kann der Serie ein Kennwort gegeben werden. Nur wenn vor dem syncen das korrekte Kennwort eingegeben wird, kann die Serie gesynct werden. Diese Option solltest du zumindest solange wählen, bis die Serie getestet ist.
    12. Changelog Modus:
      Siehe https://www.simsync.de/websync-readmes-changelogs/
    13. Readme Modus:
      Siehe https://www.simsync.de/websync-readmes-changelogs/
    14. SteamIDs:
      Siehe https://www.simsync.de/websync-steamid/
  3. Klicke auf [Speichern] um die Serie in der Sync Konfiguration zu speichern.
4. Die Serie indizieren

Nachdem sämtliche Daten hochgeladen und die Serie im WebSync angelegt wurde, muss nun noch der Sync-Index erstellt werden. Wähle dazu die Serie aus und klicke auf [Indizieren].
Der Index ist notwendig, damit der Sync erkennt, welche Daten neu sind und heruntergeladen werden müssen.

5. Testen

Bevor du die Serie auf die Allgemeinheit loslässt, solltest du Sie testen.
Mach dazu am besten eine Kopie deiner Spieleinstallation, da es je nach Einstellung oder durch eine falsche Dateistruktur zu Fehlern im Spiel kommen kann, die eine Neuinstallation nach sich ziehen würden. Eine Kopie der Installation spart da einiges an Zeit …

6. Fertig

Nachdem nun sämtliche Punkte abgehandelt und getestet wurden und alles funktioniert ist nun alles bereit, das deine Fahrer die Serie per Sync herunterladen.
Solltest du ein Kennwort hinterlegt haben, kannst dieses natürlich auc wieder entfernen oder du teilst es deinen Fahrern mit.
Nicht vergessen, den Gameserver zu syncen … 😉

 

Serie ändern

  1. Daten Übertragen
  2. Serie bearbeiten
  3. Serie indizieren
1. Daten Übertragen

Zuerst musst du die geänderten oder neuen Daten per FTP auf den Sync-Server Übertragen. Fallen Dateien weg, können Sie per FTP vom Server gelöscht werden.

2. Serie bearbeiten

Bei Bedarf kann die Serie, nachdem sie einmal angelegt wurde, per WebSync bearbeitet werden.

 

3. Serie indizieren

Jedesmal, wenn neue oder geänderte Dateien zum Sync-Server Übertragen, oder Dateien vom Server gelöscht wurden, MUSS die Serie neu indiziert werden.
Dieser Schritt MUSS nach jeder Änderung durchgeführt werden!!!

 

Serie löschen

  1. Serie im WebSync löschen
  2. Daten der Serie per FTP löschen
1. Serie im WebSync löschen

Um eine Serie im WebSync zu löschen, klicke bei der betroffenen Serie auf [Bearbeiten].
Auf der nun folgenden Seite findest du unten rechts eine Schaltfläche [LÖSCHEN].
Nachdem du die nachfolgende Sicherheitsabfrage bestätigt hast, wird die Serie aus der Sync Konfiguration gelöscht. Die Daten auf dem Server sind jedoch noch NICHT gelöscht!

 

2. Daten der Serie per FTP löschen

Im zweiten Schritt musst du die Daten der Serie per FTP löschen. Lösche hierzu das ursprünglich angelegte Serien-Verzeichnis.
ACHTUNG!!! Dieser Schritt lässt sich NICHT rückgängig machen!!! Eine Kopie/Backup deiner Daten existiert auf unserem Server NICHT!!!