-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Wiki updates, changelog to the correct url.
- Loading branch information
Showing
16 changed files
with
168 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1 @@ | ||
Added new wiki @ docs.tumppi066.fi | ||
This is still under construction. | ||
Update changelog url |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
--- | ||
# https://retype.com/configuration/page/ | ||
# please also see the docs for components | ||
# https://retype.com/components/alert/ | ||
authors: | ||
- name: Tumppi066 | ||
link: https://github.com/Tumppi066 | ||
avatar: https://avatars.githubusercontent.com/u/83072683?v=4 | ||
date: 2024-1-31 | ||
icon: stack | ||
tags: | ||
- plugin | ||
--- | ||
[!button Developer Documentation](Docs.md) | ||
|
||
### Description | ||
This plugin handles converting the steering offset from the lane detection models into a usable output for the game. | ||
|
||
### Usage | ||
This plugin will just work when it's enabled. | ||
**It is however important to note that this plugin won't do anything without a lane detection model, or a way of outputting the steering offset to the game.** | ||
|
||
### Configuration / UI | ||
|
||
+++ General | ||
==- Steering Offset | ||
Will control how much the steering will be offset from the center of the lane detection model. This is useful if you find the truck driving too far to the right or left. | ||
==- Control Smoothness | ||
Will control how many frames the steering offset will be averaged over. This will control how "smooth" the steering will be. | ||
!!!warning Warning | ||
Setting this value too high, especially on low FPS, will cause "bouncing" between the lanes. | ||
!!! | ||
==- Sensitivity | ||
Will control the multiplier on the steering. Essentially changing how much the app is responding to the input commands from the lane detection model. | ||
==- Maximum Control | ||
The maximum control the app is allowed to output. 1 is the maximum, 0 is the minimum. | ||
==- | ||
+++ Gamepad | ||
==- Gamepad mode | ||
Will smooth the input from the controller to the app. If you are using a gamepad then this is basically required. | ||
==- Control Smoothness | ||
Will control how many frames the steering offset will be averaged over. This will control how "smooth" the steering will be. | ||
==- | ||
!!! Note | ||
This page is only necessary if you are using vgamepad to replace the main steering axis in game. | ||
!!! | ||
+++ Keyboard | ||
==- Keyboard Mode | ||
Will listen to keyboard inputs instead of controller inputs. | ||
==- Keyboard Sensitivity | ||
How fast the steering will react to the keyboard inputs. | ||
==- Keyboard Return Sensitivity | ||
How fast the steering will return to the center when no keyboard inputs are detected. | ||
==- | ||
!!! Note | ||
This page is only necessary if you are using vgamepad to replace the main steering axis in game. | ||
!!! | ||
+++ | ||
|
||
|
||
### Installation | ||
This plugin will install the following python packages: | ||
=== opencv-python | ||
Used for image processing, in this case we use it to draw text on the output frame. | ||
=== pygame | ||
Used for gamepad input | ||
=== keyboard | ||
Used for keyboard input | ||
=== |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
--- | ||
# https://retype.com/configuration/page/ | ||
# please also see the docs for components | ||
# https://retype.com/components/alert/ | ||
authors: | ||
- name: Tumppi066 | ||
link: https://github.com/Tumppi066 | ||
avatar: https://avatars.githubusercontent.com/u/83072683?v=4 | ||
date: 2024-1-31 | ||
icon: stack | ||
visibility: hidden | ||
tags: | ||
- documentation | ||
--- | ||
!!!warning Warning | ||
This page is meant for `developers` | ||
!!! | ||
|
||
## Data variable usage | ||
The plugin will use the following data variable values: | ||
=== [!badge variant="ghost" text="Input"] data/LaneDetection/difference | ||
The input value from a lane detection plugin. | ||
=== [!badge variant="ghost" text="Input"] data/api/truckFloat/speed | ||
Input speed from the game. Used to automatically lower steering sensitivity at high speeds. | ||
=== [!badge variant="ghost" text="Input"] data/api/truckBool/blinkerLeftActive (and right) | ||
Used to disable the steering when indicating. | ||
=== [!badge variant="dark" text="Output"] data/Controller/leftStick | ||
The output value to the game. Goes from -1 to 1. | ||
=== | ||
|
||
### Example | ||
Copied from the BetterCamScreenCapture plugin: | ||
```python | ||
def plugin(data): | ||
steeringOutput = data["Controller"]["leftStick"] | ||
# Do something with the steeringOutput | ||
|
||
return data | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
order: 1 | ||
icon: book | ||
redirect: installation.md | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
authors: | ||
- name: Tumppi066 | ||
link: https://github.com/Tumppi066 | ||
avatar: https://avatars.githubusercontent.com/u/83072683?v=4 | ||
date: 2024-1-30 | ||
icon: stack | ||
tags: | ||
- tutorial | ||
--- | ||
|
||
[!embed](https://www.youtube.com/watch?v=0pic0rzjvik) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
1.9.15 | ||
1.9.16 |