Merge branch 'RigsOfRods:master' into master

Author: Zentro

.github/workflows/gh-pages.yml

@@ -9,9 +9,9 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@v6
         with:
           python-version: 3.12
           cache: 'pip'

.github/workflows/spellcheck.yml

@@ -6,10 +6,10 @@ jobs:
   spelling:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
 
     - name: Set up Python 3.12
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: 3.12
         cache: 'pip'

dictionary/en-custom.txt

@@ -127,11 +127,13 @@ cSpline
 ctrl
 CTRL
 CuriousMike
+Customdashboardinputs
 AnotherFoxGuy
 da
 DAF
 dampingrate
 dampings
+DashBoardManagerClass
 Davded
 de
 De
@@ -190,6 +192,7 @@ flamewar
 flaperon
 flarematerialname
 Flarewing
+Flaregroups
 flexbodies
 Flexbodies
 flexbody
@@ -201,6 +204,7 @@ flexmeshes
 FN
 footbrake
 forset
+forvert
 forwardcommands
 Forwardcommands
 fov
@@ -347,6 +351,7 @@ maxPSI
 MaxRPM
 MaxX
 menubar
+Menubar
 meshbuilding
 meshName
 meshwheels
@@ -735,7 +740,10 @@ AmbientColor
 CaelumConfigFile
 HydraxConfigFile
 StartPosition
+StartRotation
 XYZ
+xyz
+yxz
 SandStormCubeMap
 cubemap
 CategoryID
@@ -840,4 +848,19 @@ fi
 VPNs
 nav
 yaml
-md
+md
+AUR
+paru
+yay
+OpenAL
+Pointlight
+DirX
+DirY
+DirZ
+dashboardsource
+shifterAnimTime
+TestC
+NeoQueretaro
+Assetpacks
+AssetPacks
+HUDs

mkdocs.yml

@@ -63,7 +63,7 @@ plugins:
 nav:
   - Overview: README.md
   - Gameplay:
-      - Installing the game: gameplay/installing-the-game.md
+      - Installation Guide: gameplay/installing-the-game.md
       - General FAQ: gameplay/general-faq.md
       - Common issues: gameplay/common-issues.md
       - Beginner's Guide: gameplay/beginners-guide.md

source/README.md

@@ -11,9 +11,9 @@ hide:
 </style>
 
 <div class="hero">
-  <a href="https://forum.rigsofrods.org/threads/rigs-of-rods-2022-12-released.3635/">
+  <a href="https://forum.rigsofrods.org/threads/rigs-of-rods-2026-01-released.4887/">
       <div class="hero-text">
-          <h1>Read the Release Announcement for Rigs of Rods 2022.12</h1>
+          <h1>Read the Release Announcement for Rigs of Rods 2026.01</h1>
       </div>
   </a>
 </div>
@@ -41,15 +41,17 @@ hide:
 
     Want to start modding Rigs of Rods? Start at 0 and work your way to pro with detailed guides on modding.
 
-    - [Installing Addons Guide](tools-tutorials/addons.md)
-    - [Blender Mesh Editing Guide](tools-tutorials/blender-mesh-editing.md)
-    - [Editing Terrain Objects](terrain-creation/editing-terrain-objects.md)
+    - [Truck File Format](vehicle-creation/fileformat-truck.md)
+    - [Soundscript File Format](vehicle-creation/fileformat-soundscript.md)
     - [Addonpart File Format](vehicle-creation/fileformat-addonpart.md)
-    - [Alternate Skins (skinzips) Guide](vehicle-creation/alternate-skins.md)
-    - [Truckfile Format](vehicle-creation/fileformat-truck.md)
     - [Terrn2 File Format](terrain-creation/terrn2-subsystem.md)
     - [Object File Format](terrain-creation/object-format.md)
-    - [Soundscript File Format](vehicle-creation/fileformat-soundscript.md)
+    - [Alternate Skins (skinzip) Guide](vehicle-creation/alternate-skins.md)
+    - [Installing Addons Guide](tools-tutorials/addons.md)
+    - [Blender Mesh Editing Guide](tools-tutorials/blender-mesh-editing.md)
+    - [Editing Terrain Objects](terrain-creation/editing-terrain-objects.md)
+
+
 
 -   :material-gavel:{ .lg .middle } __Community Rules__
 

source/gameplay/controls-config.md

