WebSync – How To (English)

Die deutsche Version der Anleitung findest du HIER


Instructions for the use of the WebSync


  • Creating a Series
  • Modifying a Series
  • Deleting a Series


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 a series
  5. Test Run
  6. Finishing Touches

We recommend the use of an ftp-client like FileZilla filezilla-project.org/ to connect to the ftp-server. The use of an internet browser like Internet Explorer, Firefox, etc. is inadvisable.

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 series’ root directory. Do not use spaces or special characters in the directory name. Capital letters are allowed, but lower case letters are preferred.


2. Data Upload

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 must use an FTP client which is able to keep the timestamp of the transferred files (eg FileZilla filezilla-project.org/).

If you use such an client, do not forget to enable this option… ;)\

Upload your data into the new directory (the series root directory).

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’ root directory just as it would be on a local machine starting from the game directory.

For example, if tracks are located on a local machine at C:\Games\rFactor\gamedata\locations they must be placed into \series root directory\gamedata\locations on the server.

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) you can use the WebSync to define the series.

3.1. Click [New Series].
3.2. Fill in the required data:
3.2.1. Series enabled? As long as “No” is selected the series will not be displayed in the SimSync PRO (sync).
3.2.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.2.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.
3.2.4. Series Home Directory: Select the name of the created series root directory (i.e., alms).
3.2.5. Delete unused Mods / tracks? If set to “YES”, all files that are not in the sync and that are not protected by the parameter “Undeletable” will be deleted. Use with caution!
3.2.6. Delete Subdirectories: Here you can specify in which directories the sync is allowed to delete unused subdirectories. Unknown files will be (as long as if “Delete unused Mods / tracks?” is set to “YES”) deleted anyway. However, directories below the specified directories are deleted only if the sync files are managed in the directories.
Used only if “Delete Unused Mods / tracks?” is set to YES.
Please note: 1 path per line! Max 1 wildcard (*) per path
3.2.7. Undeleteable: Directories given here will be definitely NOT be deleted.
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!
3.2.8. Scan & Delete: This parameter is supported only with version 3.5 and up. Enter here that folders which the sync MUST scan for unknown files and folders, even if no file is locatedin that folder. The sync “knows” folders only, if files are located in that folder or the folder is located in a folder with files.
3.2.9. Protect original game files? This parameter is supported only with version 3.5 and up. If set to “YES”, the sync will protect all original game files from being deleted by the sync. This function is available only for the following games: rFactor, GTR2, GT Legends, F1 Challenge 99-02, NASCAR Racing 2003. The most uptodate list of the supported games is displayed below the function.
3.2.10. 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.
3.3. Click [Save] to save the series.


4. Indexing a series

After all the data has been uploaded and the series has been created in theWebSync you need to create the Sync index. Click [Index] for the desired series in order to create/update the sync 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 you should create a clean copy of your game installation because 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.

Making a copy of the game installation can save a lot of time … 😉


6. Finishing Touches

After having checked all the important steps having conducted a auccessful test run it’s now time to let the drivers sync the series.
If you have implemented a password you can either remove it or share it with your drivers.
Do not forget to sync the game server, too … 😉


Modifying a Series

  1. Data Transfer
  2. Editing
  3. Indexing
1. Data Transfer

First, you need to upload the new or changed data via an FTP client to the sync server. Unnecessary files can be deleted from the server via an FTP client.
Depending on the amount of data, it can be advisable to disable the series in order to prevent users from experiencing errors which could occur if someone is running the sync while you are updating the content.


2. Editing

If necessary, edit the series using the WebSync.


3. Indexing

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

This step MUST be performed after each change!

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


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 the WebSync, click on [Edit] for the relevant Series.
On the next page you will find a button [DELETE] on the bottom right.
After you have confirmed the following prompt, the series has been removed from the WebSync. The files on the server, however, will still be there!


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

In the second step you need to delete the files of the series via an FTP client. Simply delete the series base directory.
Attention! There is NO undelete function! Files which have been deleted are lost!