User Tools

Site Tools


first-steps-en

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

first-steps-en [2018/11/12 08:56] (current)
Line 1: Line 1:
 +====== Installing Rocrail ======
  
 +[[english|{{ ​ rocrail-logo-35.png}}]]
 +
 +[[english|Content]] -> [[english#​getting started|Getting Started]]
 + 
 +
 +  *  [[before-en|Before You Start]] | **Installing Rocrail** | [[basic-config-en|Basic Configuration]] | [[digital_central|Command Stations and Digital Devices]] | [[sensors|Sensors ]]
 +
 +
 +// \\ // \\ 
 +To use Rocrail, first download and install the software on the computer connected to your layout, and then configure the software to work with your Control Station.\\
 +
 +
 + \\
 +===== Windows =====
 +
 +==== Download ====
 +Installers can be downloaded from:\\
 +[[:​download-int|{{:​icons:​software-install.png}}]]\\
 +
 +===== Installation =====
 +Rocrail uses the free Inno Setup installer http://​www.jrsoftware.org/​isinfo.php \\
 +
 +Double klick on the downloaded file to start the installer. \\ 
 +
 +{{rocrail-setup-en.png}}\\
 +
 +Accept the defaults and just keep clicking OK if you are not sure what to do. Advanced users can change where Rocrail will be installed. ​ Once Rocrail is installed, the next step is to start it.\\
 +
 +\\
 +
 +====Additional options====
 +{{setup-en.png}}
 +===Demo plan===
 +A default plan for testing. If it already exist it will not be overwritten.\\
 +===Loco images===
 +A default collection of loco images.\\
 +===SVG Themes===
 +The **[[:​symbols-themes-spdr60-en|SVG themes]]** must be (have been) installed to be able Rocview to show plan objects.\\
 +\\
 +
 +==== Directories ====
 +==Meta directory names:==
 +  * {app} = The Windows application directory: “''​C:​\Programme''​”,​ Windows language dependent
 +  * {userdocs} = The Windows user directory: ​ “''​C:​\Dokumente und Einstellungen\username\Eigene Dateien''​”,​ Windows language dependent
 +
 +
 +
 + \\
 +^ Directory ​ ^ Components ​ ^ Uninstall ^
 +| {app}\Rocrail | Binaries; *.exe, *.dll | yes |
 +| {app}\Rocrail\svg | SVG Themes | yes |
 +| {app}\Rocrail\web | RocWeb files | yes |
 +| {userdocs}\Rocrail | Layout files; *.xml | no |
 +| {userdocs}\Rocrail\images | Image files; *.png, *.xpm, *.gif | no, some example files will remain |
 +| {userdocs}\Rocrail\stylesheets | Stylesheets for documentation | no |
 +| {userdocs}\Rocrail\decspecs | RocPro decoder definitions | no |
 +
 +
 + \\
 +
 +==== Short Cuts ====
 +Both programs will use "''​C:​\Dokumente und Einstellungen\username\Eigene Dateien\Rocrail''"​ as working directory. (German Windows version example.)\\
 +== Rocview ==
 +(German Windows version example.)
 +<​code>​
 +C:​\Programme\Rocrail\rocview.exe -icons "​C:​\Programme\Rocrail\icons"​
 +</​code>​
 + \\
 +== Rocrail ==
 +(German Windows version example.)
 +<​code>​
 +C:​\Programme\Rocrail\rocrail.exe -console -l "​C:​\Programme\Rocrail"​ -img "​C:​\Dokumente und Einstellungen\rob\Eigene Dateien\Rocrail\images"​
 +</​code>​
 +The **''​-img''​** command line option will be used for providing images to clients. Remove this option if another image directory is wanted.\\
 +
 + \\
 +=====Linux=====
 +Installers can be downloaded from:\\
 +[[:​download-int|{{:​icons:​software-install.png}}]]\\
 +
 +
 +==== Directories ====
 +===Meta directory names===
 +  * {app} = Common application directory: "​**''/​opt''​**"​.
 +  * {home} = User data directory: "​**''​$HOME''​**"​. (For example: /home/John)
 +
 + \\
 +^ Directory ​ ^ Components ​ ^ Uninstall ^
 +| {app}/​rocrail | Binaries; rocrail, rocview, *.so | yes |
 +| {app}/​rocrail | Scripts; *.sh | yes |
 +| {app}/​rocrail/​svg | SVG Themes | yes |
 +| {app}/​rocrail/​web | RocWeb files | yes |
 +| {home}/​rocrail | Layout files; *.xml | no |
 +| {home}/​rocrail | Ini files; *.ini | no |
 +| {home}/​rocrail/​images | Image files; *.png, *.xpm, *.gif | no, some example files will remain |
 +| {home}/​rocrail/​stylesheets | Stylesheets for documentation | no |
 +| {home}/​rocrail/​decspecs | RocPro decoder definitions | no |\\
 +| {home}/​rocrail/​svg | __Symbolic link__ to the SVG Themes | no, new created after every start |\\
 +| {home}/​rocrail/​web | __Symbolic link__ to the RocWeb files | no, new created after every start |\\
 + ​\\ ​
 +==== Short Cuts ====
 +Short cuts are copied in **''/​usr/​share/​applications''​** and will mostly show up in the Games menu.\\
 +These short cute will call the shell scripts found in the **''​{app}/​rocrail''​**.\\
 +
 + \\
 +==== Package install ====
 +
 +After downloading the *.deb package to your personal folder (or any other suitable folder), open the package by right-clicking on it and choose "​Debian package Manager"​. This will bring up the package manager. You might need to give your root (or superuser) password at a certain stage of this installation process.
 +Choose to install the package. The rest will be done by the package manager.
 +It might be that you need to install wxwidgets 3.0. If the package manager does not automatically download and install it for you, use the Synaptics package Manager to get it.
 +
 +Alternatively it can be installed with a terminal command:
 +<​code>​
 +sudo apt install rocrail-xxxxx-ubuntu1604-amd64.deb ​
 +</​code>​
 +
 +Once Rocrail and Rocview appear in the **Other** section, Rocrail is installed, next step is to start it.
 +
 +
 + \\
 +
 +=====macOS=====
 +Installers can be downloaded from:\\
 +[[:​download-int|{{:​icons:​software-install.png}}]]\\
 +
 +
 +==== Directories ====
 +===Meta directory names===
 +  * {app} = Common application directory: "​**''/​Applications''​**"​.
 +  * {home} = User data directory: "​**''​$HOME''​**"​. (For example: /​Users/​John)
 +//Rocrail revision 11.618+.//​\\
 + \\
 +^ Directory ​ ^ Components ​ ^ Uninstall ^
 +| {app}/​Rocrail.app/​Contents/​MacOS | Binaries; rocrail, rocview, *.dylib | yes |
 +| {app}/​Rocrail.app/​Contents/​rocdata/​svg | SVG Themes | yes |
 +| {app}/​Rocrail.app/​Contents/​rocdata/​web | Rocweb files | yes |
 +| {home}/​rocrail | Layout files; *.xml | no |
 +| {home}/​rocrail | Ini files; *.ini | no |
 +| {home}/​rocrail/​images | Image files; *.png, *.xpm, *.gif | no |
 +| {home}/​rocrail/​stylesheets | Stylesheets for documentation | no |
 +| {home}/​rocrail/​decspecs | RocPro decoder definitions | no |\\
 +| {home}/​rocrail/​svg | __Symbolic link__ to the SVG Themes | no, the link is recreated after every start \\ Use another directory for user defined themes! |\\
 +| {home}/​rocrail/​web | __Symbolic link__ to the RocWeb files | no, the link is recreated after every start |\\
 + ​\\ ​
 +
 +
 +\\
 +
 +=====Startup Rocrail & Rocview=====
 +Start the Rocrail server first, then the Rocrview.
 +| {{rocrail-start-menu.png}} | {{rocrail-rocgui-started.png}} |
 +Later it is explaned how to use the Rocview standalone to make track plans locally and upload them later to the Rocrail server.
 +
 +=====Creating your first trackplan=====
 +Set the track plan in **Edit** mode and add, delete, modify objects.
 +The Rocrail server will save the track plan on exit or on clicking the **Save** toolbar button with the default name "​plan.xml"​ in the working directory. ​
 +| {{rocgui-edit-trackplan.png}} | {{rocgui-view-100.png}} |
 +
 +=====Edit session=====
 +All actions to edit are done with the mouse. The right button for the context menu and the left to move objects around the plan.
 +After some exercises you could end up with a track plan like this:
 +{{rocgui-edit-session.png}}
 +
 +
 +=====Next steps=====
 +  * connecting it to your command station: [[english#​command_stations|Command Stations]]
 +  * getting switches to work: [[switch-int-en|Switch Interfacing]]
 +  * add locomotives:​ [[loc-gen-en|Settings for a Locomotive]]
first-steps-en.txt · Last modified: 2018/11/12 08:56 (external edit)