Skip to content

Commit 113a75f

Browse files
authored
Updated install guide (#233)
* πŸ“ Updated the docs contribution guide * πŸ› Fix minor spelling errors and button overlap * πŸ“ Updated the install guide * πŸ›Fix minor spelling errors * πŸ“ Updates from code review
1 parent d27d594 commit 113a75f

4 files changed

Lines changed: 74 additions & 38 deletions

File tree

β€Ždictionary/en-custom.txtβ€Ž

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -840,4 +840,7 @@ fi
840840
VPNs
841841
nav
842842
yaml
843-
md
843+
md
844+
AUR
845+
paru
846+
yay

β€Žmkdocs.ymlβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ plugins:
6363
nav:
6464
- Overview: README.md
6565
- Gameplay:
66-
- Installing the game: gameplay/installing-the-game.md
66+
- Installation Guide: gameplay/installing-the-game.md
6767
- General FAQ: gameplay/general-faq.md
6868
- Common issues: gameplay/common-issues.md
6969
- Beginner's Guide: gameplay/beginners-guide.md
Lines changed: 69 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,104 @@
1-
Installing the game
2-
============
1+
# Installation Guide
32

4-
## Installation
3+
To effortlessly install and keep Rigs of Rods up-to-date, we recommend using the [itch.io](https://itch.io/app) desktop app available for Windows and Linux.
54

6-
### Downloading
5+
[![Available on itch.io](https://static.itch.io/images/badge-color.svg){ width=150 loading=lazy }](http://rigs-of-rods.sf.net/itch/dev/)
76

8-
To get started, download the latest version of the game from our [homepage](https://www.rigsofrods.org/).
7+
!!! danger "Don't place your device at risk"
8+
For your security, only download Rigs of Rods from the [official Download Center](https://www.rigsofrods.org/download). Downloading from unknown sources may expose you to malware, outdated versions, or modified files that could harm your device.
99

10-
![download](../images/bg-download2021.png)
10+
## Windows
1111

12-
From here, choose which package you would like to install. We recommend the Installer for beginner users.
1312

14-
![options](../images/bg-downloadopt2021.png)
13+
!!! warning ""Windows protected your PC" Windows SmartScreen"
14+
On Windows, you may be presented with a pop up saying that it prevented an unrecognized app from starting. You must click **More info** and then **Run anyway** in order for the installer to run.
1515

16-
You will be redirected to Sourceforge, and the file will automatically download. Once downloaded, double-click the file to start the installer.
16+
### with Installer <small>recommended</small> { #with-installer data-toc-label="with Installer" }
1717

18-
**If you're running Linux, you can download the game by following [these instructions](https://forum.rigsofrods.org/threads/test-build-version-0-4-8-rc4.1217/).**
18+
<figure markdown>
19+
![Install guide](../images/win-install-ror.gif){ loading=lazy }
20+
<figcaption>Windows 11 version 21H1</figcaption>
21+
</figure>
1922

20-
### Windows SmartScreen warning
23+
For the latest version, go to the [Download Center](https://www.rigsofrods.org/download) and select *Rigs of Rods 64-bit Installer* for Windows. You will immediately be redirected to SourceForge, and the download will automatically begin.
2124

22-
![smartscreen](../images/bg-smartscreen.png)
25+
When your download finishes, follow these steps to quickly go through the installer.
2326

24-
When launching the installer for the first time, Windows Defender SmartScreen may prevent the installer from starting.
27+
1. Select your language, by default it is English. Click *Next*.
28+
2. Accept the License Agreement by selecting *I accept the agreement* then click *Next*.
29+
3. If you wish to install to another location, select *Browse*, otherwise the default location will be used.
30+
4. If you want the installer to create a desktop shortcut check *Create a desktop shortcut*.
31+
5. Review the installation and click *Back* if you want to make any changes, otherwise click *Install* to begin the installation process.
32+
6. Upon completion of the installation read then click *Next*.
33+
7. Well done, the installation is now completed. Leave *Launch Rigs of Rods* checked and click *Finish* to launch Rigs of Rods.
2534

26-
If this happens, click `More info` then `Run anyway`.
2735

28-
The installer should launch once you accept the UAC dialog.
36+
### with Portable (.zip)
2937

30-
### Installing
38+
For the latest version, go to the [Download Center](https://www.rigsofrods.org/download) and select *Rigs of Rods 64-bit Portable (.zip)* for Windows. You will immediately be redirected to SourceForge, and the download will automatically begin.
3139

32-
Select your language, then click `OK`.
40+
When your download finishes, follow these steps to launch Rigs of Rods.
3341

34-
![installer1](../images/bg-installer1.png)
42+
1. Extract the .zip into your desired location (Do not merge with an existing Rigs of Rods version!)
43+
2. Launch Rigs of Rods by double-clicking `RoR.exe`
3544

36-
Click `Next`.
45+
## Linux
3746

38-
![installer2](../images/bg-installer2.png)
47+
### with Portable (.zip) <small>recommended</small> { #with-portable-zip_1 data-toc-label="with Portable (.zip)" }
3948

40-
Accept the agreement, then click `Next`.
49+
For the latest version, go to the [Download Center](https://www.rigsofrods.org/download) and select *Rigs of Rods 64-bit Portable (.zip)* for Linux. You will immediately be redirected to Sourceforge, and the download will automatically begin.
4150

42-
![installer3](../images/bg-installer3.png)
51+
When your download finishes, follow these steps to launch Rigs of Rods on Linux.
4352

44-
If you wish to install RoR to another location, you can change it here. We recommend leaving it to the default location.
53+
1. Extract the .zip into your desired location (Do not merge with an existing Rigs of Rods version!)
54+
``` bash
55+
unzip rigs-of-rods-linux.zip
56+
```
57+
4. It may not always be necessary, but grant the execute permission to the executable and script run file.
58+
```bash
59+
chmod +x ./RoR
60+
chmod +x ./RunRoR
61+
```
62+
3. Depending on your graphical interface, you may double-click `RunRoR` or run from the terminal.
63+
``` bash
64+
./RunRoR
65+
```
4566

46-
![installer4](../images/bg-installer4.png)
67+
### with Snap Store
4768

48-
By default, RoR only comes with a very small selection of content. To help new players, we've created content packs which provide a good selection of vehicles and terrains to get you started.
69+
**Snap Store is not OFFICIALLY maintained but is regularly kept up-to-date.** Snaps can be used on all major Linux distributions and is widely used because of its graphical counterpart the Snap Store.
4970

50-
You can choose to either download all the packs, or only select the ones that interest you. For simplicity's sake, no packs will be downloaded.
71+
``` bash
72+
sudo snap install rigs-of-rods
73+
```
5174

52-
Click `Next` to continue.
75+
### with AUR
5376

54-
![installer5](../images/bg-installer5.png)
77+
The Arch User Repository (AUR) packages can be installed on your Arch Linux system with with the use of a helper like yay or paru.
5578

56-
If you want the installer to create a desktop icon, check the box. Click `Next` to continue.
79+
```bash
80+
paru -S rigsofrods
81+
```
82+
## Development Builds
5783

58-
![installer6](../images/bg-installer6.png)
84+
If you want to try out the latest changes without waiting for a stable release, you can use the development builds. These builds include new features, bug fixes, and improvements but may also be unstable.
5985

60-
Click `Install` to begin the installation process.
86+
!!! warning "Try at your own risk!"
87+
These builds allow you to experience new changes before they are officially released. These builds are not thoroughly tested, so the chance you may experience crashes, bugs, or other issues is higher than with stable versions. If you encounter problems, consider reporting them on the [Rigs of Rods GitHub issues](https://github.com/RigsOfRods/rigs-of-rods/issues) page.
6188

62-
![installer7](../images/bg-installer7.png)
89+
### with itch.io Desktop App <small>recommended</small> { #with-itch-io-desktop-app }
6390

64-
Once the installation finishes, read the message that appears then click `Next` to continue.
91+
Just like the stable release, the development builds are available through the itch.io app. After every code change, the builds are automatically pushed to itch.io and delivered as an optional update for you.
6592

66-
![installer8](../images/bg-installer8.png)
93+
[:fontawesome-solid-download: Download Rigs of Rods Experimental](http://rigs-of-rods.sf.net/itch/dev/){ .md-button .md-button--primary }
6794

68-
Installation is now completed. Leave `Launch Rigs of Rods` checked then click `Finish` to launch RoR!
95+
### with itch.io (.zip)
6996

70-
![installer9](../images/bg-installer9.png)
97+
If you prefer not to use the the desktop app, you can still download the builds manually.
7198

99+
1. Go to the the [Rigs of Rods itch.io build page](https://rigs-of-rods.itch.io/rigs-of-rods-dev).
100+
2. Download the development builds for Windows or Linux.
101+
3. Extract the contents to a preferred location.
102+
4. Run `RoR.exe` (Windows) or `./RunRoR` (Linux) to start the game.
103+
104+
Refer to previous sections of this guide for additional guidance on launching the game. If you have any issues with development builds (such as broken links or missing builds) please [refer to this thread](https://forum.rigsofrods.org/threads/ror-development-builds-for-windows-and-linux.696/) on the community forums.
6.27 MB
Loading

0 commit comments

Comments
Β (0)