Skip to content

Commit

Permalink
Fixed absolute links (#228)
Browse files Browse the repository at this point in the history 
* 🔧 Fixed image absolute links

* ✨ Fixed absolute links

* 🔧 Fixed missing Branding page
  • Loading branch information
@CuriousMike56
CuriousMike56 authored Nov 10, 2024
1 parent c56f5f6 commit b766c05
Show file tree
Hide file tree
Showing 49 changed files with 573 additions and 594 deletions.
1 change: 1 addition & 0 deletions mkdocs.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ nav:
- Visual editors: tools-tutorials/visual-editors.md
- How to contribute to community projects using GitHub: tools-tutorials/contributing-github.md
- Documentation contributing guide {How to edit the docs): tools-tutorials/docs-contributing-guide.md
- Branding: tools-tutorials/branding.md
- Vehicle creation:
- Truck file format: vehicle-creation/fileformat-truck.md
- Soundscript file format: vehicle-creation/fileformat-soundscript.md
Expand Down
52 changes: 26 additions & 26 deletions source/gameplay/beginners-guide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,51 +14,51 @@ When launching RoR for the first time, the user directory will be created. On Wi

The game should open in a small window:

![firstrun1](/images/bg-firstrun1.png)
![firstrun1](../images/bg-firstrun1.png)

Before playing, you should first change your settings. Begin by clicking `Settings`.

First, make sure the rendering system is set to `Direct3D9 Rendering Subsystem`. If it's set to `OpenGL Rendering Subsystem`, change it then restart RoR. If Direct3D9 doesn't appear on the list, install the [DirectX Runtime](https://cloudflare-ipfs.com/ipfs/Qmb5Qix9ikns8n83m2CJgXiFYjjF4i5mLHYVi7xCVuAZG5?filename=directx_Jun2010_redist.exe) and restart your PC.

If you're running Linux, ignore this as DirectX is not available.

![firstrun2](/images/bg-firstrun2.png)
![firstrun2](../images/bg-firstrun2.png)

Now select `Video Mode` and change it to your monitor's native resolution then restart the game to apply your changes.

![firstrun3](/images/bg-firstrun3.png)
![firstrun3](../images/bg-firstrun3.png)

![firstrun4](/images/bg-firstrun4.png)
![firstrun4](../images/bg-firstrun4.png)

Click `Settings` again, then click the `Graphics` tab.

The following settings should be fine for most people, but feel free to adjust them to fit your liking.

![firstrun5](/images/bg-firstrun5.png)
![firstrun5](../images/bg-firstrun5.png)

Then click the `Audio` tab and set the device and volume.

![firstrun6](/images/bg-firstrun6.png)
![firstrun6](../images/bg-firstrun6.png)

Once you're finished, restart the game again.

Now you're ready to begin playing. Start by clicking `Single player` to open the terrain selector.

![terrnselect](/images/bg-terrnselect.png)
![terrnselect](../images/bg-terrnselect.png)

For the sake of this tutorial, select *North St Helens*.

Once the terrain loads, you will spawn as a country person known lovingly as RoRBot. You control him with the arrow keys while using `SHIFT` to run and `SPACE` to jump (good for getting over bumps, or if you get stuck).

![rorbot](/images/bg-rorbot.png)
![rorbot](../images/bg-rorbot.png)

You spawn in front of a building known as the *Rig-a-Deal*. This is where you will spawn new trucks. Walk into the "Office" to bring up the selection menu. You can also spawn a vehicle anywhere at any time by pressing `CTRL+G`.

![vehselect](/images/bg-vehselect.png)
![vehselect](../images/bg-vehselect.png)

Use the mouse or arrow keys to move through the menus. Select the *DAF Semi truck*. The truck spawns inside the Rig-a-Deal with you inside it. If you happen to spawn the truck with RoRBot outside of the vehicle, simply hit `ENTER`/`RETURN` to get in a vehicle.

![daf1](/images/bg-daf1.png)
![daf1](../images/bg-daf1.png)

## Driving

Expand Down Expand Up @@ -92,9 +92,9 @@ Now, make your way back to the *Rig-a-Deal*.

You should see a large, grey, open-platform with an orange console. Park the truck (use `P` to set the parking brake) and hit `ENTER`/`RETURN` to get out. Note that the same camera commands work with RoRBot. Step in front of the orange console to open the load selector.

![daf2](/images/bg-daf2.png)
![daf2](../images/bg-daf2.png)

![loadselect](/images/bg-loadselect.png)
![loadselect](../images/bg-loadselect.png)


Select the *Semi trailer (37 tons)*.
Expand All @@ -103,7 +103,7 @@ Get back in the semi and drive in front of the load. Use the camera in third-per

The hook points must be within 10cm to hook, so it may take some practice to get close. When you think you're close, hit `L`. If you're close enough, the semi will latch to the trailer. Raise the legs by holding `F1`.

![daf3](/images/bg-daf3.png)
![daf3](../images/bg-daf3.png)

You can now drive around with the trailer. You will notice that the trailer has a large effect on how the semi pulls and handles! This process is the same for most trailers. In some cases you can secure loads to trucks using `O`.

Expand All @@ -113,7 +113,7 @@ NOTE: on some computers trailers may increase lag or decrease FPS(frames per sec

Now that we've become comfortable with driving. Let's try to fly. Move your mouse to the to top of the screen to bring up the menubar, click `Vehicles` then `Antonov 12` to instantly enter the plane which is sitting on the runway.

![planeselect](/images/bg-planeselect.png)
![planeselect](../images/bg-planeselect.png)

Apply the parking brake by pressing `P`. Turn on the flying lights by pressing `M`. Start the engines by using your mouse to click the `ON` buttons in the lower right hand corner (or by pressing `CTRL+HOME`).

Expand All @@ -123,29 +123,29 @@ If you have a short runway, be sure to use the flaps with `1` and `2` (this is e

The An-12 does not stand high speeds (175+ knots) well, and you may find that if you go too fast the wings will break apart!

![plane1](/images/bg-plane1.png)
![plane1](../images/bg-plane1.png)

![plane2](/images/bg-plane2.png)
![plane2](../images/bg-plane2.png)


When it comes to landing, make sure you have room to slow down and take your time. Going straight into the runway is the easiest way to land when you first start off. It may take a few passes to go head-on so don't be afraid to abort a landing and throttle back up to regain altitude. The entire process is easier if you shadows enabled, but is possible without. When you land, hit `R` to reverse thrust and throttle up to slow down in addition to using `B` to brake the wheels.

This tutorial does not make use of the autopilot. For more information regarding the use of autopilot, see [Aircraft handling](/gameplay/aircraft-handling/).
This tutorial does not make use of the autopilot. For more information regarding the use of autopilot, see [Aircraft handling](aircraft-handling.md).

## Boating

We must explore beyond Coldwater to get to the marina. Take the main road out of Coldwater, heading southwest toward the Elk Hotel. Take the second left after you leave town. You should see the water soon.
When you arrive at the marina, you should see marina-style boat docks and a ramp along with a building.

![boat1](/images/bg-boat1.png)
![boat1](../images/bg-boat1.png)

Walk around to the front of the building and enter the open door. Choose the Wahoo boat.

![boatselect](/images/bg-boatselect.png)
![boatselect](../images/bg-boatselect.png)

Use `UP`/`DOWN` to throttle and `LEFT`/`RIGHT` to steer. Use `PGUP` to center the throttle (to neutral) and `PGDOWN` to center the rudder. It may take you a while to get your sea legs. If you have waves enabled, see how far out you can go before you flip over waves!

![boat2](/images/bg-boat2.png)
![boat2](../images/bg-boat2.png)

## Conclusion

Expand All @@ -155,30 +155,30 @@ Now that you have a basic grasp of the basic vehicles in RoR, it is now up to yo

If you feel like sharing the experience, you can play on one of the many public multiplayer servers. To get started, click the `Multi player` button on the main menu.

![mp1](/images/bg-mp1.png)
![mp1](../images/bg-mp1.png)

Set your username by clicking on `Settings` and changing it in the `Player nickname` textbox.

![mp2](/images/bg-mp2.png)
![mp2](../images/bg-mp2.png)

You may have to restart the game for the changes to take effect.

Now just select the server you want to play on, then click `Join`.

![mp3](/images/bg-mp3.png)
![mp3](../images/bg-mp3.png)

The 'any' servers allow you to select a terrain, while other servers (such as Official Nhelens) are set to use a specific terrain.

While on a server, you can enable collisions between other players or hide nicknames by going to `Settings` in the top menubar.

![mp4](/images/bg-mp4.png)
![mp4](../images/bg-mp4.png)

Note that multiplayer is still in development and can be unstable at times!

## Default controls

Please see the [Controls and configuration](/gameplay/controls-config/) page for a full list of controls.
Please see the [Controls and configuration](controls-config.md) page for a full list of controls.

## Adding content

To add new vehicles and terrains, go to the [Installing content](/gameplay/installing-content/) page.
To add new vehicles and terrains, go to the [Installing content](installing-content.md) page.
18 changes: 9 additions & 9 deletions source/gameplay/common-issues.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ This page explains the most common problems players may experience with Rigs of

When attempting to launch RoR or change game settings, you may receive one of these errors or a variation of them:

![create-settings-error](/images/create-settings-error.png)
![create-settings-error](../images/create-settings-error.png)

![error](/images/error-special-chars.png)
![error](../images/error-special-chars.png)

![error2](/images/error-generatecontent.png)
![error2](../images/error-generatecontent.png)

### Causes

Expand Down Expand Up @@ -54,9 +54,9 @@ OneDrive is known to prevent RoR from accessing the Documents folder. The only s

## No render system plugin available

![error_no_rendersys_avail](/images/error_no_rendersys_avail.png)
![error_no_rendersys_avail](../images/error_no_rendersys_avail.png)

![error_no_render_sys_selected](/images/error_no_render_sys_selected.png)
![error_no_render_sys_selected](../images/error_no_render_sys_selected.png)

If you downloaded RoR using the zip file, you may receive these errors. This is caused by the DirectX 9 Runtime not being installed. Install it from [Microsoft's website](https://www.microsoft.com/en-us/download/details.aspx?id=8109) then restart your PC.

Expand All @@ -81,7 +81,7 @@ Older versions:

## Full screen crash (Cannot create device)

![error-createdevice](/images/error-createdevice.png)
![error-createdevice](../images/error-createdevice.png)

This error is usually caused by enabling full screen with the wrong resolution (video mode) set.

Expand All @@ -93,7 +93,7 @@ If this doesn't fix your error, then your GPU is most likely too old to run RoR.

## Null program bound

![error-nullprogrambound](/images/error-nullprogrambound.png)
![error-nullprogrambound](../images/error-nullprogrambound.png)

This error occurs with some Intel integrated graphics chips. Unfortunately there's currently no fix.

Expand All @@ -106,7 +106,7 @@ More info: [GitHub issue](https://github.com/RigsOfRods/rigs-of-rods/issues/2385

With some GPUs (mostly integrated ones), shadows on vehicles may appear glitchy:

![shadows-glitch](/images/shadows-glitch.gif)
![shadows-glitch](../images/shadows-glitch.gif)

This is caused by your GPU not supporting self-shadowing (Shadows from other objects casting onto the vehicle). Please try one of the following workarounds:

Expand Down Expand Up @@ -146,4 +146,4 @@ If you prefer to use the default materials instead, do the following:

If the game crashes when spawning an aircraft, change the Lights setting (Graphics tab) to anything that isn't `None (fastest)`:

![airplane-crash-lights-fix](/images/airplane-crash-lights-fix.png)
![airplane-crash-lights-fix](../images/airplane-crash-lights-fix.png)
42 changes: 21 additions & 21 deletions source/gameplay/controls-config.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -244,9 +244,9 @@ because some planes could have more than 4 engines and you couldn't control them

Starting with Rigs of Rods version 2021.10, it is now possible to remap keyboard controls in-game. Just press the Controls button on the main menu:

![main-menu-controls-button](/images/main-menu-controls-button.png)
![main-menu-controls-button](../images/main-menu-controls-button.png)

![controls-menu](/images/controls-menu.png)
![controls-menu](../images/controls-menu.png)

From here it's pretty self-explanatory, just select which control you want to change and press the new key.

Expand Down Expand Up @@ -942,23 +942,23 @@ This has been tested with a DualShock 4 controller, these instructions should a
To begin, install [Steam](https://store.steampowered.com/about/) if you don't already have it and sign in.

You will first have to enable PlayStation controller support. Click `Steam` -> `Settings`
![steam-settings](/images/steam-settings.png)
![steam-settings](../images/steam-settings.png)

On the Controller tab, select `General controller settings`

![steam-controller-settings](/images/steam-controller-settings.png)
![steam-controller-settings](../images/steam-controller-settings.png)

Enable `PlayStation Configuration Support` then click `Back` to return to the settings menu

![steam-ps-support.png](/images/steam-ps-support.png)
![steam-ps-support.png](../images/steam-ps-support.png)

Next you'll have to add RoR as a non-Steam game. To do this click `Games` -> `Add a Non-Steam Game to My Library...`

![steam-non-steam-game](/images/steam-non-steam-game.png)
![steam-non-steam-game](../images/steam-non-steam-game.png)

Click ![steam-browse](/images/steam-browse.png), locate where RoR is installed (usually `C:\Program Files\Rigs of Rods`) then double-click `RoR.exe`
Click ![steam-browse](../images/steam-browse.png), locate where RoR is installed (usually `C:\Program Files\Rigs of Rods`) then double-click `RoR.exe`

![steam-add-non-steam-game](/images/steam-add-non-steam-game.png)
![steam-add-non-steam-game](../images/steam-add-non-steam-game.png)

Finally, click `Add selected programs`. RoR will now be in your game library.

Expand All @@ -981,7 +981,7 @@ For advanced editing you'll need to edit the `Controller__XBOX_360_For_Windows_.

#### Setting up the input map and FreePIE script

After installing the above applications, download [this zip file](/download/RoR_Mouse_Control.zip) which contains the required input map and FreePIE script.
After installing the above applications, download [this zip file](../download/RoR_Mouse_Control.zip) which contains the required input map and FreePIE script.

There will be two files in the zip: `vJoy_Device.map` and `MouseControl.py`.

Expand All @@ -991,15 +991,15 @@ Extract both files into `Documents\My Games\Rigs of Rods\config`.

Open FreePIE and press `File -> Open`. Browse to the `MouseControl.py` file you downloaded earlier:

![1](/images/FreePIE-1.png)
![1](../images/FreePIE-1.png)

![2](/images/FreePIE-2.png)
![2](../images/FreePIE-2.png)

![3](/images/FreePIE-3.png)
![3](../images/FreePIE-3.png)

Then press `Script -> Run script`:

![4](/images/FreePIE-4.png)
![4](../images/FreePIE-4.png)

The script should now be running. If you get an error, install vJoy.

Expand All @@ -1020,19 +1020,19 @@ The easiest way to configure your device for use in Rigs of Rods is to use the [
!!! note
If you have vJoy installed, you will have to disable it before running the tool!

![vJoyDisable](/images/vJoyDisable.png)
![vJoyDisable](../images/vJoyDisable.png)

### Launching the tool

After downloading, extract the zip into a new folder. Then double-click `Run.bat` to launch the tool.

![5](/images/InputMappingTool-1.png)
![5](../images/InputMappingTool-1.png)

### Adding new inputs

To begin adding inputs, click `Add`.

![6](/images/InputMappingTool-2.png)
![6](../images/InputMappingTool-2.png)

Select the event you want to assign an input to. In this example, I will use `TRUCK_ACCELERATE`

Expand All @@ -1052,11 +1052,11 @@ Click `Add` once ready, the tool will then ask you to move the axis/press a butt
The popup will automatically close once the requested action is completed.
If not, press Enter.

![7](/images/InputMappingTool-3.png)
![7](../images/InputMappingTool-3.png)

Repeat the process for all the inputs you want to add.

![8](/images/InputMappingTool-4.png)
![8](../images/InputMappingTool-4.png)

Once you're done, it's time to export the keymap.

Expand All @@ -1067,11 +1067,11 @@ Once you're done, it's time to export the keymap.

Click `Export Keymap` then select your device from the list.

![9](/images/InputMappingTool-5.png)
![9](../images/InputMappingTool-5.png)

Browse to `Documents\My Games\Rigs of Rods\config`, then click `Open` to save the file.

![10](/images/InputMappingTool-6.png)
![10](../images/InputMappingTool-6.png)

And finally, run Rigs of Rods and test your device! If you wish to make further edits in the future, you can import your input map by clicking `Import Keymap`.

Expand Down Expand Up @@ -1119,7 +1119,7 @@ This is what you'll want to name your file. You can choose to just save your inp

If you rename the file, it is highly recommended you enable file extensions (View -> File name extensions):

![explorer-file-ext](/images/explorer-file-ext.png)
![explorer-file-ext](../images/explorer-file-ext.png)

This is to help avoid you naming the file `.map.map` by mistake.

Expand Down
Loading

0 comments on commit b766c05

Please sign in to comment.