WebSync 5.0 introduced together with SimSync PRO 4.5 a new feature called Readme's & Changelog's.
This feature needs at least SimSync PRO 4.5 to work!
While Changelog's are now for quite a long time part of the WebSync, they have until SimSync PRO 4.5 only been used to display the changes on a webpage.
This changes now and Changelog have now the chance to be more relevant for distributing information.
In addition, Readme files can now be used to give the users/drivers a general overview of the mod and who is/was involved in creating it.
Changelog - HowTo
-
- To create a changelog entry, simply click on the "Index" to index the series. A series must be index first once before the log can be edited.
- To update the changelog, click on the "Log" button of the series.
- To define if and how changelogs should be displayed to the drivers, you can define this in the series.Click on "Edit" of the series and scroll down to "Changelog mode":
-
- Manual - A changelog can be displayed manually (see the context menu of the series) if available
- Before - This will automatically display the changelog BEFORE the sync starts. Once it get's displayed it will only displayed again, after the series has been re-indexed!
-
- After - Similar to "before", but the changelog will be displayed after the sync finished.
-
Readme - HowTo
-
- To create or update a Readme, create a local "readme.txt" file or "readme.md" (a Markdown formatted file) , enter the content you like and upload it in the series root folder of your series.
- If you would like have localized readme files, simply name the readme files in the following way: "readme_[2 char language code].txt" or "readme_[2 char language code].md"
e.g. readme_de.txt, readme_en.txt, readme_de.md, readme_en.md
The sync will always try to display a localized readme before using the default readme.txt.You should always provide a normal "readme.txt", even if localizing the readme. This normal readme.txt will be used in case there is no localization for the users language available. - To define if and how changelogs should be displayed to the drivers, you can define this in the series.
- Click on "Edit" of the series and scroll down to "Readme mode":
-
- Manual - A Readme can be displayed manually (see the context menu of the series) if available
-
- Before - This will automatically display the Readme BEFORE the sync starts. Once it get's displayed it will only displayed again, after the series has been re-indexed!
-
- After - Similar to "before", but the Readme will be displayed after the sync finished.
-