@@ -695,6 +695,7 @@ Not all make sense though for animated props.
 | TRUCK_SHIFT_LOWRANGE      |     N/A                             | sets low range (1-6) for H-shaft | 
 | TRUCK_SHIFT_MIDRANGE       |    N/A                             | sets middle range (7-12) for H-shaft | 
 | TRUCK_SHIFT_HIGHRANGE     |     N/A                             | sets high range (13-18) for H-shaft | 
+| TRUCK_CYCLE_GEAR_RANGES    |     N/A                             | toggle between low/middle/high gear ranges | 
 | TRUCK_SWITCH_SHIFT_MODES       | Q                   | toggle between transmission modes | 
 
 ### Airplane

source/gameplay/general-faq.md

@@ -89,4 +89,4 @@ To play multiplayer, see [this section](beginners-guide.md#multiplayer) of the B
 
 This means you're trying to join a server that is running an older or newer RoRNet version than what your current RoR version supports.
 
-The latest version, 2022.12, supports RoRNet 2.44.
+The latest version, 2026.01, supports RoRNet 2.45.

source/gameplay/installing-the-game.md

@@ -1,71 +1,104 @@
-Installing the game
-============
+# Installation Guide
 
-## Installation 
+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.
 
-### Downloading
+[![Available on itch.io](https://static.itch.io/images/badge-color.svg){ width=150 loading=lazy }](http://rigs-of-rods.sf.net/itch/dev/)
 
-To get started, download the latest version of the game from our [homepage](https://www.rigsofrods.org/).
+!!! danger "Don't place your device at risk"
+    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.
 
-![download](../images/bg-download2021.png)
+## Windows
 
-From here, choose which package you would like to install. We recommend the Installer for beginner users. 
 
-![options](../images/bg-downloadopt2021.png)
+!!! warning ""Windows protected your PC" Windows SmartScreen"
+    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.
 
-You will be redirected to Sourceforge, and the file will automatically download. Once downloaded, double-click the file to start the installer.
+### with Installer <small>recommended</small> { #with-installer data-toc-label="with Installer" }
 
-**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/).**
+<figure markdown>
+  ![Install guide](../images/win-install-ror.gif){ loading=lazy }
+  <figcaption>Windows 11 version 21H1</figcaption>
+</figure>
 
-### Windows SmartScreen warning
+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.
 
-![smartscreen](../images/bg-smartscreen.png)
+When your download finishes, follow these steps to quickly go through the installer.
 
-When launching the installer for the first time, Windows Defender SmartScreen may prevent the installer from starting. 
+1. Select your language, by default it is English. Click *Next*.
+2. Accept the License Agreement by selecting *I accept the agreement* then click *Next*.
+3. If you wish to install to another location, select *Browse*, otherwise the default location will be used.
+4. If you want the installer to create a desktop shortcut check *Create a desktop shortcut*.
+5. Review the installation and click *Back* if you want to make any changes, otherwise click *Install* to begin the installation process.
+6. Upon completion of the installation read then click *Next*.
+7. Well done, the installation is now completed. Leave *Launch Rigs of Rods* checked and click *Finish* to launch Rigs of Rods.
 
-If this happens, click `More info` then `Run anyway`.
 
-The installer should launch once you accept the UAC dialog.
+### with Portable (.zip)
 
-### Installing
+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.
 
-Select your language, then click `OK`.
+When your download finishes, follow these steps to launch Rigs of Rods.
 
-![installer1](../images/bg-installer1.png)
+1. Extract the .zip into your desired location (Do not merge with an existing Rigs of Rods version!)
+2. Launch Rigs of Rods by double-clicking `RoR.exe`
 
-Click `Next`.
+## Linux
 
-![installer2](../images/bg-installer2.png)
+### with Portable (.zip) <small>recommended</small> { #with-portable-zip_1 data-toc-label="with Portable (.zip)" }
 
-Accept the agreement, then click `Next`.
+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.
 
-![installer3](../images/bg-installer3.png)
+When your download finishes, follow these steps to launch Rigs of Rods on Linux.
 
-If you wish to install RoR to another location, you can change it here. We recommend leaving it to the default location. 
+1. Extract the .zip into your desired location (Do not merge with an existing Rigs of Rods version!)
+``` bash
+unzip rigs-of-rods-linux.zip
+```
+4. It may not always be necessary, but grant the execute permission to the executable and script run file.
+```bash
+chmod +x ./RoR
+chmod +x ./RunRoR
+```
+3. Depending on your graphical interface, you may double-click `RunRoR` or run from the terminal.
+``` bash
+./RunRoR
+```
 
-![installer4](../images/bg-installer4.png)
+### with Snap Store
 
-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.
+**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.
 
-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.
+``` bash
+sudo snap install rigs-of-rods
+```
 
-Click `Next` to continue. 
+### with AUR
 
-![installer5](../images/bg-installer5.png)
+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.
 
-If you want the installer to create a desktop icon, check the box. Click `Next` to continue. 
+```bash
+paru -S rigsofrods
+```
+## Development Builds
 
-![installer6](../images/bg-installer6.png)
+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.
 
-Click `Install` to begin the installation process. 
+!!! warning "Try at your own risk!"
+    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.
 
-![installer7](../images/bg-installer7.png)
+### with itch.io Desktop App <small>recommended</small> { #with-itch-io-desktop-app }
 
-Once the installation finishes, read the message that appears then click `Next` to continue. 
+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.
 
-![installer8](../images/bg-installer8.png)
+[:fontawesome-solid-download: Download Rigs of Rods Experimental](http://rigs-of-rods.sf.net/itch/dev/){ .md-button .md-button--primary }
 
-Installation is now completed. Leave `Launch Rigs of Rods` checked then click `Finish` to launch RoR!
+### with itch.io (.zip)
 
-![installer9](../images/bg-installer9.png) 
+If you prefer not to use the the desktop app, you can still download the builds manually.
 
+1. Go to the the [Rigs of Rods itch.io build page](https://rigs-of-rods.itch.io/rigs-of-rods-dev).
+2. Download the development builds for Windows or Linux.
+3. Extract the contents to a preferred location.
+4. Run `RoR.exe` (Windows) or `./RunRoR` (Linux) to start the game.
+
+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. 

source/gameplay/tuning.md

@@ -1,12 +1,9 @@
 Tuning
 ============
 
-!!! warning
-	This feature is in development. It will be made available in an upcoming release. If you're interested in trying this out today, download the latest [development build](https://forum.rigsofrods.org/threads/ror-development-builds-for-windows-and-linux.696/).
-
 ## Introduction
 
-The tuning menu is a new single player feature available for vehicles. It enables the ability to install add-on parts, toggle visibility of meshes and visual effects, flip wheel direction, and save/load tuneups.
+Introduced in version 2026.01, the tuning menu is a new single player feature available for vehicles. It enables the ability to install add-on parts, toggle visibility of meshes and visual effects, flip wheel direction, and save/load tuneups.
 
 Tuning is currently disabled in Multiplayer, support will be added in a future release.
 

source/gameplay/vehicle-ai.md

@@ -186,19 +186,19 @@ Scroll to the end of the file, you should see lines similar to these:
 
 The waypoints are exported in JSON format. 
 
-From here you have two options:
+From here you can:
 
 - Name the preset and create an issue ticket on [GitHub](https://github.com/RigsOfRods-Community/ai-waypoints/issues) with the completed preset. Someone else will add it to the `waypoints.json` file. 
 
 - Download the `waypoints.json` file from [GitHub](https://raw.githubusercontent.com/RigsOfRods-Community/ai-waypoints/main/waypoints.json) (right click -> Save As, set file type to "All files")
 and place it in the `savegames` folder. RoR will load this file instead of downloading. Edit the file with your new preset, then create a pull request with your changes.
 
+The preset can also be added to a terrain using the [AI Presets](../terrain-creation/terrn2-subsystem.md#ai-presets-section) section.
+
 ## Limitations
 
 The current AI is an evolution of the per-terrain based AI featured on terrains such as F1 Test Track and Bajarama V2. It has some limitations:
 
-- You cannot set the vehicle speed per-waypoint. This also means an AI vehicle cannot stop at a waypoint (example: bus stops)
-
 - An AI vehicle in 'normal' mode will slow down at every waypoint. For most terrains this is fine but for others (such as race tracks) the AI drives too slowly. The current 'race' mode does not fix this as that mode will always drive at the same speed and won't slow down for corners.
 
 - As stated above, the 'chase' mode only targets the player and does not follow any other waypoints. This usually results in the chase vehicle crashing.