raceXMLCreator 1.5 – SimSync PRO

Version 1.5
Download 93
File Size 4.35 MB
File Count 1
Create Date 6. May 2010
Last Updated 26. September 2020

Download

Description

raceXMLcreator version 1.5

Created and maintained(?) by Sebastian Röhn

A) Installing
- The files in the folder "raceXMLcreator" should not be moved into another folder. Logfiles can be save elsewhere.
OPTION I
1. Install the Matlab Compiler Runtime (MCRInstaller.exe) on your PC first. Otherwise will the tool not start.
MATLAB Compiler Runtime (MCR): http://www.mathworks.de/products/compiler/mcr/
- select therefor the right MCRInstaller.exe for MatLab R2014a debending of your OS!
- Windows 32bit: http://www.mathworks.de/supportfiles/downloads/R2014a/deployment_files/R2014a/installers/win32/MCR_R2014a_win32_installer.exe
- Windows 64bit: http://www.mathworks.de/supportfiles/downloads/R2014a/deployment_files/R2014a/installers/win64/MCR_R2014a_win64_installer.exe
2. start the tool under "/*/raceXMLcreator/raceXMLcreator_win32.exe" or "/*/raceXMLcreator/raceXMLcreator_win64.exe"
- The raceXMLcreator_win32.exe runs also on 64bit OS
- The executable file must be within the same directory as the "shared" folder

B) The raceXMLcreator creates on his first start a raceXMLcreator.ini file to save the following session settings:
Default language; English
Default path; ...path to the raceXMLcreator.exe
Language file; -
File selection mode; auto
Chart Background Color in HEX; 2e2e2e
Legend Background Color in HEX; 5d5b5b
Axes and Font Color in HEX; e3e3e3
Host address;
Port;
UserName;
Password;
These are the default settings. By closing the raceXMLcreator the session settings will be saved into the *.ini file and loaded on the next start.
The password for a FTP connection will be saved encrypted only. If the *.ini does not exist or a setting is currupt, default will be restored.

C) Menu of the raceXMLcreator (within [] = default setting)
Language - Option: [english]/spanish/french/german/italian/from file -> if selected from file, use the template_Language_File.ini to adjust the tool to another language
Default directory - Select folder with log files -> the default directory is shown when you open first the file browser
File selection mode - Option: [automatic]/manual -> weather selected files in the file browser will be read in automatically or manually (user must select the next file in popupmenu)
Chart colors - Option: set colors/[default colors] -> adjust the colors settings for the charts presented on race_leaders.html and specific Team.hmtl pages

