User Tools

Site Tools


rocrailonastick-en
no way to compare when less than two revisions

Differences

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


rocrailonastick-en [2025/03/05 09:45] (current) – created - external edit 127.0.0.1
Line 1: Line 1:
 +[[:english|{{  :rocrail-logo-35.png}}]][[:rocrailonastick-de|{{ :icons:de.png}}]][[:rocrailonastick-en|{{ :icons:uk.png}}]] [[:rocrailonastick-fr|{{ :icons:fr.png}}]] [[:rocrailonastick-nl|{{ :icons:nl.png}}]]
 +====== Rocrail ZIP ======
 +  * [[:download-int|Download]] | **[[:rocrailonastick-en|Rocrail ZIP]]** | [[win-changetozip-en|Change to ZIP Installer on Windows]]
 +
 +{{:install:usbstick.png?160}}
 + \\
 +
 +===== Introduction =====
 +//'Rocrail ZIP'// is provided as ZIP archive, and can be downloaded from the __**[[https://wiki.rocrail.net/rocrail-snapshot/|Daily Build]]**__ site.
 +
 +Rocrail ZIP allows to "install"((Rocrail ZIP is not actually installed, but only unzipped)) to (almost) any location on the computer: For example, on the desktop, on a second internal drive, etc. All files needed by Rocrail are stored in one folder; there are no files created or hidden outside this folder (except the optional desktop icon).
 +
 +If enough memory((For WIN64 with the ZIP files and all themes about 120 MByte)) is available, the ZIP file can even be unzipped to a memory stick.\\ 
 +This allows portable usage on changing hardware, but with the same operating system.
 +
 +
 +**Important Notes:**
 +  - Backup your workspaces.
 +  - Deinstall a previous Rocrail installation if the Setup.exe was used.
 +  - In order for an update not to overwrite files modified for own purposes (Images, SVG, Decspecs etc.), these must be saved with changed file names or in a separate directory
 +  -The **User-** and **AmericanThemes**, if needed must be unzipped separately, usually in the "svg" folder.\\
 +
 + \\
 +===== Instruction Videos =====
 +  * [[https://www.youtube.com/embed/Up4niKGJBl8|Nederlands (Dutch)]]
 +
 +
 +
 + \\
 +===== Unzipping and Starting =====
 +==== macOS ====
 +Select the right installer for your Mac:
 +|< >|
 +^ CPU ^ Installer ZIP ^ Remark ^
 +| Intel | Catalina, Sierra, ElCapitan, Leopard | The Catalina build runs also on newer macOS Intel versions. |
 +| Apple Silicon M1/M2/M3 | Sonoma | 
 +
 +  - Double click on the zip file to unpack it.
 +  - Move or copy the Rocrail.app to your personal Applications folder. ( /Users/<username>/Applications )
 +
 +After every download the following steps are necessary for security reasons:
 +  - Open the Rocrail.app context menu in the Finder and select "Open".
 +  - Click on "Open" after the popup comes with "Are you sure you want to open it?".
 +
 +|  {{:mac:macos-open-rocrail-1.jpg?240}}  |  {{:mac:macos-open-rocrail-2.jpg?240}}  |  {{:mac:macos-open-rocrail-3.jpg?240}}  |
 +| After download the first double click blocks. | Open in the finder the context menu and select "Open". | Confirm to open the application. |
 +Alternative use the security:\\
 +{{:mac:macos-security-openanyway.png?240}}\\
 + \\
 +
 +
 +==== Windows ====
 +| Help for switching from a classic installation to the installation with a ZIP file: **[[:win-changetozip-en|Switching to ZIP installer]]** explained step by step. |
 +
 +Simply unpack the ZIP archive into a directory of choice and double-click on the script file **desktoplink.cmd ((depending on your windows installation the **''.cmd''** might not show. See: **[[faq-en#windows|FAQ]]**))** to create a shortcut of Rocview on the desktop.  A workspace can be selected to start the server.
 +
 +When starting for the first time a safety warning from Windows Defender may be displayed (**{{win:win-defender-en.png?linkonly|screenshot}}**). First, the text //More info// has to be clicked, then in the modified dialogue (**{{win:win-defender2-en.png?linkonly|screenshot}}**) button //Run anyway// has to be clicked.  \\
 +
 +Detailed installation instructions can be found under ** [[: win-en | Install Rocrail under Windows]] **
 + 
 + \\
 +
 +==== Linux ====
 +Just unzip it in the home directory (not copied to the system) and double click on the **desktoplink.sh** to create a Rocview Desktop shortcut with all needed parameters to startup a workspace.. \\
 +
 +=== Builds ===
 +Check this table which build is compatible with the target Linux distribution:
 +^ Build ^ Compatible with ^ Architecture ^
 +| Debian 11 | Debian 12, LMDE 5, Mint 20, Manjaro LTS, Ubuntu 20, Ubuntu 22, openSUSE 15 | i386, AMD64, x86_64 |
 +
 +=== Terminal ===
 +If the file explorer opens the script files in an editor, its easier to open a terminal, and change the directory into the place where the ZIP file is located. Then issue following commands: (The same sequence can also be used for updating.)
 +<code>
 +cd 
 +unzip -u -d Rocrail Downloads/Rocrail*.zip
 +cd Rocrail
 +./desktoplink.sh
 +</code>
 +<html><!--
 +If the wxWidgets library is not yet installed:
 +<code>
 +./installwx.sh
 +</code>
 +--></html>
 +
 +
 +
 +===Gnome Desktop===
 +An extension is needed if the Rocview Desktop Icon does not appear.\\
 +Open a terminal window and type in the following commands:
 +<code>
 +sudo apt install gnome-tweaks
 +sudo apt install gnome-shell-extension-desktop-icons
 +gnome-tweaks
 +</code>
 +After Gnome Tweaks did open, select in the left column "Extensions", and activate "Desktop icons".\\
 +The Rocview Desktop Icon will at first look like a text document. Activate in the context menu, right click on this icon, and activate "Allow Launching".\\
 +
 +===Taskbar Panel===
 +To be able to pin Rocview on the Taskbar Panel the Rocview.desktop file must be copied to the applications directory:
 +<code>
 +sudo cp ~/Desktop/Rocview.desktop /usr/share/applications 
 +</code>
 +Search for Rocview in the Startmenu and start it. Now the Rocrail Icon can be pinned on the Panel.\\
 +{{:install:cinnemon-rocview-panel.jpg|Cinnamon}}\\
 +**Note:** On some systems the Desktop directory has another name like //Schreibtisch//. (Depending on the selected language.)\\
 +
 +
 +
 + \\
 +====Raspberry Pi====
 +  * __**[[:raspi:install:rpi-install-en|Graphical installation for novice users.]]**__ (recommended)\\
 +  * __**[[:download-int#raspberry_pi|Terminal installation for experts.]]**__ \\
 +
 +=== Builds ===
 +Check this table which build is compatible with the target Linux distribution:
 +^ Build ^ Compatible with ^ Architecture ^ Manufacturer ^
 +| PiOS11 | Ubuntu 20, Ubuntu 22, Manjaro, Armbian 22 | ARMHF, ARM64 | Raspberry Pi, Odroid |
 +Check if PiOS is 32 or 64 bit by terminal command
 +<code>getconf LONG_BIT</code>
 +In case the result is **32** the **ARMHF** build must be used.\\
 +
 +
 +
 +
 + \\
 +===== Update =====
 +====macOS====
 +  - Download a current ZIP-Archive.
 +  - Double click on the zip file to unpack it.
 +  - Copy, overwrite, the Rocrail.app in your personal Applications folder. ( /Users/<username>/Applications )
 +  - For opening the application see [[#macos|Unzipping and starting macOS]]
 +
 +
 + \\
 +====Windows====
 +**Important Note:** \\
 +In order for an update not to overwrite files modified for own purposes (Images, SVG, Decspecs etc.), these must be saved with changed file names or in a separate directory.
 +
 +  - Download a current ZIP-Archive.
 +  - Extract the new zip file into the Rocrail folder
 +  - Extract all files.
 +  - Confirm the following question "Replace the files in the destination":  \\ {{:install:stick-overwrite-en.png}}
 +
 + \\
 +=== Advanced Update Option ===
 +|  Not for novice users!  |
 +
 +  - Download a current ZIP-Archive.
 +  - Extract only the **BIN** folder into the Rocrail folder. \\ // This only updates Rocview, Rocrail server and libraries. //
 +  - Confirm the following question "Replace the files in the destination":  \\ {{:install:stick-overwrite-en.png}}
 +  * **Important note:** \\ As files in other directories (svg, decpecs, ...) are also updated and expanded irregularly, it is strongly recommended to carry out complete updates more often.
 +
 +
 + \\
 +===== Demo and Wiki Plans =====
 +|< >|
 +^  Demo-Plan  ^  Wiki-Demo-Plan \\ "Step by Step"  ^
 +|  {{:install:demo-plan.png?0x200}}  |  {{:install:wiki-demo-plan.png?0x200}}  |
 +To access the Demo plan select File->Demo Workspace. \\
 +To access the Wiki Demo plan select File->Open Workspace (in this directory look for the wikidemo folder and select.) \\
 +
 +  * **Note:** If a workspace is active, then the termination of the server must be confirmed.
 +
 + \\
 +===== Directory structure =====
 +====Windows / Linux====
 +<code>
 +Rocrail
 +├───desktoplink.cmd     (Windows -- Icon on the desktop)
 +├───rocview.cmd         (Windows -- Rocview and Server)
 +├───readme.txt          (Information)
 +├───start.html          (Startup Help with links to the stepbystep-xx Wiki pages)
 +├───revision-xxxxx.info (Revision number and the last 500+ revisions)
 +├───desktoplink.sh      (Linux   -- Icon on the desktop)
 +├───rocrail.png         (Linux   -- Rocrail icon)
 +├───rocview.sh          (Linux   -- Rocview and Server)
 +├───rocrail.sh          (Linux   -- Server only)
 +├───startrocrail.sh     (Linux   -- Script for use with crontab; Copy or symlink it into ~)
 +├───initdefault.sh      (Linux   -- Init default workspace with symlinks to: svg, web, images, decspec)
 +├───update.sh           (Linux   -- Update Rocrail by Server Monitor)
 +├───sysupdate.sh        (Linux   -- Update OS by Server Monitor)
 +├───default             (Default empty workspace in case of crontab and/or Server Monitor)
 +├───wikidemo          
 +|   └───plan.xml        (wiki demo plan)
 +├───demo                (default demo workspace)
 +|   └───plan.xml        (larger plan with shadow station)
 +├───web                 (Rocweb data)
 +├───bin                 (Executables and libraries)
 +├───decspecs            (Rocpro decoder specification)
 +├───stylesheets         (Docu formats)
 +├───images              (Pictures: Symbols, Locs, Wagon, ...)
 +└───svg                 (Scalable Vector Graphics)
 +    ├───themes
 +    |   ├───Accessories
 +    |   ├───CTC
 +    |   ├───Roads
 +    |   ├───SLIM
 +    |   ├───SLIM-COLOR
 +    |   └───SpDrS60
 +    └───dynthemes
 +        ├───Accessories
 +        ├───Roads
 +        ├───SLIM
 +        ├───SLIM-COLOR
 +        └───SpDrS60
 +
 +</code>
 +
 +  * **Note:** The individual **[[http://rocrail.net/software/rocrail-snapshot/|"Rocrail Zip" ZIP archives]]**  contain only the parts of the Directory structure above \\ that are relevant for the respective Operating system.
 + \\
 +====macOS====
 +<code>
 +Rocrail.app
 +└───Contents          
 +    ├───_CodeSignature            (Optional code signing with Apple Developer ID)
 +    ├───Frameworks                (Libraries *.dylib)
 +    ├───MacOS
 +    |   ├───rocrail
 +    |   └───rocview               (<CFBundleExecutable> in the Info.plist)
 +    ├───Resources
 +    |   ├───Rocrail.icns
 +    |   ├───data
 +    |    ├───decspecs            (Rocpro decoder specification)
 +    |    ├───stylesheets         (Docu formats)
 +    |    ├───images              (Pictures: Symbols, Locs, Wagon, ...)
 +    |    ├───web                 (Rocweb data)
 +    |    └───svg                 (Scalable Vector Graphics)
 +    |       ├───themes
 +    |        ├───Accessories
 +    |        ├───CTC
 +    |        ├───Roads
 +    |        ├───SLIM
 +    |        ├───SLIM-COLOR
 +    |        └───SpDrS60
 +    |       └───dynthemes
 +    |          ├───Accessories
 +    |          ├───Roads
 +    |          ├───SLIM
 +    |          ├───SLIM-COLOR
 +    |          └───SpDrS60
 +    |   ├───demo
 +    |    └───plan.xml
 +    |   └───wikidemo
 +    |      └───plan.xml
 +    └───Info.plist
 +
 +</code>
 +
 +Rocview will create the following local directory structure:
 +<code>
 +$HOME
 +└───rocrail
 +    ├───decspecs
 +    ├───images
 +    ├───stylesheets
 +    ├───svg
 +    ├───web
 +    ├───wikidemo
 +    └───demo
 +</code>
 +Newer files in the Rocrail.app will overwrite the existing files in the ~/rocrail directory.\\
 +  * Store local user SVGs in its own directory.
 +  * Use a separate Workspace for your own plan.xml.
 +
 + \\
 +
 + \\
 +=====Trouble shooting Linux=====
 +====Wayland====
 +The Wayland WindowManager comes with following restrictions:
 +  * Rocview cannot restore its inner windows correctly if the vertical toolbar option is set.
 +  * Restoring window and dialog positions is not possible.
 +
 +===Solution===
 +Change the Exec line in the desktop file into:
 +<code>Exec=env GDK_BACKEND=x11 ....</code>
 + \\
 +====Serial Device Access====
 +Add the user to the group dialout: **[[;faq-en#serial_device_user_access_linux|FAQ]]** \\
 +
  
rocrailonastick-en.txt · Last modified: 2025/03/05 09:45 by 127.0.0.1