D) Preparation of log files for races with the REJOIN PLUGIN
- Team and Driver names: the following special character are NOT allowed /*:?<>|"# If used they will be removed automatically.
The character < and > can lead to an incorrect read-in of Team and Driver names.
- you need at least all rejoin plugin logfiles to create an alternative scoring
- for creating an race xml is always ONE practice session rFactor xml file necessary, where ALL teams are having an own entry <driver>...</driver>
- Teams, which have NOT started the race, can be deleted from the practice session rFactor xml. But it is not mandatory.
- If the race is splitted into parts, do the following in the rejoin plugin.txt files
- On every part which is NOT the finish part, add at the end of the file...
last timestamp; RaceStopped;
for example: 4:01:22.003; RaceStopped;

- On every part which is NOT the starting part, change RaceStarted to -> RaceRestarted "number" like...
FROM
22:19.002; RaceStarted; timestamp="1389448948460", rfpos="3", vehicle="112 kfzteile24 SimRacing Team 2"
TO (here for Restart number 1)
22:19.002; RaceRestarted 1; timestamp="1389448948460", rfpos="3", vehicle="112 kfzteile24 SimRacing Team 2"

All other should be not changed in this line.

- the example files are already right prepared and can be used by the tool

E) How to select files with the file browser opened by press the [...] BUTTON
the file browser has to windows:
left window "current folder": Shows all folders and txt or xml files in the current folder
- if you want to select f.e. the race.xml file to create an alternative scoring -> double click on this file or select the file and press the "add ->" button
- file will be transfered to the right window
right window "seleted items": shows all files you have selected
- over this window is a line "select exactly x file(s)" which shows the number on necessary files in the rigth window
- f.e. if you selected "Create an alternative scoring out of an rFactor(2) practice session file" and 4 additional practice parts -> the line will show "select exactly 5 files"
Press the "Done" BUTTON to confirm your selection -> file browser will be closed and the selected file(s) is(are) visible in the popupmenu under "rFactor session *.xml file" or "Rejoin Plugin log *.txt file"
Use the cancel Button or X selects no file and closes the file browser
The popupmenu under "rFactor session *.xml file" and "Rejoin Plugin log *.txt file" will list the selected files also in order of the right window in the file browser

F) Create an race XML file and alternative scoring
1. select under "session settings" -> "Rejoin Plugin: create alternative scoring and/or result xml file"
2. if the race was restarted, than write the number of restarts into the field "Number of restarts during race"
- if there was no interrupt, leave the 0
3. press under "Rejoin Plugin log *.txt file" on [...] BUTTON and select the serverlog.txt file of the rejoin plugin
- see section E for detailed information how to select files
- if the race is splitted into parts, select not only the RACESTART file but ALL other files of the restarts as well
4. press under "rFactor session *.xml file" on [...] and select the practice session.xml file
5. optional: write down the race length in min
6. optional: select under "session settings" -> "include logged incidents <Stream> into *.xml result file"
- contains chat messages, contacts, server lefts/rejoins etc.
7. optional: select under "session settings" -> "include <Lap> entries into *.xml result file"
- an entry contains Lap#, Lap time index, Laptime
- fuel, sector times or other information are missing, because they were not logged by the rejoin plugin
8. optional: select "Upload alternative scoring to FTP server" to upload your race report to a FTP server
9. press the button "Create Race log file"
- tool checks the files order
- first will be read the selected serverlog.txt
- if you use "File selection mode -> manual" tool will stop reading until you select the next file in your list under "Rejoin Plugin log *.txt file"
- Take care on the order of the files how they will be read by the tool, always: racestart, part2, part3,..., racefinish
- if you use "File selection mode -> automatic" tool select the files autmatically in the list under "Rejoin Plugin log *.txt file"
10. select a folder to save the generated race XML file
11. select a folder to sace the alternative scoring...use the "raceXMLcreator_REPORT.html" file to link this scoring at your website
12. if selected option under 8. -> FTP browser openes to upload your file.

G) Create an race XML file only
1. select under "session settings" -> "Rejoin Plugin: create alternative scoring and/or result xml file"
2. if the race was restarted, than write the number of restarts into the field "Number of restarts during race"
- if there was no interrupt, leave the 0
3. press under "Rejoin Plugin log *.txt file" on [...] BUTTON and select the serverlog.txt file of the rejoin plugin
- see section E for detailed information how to select files
- if the race is splitted into parts, select not only the RACESTART file but ALL other files of the restarts as well
4. select under "session settings" -> "generate race *.xml result file only"
5. optional: write down the race length in min
6. optional: select under "session settings" -> "include logged incidents <Stream> into *.xml result file"
- contains chat messages, contacts, server lefts/rejoins etc.
7. optional: select under "session settings" -> "include <Lap> entries into *.xml result file"
- an entry contains Lap#, Lap time index, Laptime
- fuel, sector times or other information are missing, because they were not logged by the rejoin plugin
8. press the button "Create Race log file"
- tool checks the files order
- first will be read the selected serverlog.txt
- if you use "File selection mode -> manual" tool will stop reading until you select the next file in your list under "Rejoin Plugin log *.txt file"
- Take care on the order of the files how they will be read by the tool, always: racestart, part2, part3,..., racefinish
- if you use "File selection mode -> automatic" tool select the files autmatically in the list under "Rejoin Plugin log *.txt file"
9. select a folder to save the generated race XML file

H) Create an alternative scoring only
This is an alternative if you have NO rFactor practice session.xml and want to have at least a webreport result
Some information like vehicle class and session infos cannot be provided, because they are only saved in a rFactor session *.xml file
1. select under "session settings" -> "Rejoin Plugin: create alternative scoring and/or result xml file"
2. if the race was restarted, than write the number of restarts into the field "Number of restarts during race"
- if there was no interrupt, leave the 0
3. press under "1. Rejoin Plugin log *.txt file" on [...] BUTTON and select the serverlog.txt file of the rejoin plugin
- see section E for detailed information how to select files
- if the race is splitted into parts, select not only the RACESTART file but ALL other files of the restarts as well
4. do NOT select a "rFactor practice session.xml" file
5. go on with the same procedure like F -> 5.

I) Create an alternative scoring out of an rFactor(2) race session file
1. select under "session settings" -> "rFactor race result: create alternative scoring"
1b. If you want to combine the race result with a qualifying result, select also "rFactor Qualifying result: create alternative scoring"
2. press under "2. rFactor session *.xml file" on [...] and select the race session.xml and if option 1b is used also the qualifying session.xml file
3. optional: select "Upload alternative scoring to FTP server" to upload your race report to a FTP server
4. press the button "Create Race log file"
- first will be read-in the race result file selected under "2. rFactor session *.xml file", optional after that the qualifying result file
5. select a folder to save the alternative scoring file...use the "raceXMLcreator_REPORT.html" file to link this scoring at your website
6. if selected option under 3. -> FTP browser openes to upload your file.

J) Create an alternative scoring out of an rFactor(2) quali session file
1. select under "session settings" -> "rFactor Qualifying result: create alternative scoring"
2. press under "2. rFactor session *.xml file" on [...] and select the qualifying session.xml file
3. optional: select "Upload alternative scoring to FTP server" to upload your race report to a FTP server
4. press the button "Create Race log file"
5. select a folder to save the alternative scoring file...use the "raceXMLcreator_REPORT.html" file to link this scoring at your website
6. if selected option under 3. -> FTP browser openes to upload your file.

K) Create an alternative scoring out of an rFactor(2) practice session file
1. select under "session settings" -> "rFactor Practice result: create alternative scoring"
2. If you want to combine multiple practice result, than write the number of additional parts into the field "Number of additional practice parts"
- for example: you have 4 practice *.xml file, so type number of additional practice parts = 3
3. press under "2. rFactor session *.xml file" on [...] and select ALL practice session.xml files (number of additional practice parts + 1)
4. optional: select "Upload alternative scoring to FTP server" to upload your race report to a FTP server
5. press the button "Create Race log file"
6. select a folder to save the alternative scoring file...use the "raceXMLcreator_REPORT.html" file to link this scoring at your website
7. if selected option under 4. -> FTP browser openes to upload your file.

L) Files of alternative scoring
Created by the tool:
- raceXMLcreator_REPORT.html !!! use this file to link the report in your forum !!!
- overview.html
- result.html
- consistency.html
- impressum.html
- individual TeamXX.html (XX = ranking number/finished position) with TeamXX.png

Created by the tool for race sessions only
- fastest_laps.html
- highest_climbers.html
- race_leaders.html with leadersGraph.png

Created by the tool for practice or qualifying sessions only
- no_data.html

at shared folder
- styles.css
- raceXMLcreator_GUI.png
- raceXMLcreator_Logo.png
- monitor.png
- frame.png
- SimSync_Logo_2.png
- checkered-flag-icon.png (browser tab icon)

can be replaced (under the same file name) or deleted for your own style
- background_image_all.png (default carbon texture: 300x300 pixel repeats)
- background_nav.png (default image: 1920x180 pixel)

Decals on bottom of page overview.html
can be replaced with own logos under the same file name, max size: 250x250 pixel
- decal_left.png
- decal_right.png
- decal_mid.png

M) Miscellaneous
- Debug log files will be saved to to the directory, where the raceXMLcreator.exe is located

- alternative scoring folder shows at the end of the folder name the language type (en/es/fr/de/it/from file), for example: 2014_11_01_20_17_26-13P1_alternative_scoring_en

- Special thanks to Achim Ennenbach with the help at the used javascript.

- Internet Explorer v9: known issues of not working javascript for an selected monitor, fixed table header and none-visible text-shadow.

- The alternative scoring (html race report) was developed and tested with Mozilla Firefox v32.x and Google Chrome v39.x.

- For rFactor(2) race, qualifying and practice results shows the table incidents on each Team page only messages, who are logged in the rFactor(2) *.xml session file
within <stream>. But the incident table includes only chat and join/left server messages. Other entries <Incidents> like a contact or <score> for
laptime information are not used/included.

- Why is the option "check upgrades" under "session settings" not selectable?
This option shows in a simple textfile (*.txt) a table with the team and their used upgrades at the selected rFactor session files.
But it is only working if you already know the specific upgrade code of each upgrade of the mod. At the moment this is only hardcoded.
So it need a software update and can be used only for a specific mod. If you want to use this option, ask at the support forum under
http://www.simsync.de

N) Examples
- you find at the folder "logfiles" some examples of result files to test the raceXMLcreator

O) Legal notice
- all parts of the raceXMLcreator (executables, shared files or source code) may not be provided as download on other internet sites, except http://www.simsync.de
- open Source code for private usage only.
- You have no permission to change or replace anything at the impressium.html page, except the style of font-color, color of horizontal line and background image.
- You have no permission to change or replace the simsync Logo (SimSync_poweredby_Logo_2.png), the raceXMLcreator (race_xml_logo.png) Logo or the image of the raceXMLcreator GUI (race_xml_creator.png)