Skip to content

Commit

Permalink
Update the wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
Tumppi066 committed Jan 31, 2024
1 parent eebfe71 commit 1d1efc8
Show file tree
Hide file tree
Showing 7 changed files with 84 additions and 58 deletions.
16 changes: 13 additions & 3 deletions plugins/BetterCamScreenCapture/BetterCamScreenCapture.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ date: 2024-1-30
icon: stack
tags:
- plugin
- before lane detection
---

[!button Developer Documentation](Docs.md)
### Description
This plugin will capture your display extremely fast with DirectX and provide that data to the rest of the plugins.

Expand All @@ -33,8 +33,14 @@ This plugin will install the following python packages:
Used for capturing the display.
===

### Exclusivity
This plugin is exclusive to the following types:
=== ScreenCapture
We only want one screen capturing plugin.
===

### Debugging
##### 'The specified device interface or feature level is not supported on this system.'
==- 'The specified device interface or feature level is not supported on this system.'
There are two cases in which this error happens:
1. You have a device that has an integrated GPU (for example on a laptop), and python is running on the dedicated GPU.
2. Your computer is too old to support the directx version dxcam needs.
Expand All @@ -47,4 +53,8 @@ A common location could be `C:\Users\YourUserName\AppData\Local\Programs\Python\

***Fix for case 2:***

Disable dxcam and enable mss in the plugin menu. Keep in mind that plugins are designed to run on dxcam, and not everything will work with mss.
Disable dxcam and enable mss in the plugin menu. Keep in mind that plugins are designed to run on dxcam, and not everything will work with mss.

==-

[!button Developer Documentation](Docs.md)
12 changes: 4 additions & 8 deletions plugins/BetterCamScreenCapture/Docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ This page is meant for `developers`
!!!
## Data variable usage
The plugin will use the following data variable values:
=== data/frame
=== [!badge variant="dark" text="Output"]data/frame
The cropped image frame defined by the settings.

=== data/frameFull
=== [!badge variant="dark" text="Output"]data/frameFull
The full image from the display.

=== data/frameOriginal
=== [!badge variant="dark" text="Output"]data/frameOriginal
The original image. THIS SHOULD NOT BE EDITED!

===
Expand All @@ -41,8 +41,4 @@ def plugin(data):
# Return the data variable
data["frame"] = frame
return data
```


## Directly usable functions and values
**None**
```
17 changes: 15 additions & 2 deletions plugins/DefaultSteering/DefaultSteering.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ date: 2024-1-31
icon: stack
tags:
- plugin
- before controller
---
[!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.
Expand All @@ -23,6 +23,7 @@ This plugin will just work when it's enabled.
### 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
Expand All @@ -35,7 +36,9 @@ Will control the multiplier on the steering. Essentially changing how much the a
==- 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
Expand All @@ -44,7 +47,9 @@ Will control how many frames the steering offset will be averaged over. This wil
!!! 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
Expand All @@ -55,6 +60,7 @@ How fast the steering will return to the center when no keyboard inputs are dete
!!! Note
This page is only necessary if you are using vgamepad to replace the main steering axis in game.
!!!

+++


Expand All @@ -66,4 +72,11 @@ Used for image processing, in this case we use it to draw text on the output fra
Used for gamepad input
=== keyboard
Used for keyboard input
===
===

### Requirements
This plugin needs and will enable the following plugins:
=== TruckSimAPI
Used to communicate with the game.
===
[!button Developer Documentation](Docs.md)
39 changes: 19 additions & 20 deletions plugins/Examples/Panel/Panel.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ tags:
- panel
---

[!button Developer Documentation](Docs.md)
# REMEMBER TO CHANGE THE FILENAME TO THE PANEL FOLDER NAME AND REMOVE THIS LINE
### Description
What does this do?
Expand All @@ -24,24 +23,22 @@ There is no special usage notes... the panel should work as is.

PLEASE FILL WITH YOUR UI CONFIG. EXAMPLE HERE:

The UI includes some settings for the plugin. The settings are as follows:
```
Width : The width of the image capture
Height : The height of the image capture
X : The X coordinate of the image capture
Y : The Y coordinate of the image capture
Display : The display to capture from
Device : The device to capture from
```

FOR TABS:

+++ Tab1
Tab1 content
+++ Tab2
Tab2 content
+++ Tab3
Tab3 content
+++ Tab 1

==- Some Setting
Some setting stuff...
==- Some Other Setting
Some setting stuff...
==-

+++ Tab 2

==- Some Setting
Some setting stuff...
==- Some Other Setting
Some setting stuff...
==-

+++


Expand All @@ -56,4 +53,6 @@ Used for something else
OTHER NOTES HERE

### Debugging
PLEASE FILL IN OR REMOVE.
PLEASE FILL IN OR REMOVE.

[!button Developer Documentation](Docs.md)
10 changes: 5 additions & 5 deletions plugins/Examples/Plugin/Docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ This page is meant for `developers`

## Data variable usage
The plugin will use the following data variable values:
=== data/the/path/to/your/variable
The description of the variable
=== [!badge variant="dark" text="Input"]data/path/to/some/input/var
Some kind of description.

=== data/another/variable
The description of another variable
=== [!badge variant="dark" text="Output"]data/path/to/some/output/var
Some kind of description.

===

Expand All @@ -44,4 +44,4 @@ def plugin(data):
```

## Directly usable functions and values
**None / PLEASE FILL IN**
**REMOVE / PLEASE FILL IN**
40 changes: 21 additions & 19 deletions plugins/Examples/Plugin/Plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,24 +23,22 @@ There is no special usage notes... the plugin should work as is.

PLEASE FILL WITH YOUR UI CONFIG. EXAMPLE HERE:

The UI includes some settings for the plugin. The settings are as follows:
```
Width : The width of the image capture
Height : The height of the image capture
X : The X coordinate of the image capture
Y : The Y coordinate of the image capture
Display : The display to capture from
Device : The device to capture from
```

FOR TABS:

+++ Tab1
Tab1 content
+++ Tab2
Tab2 content
+++ Tab3
Tab3 content
+++ Tab 1

==- Some Setting
Some setting stuff...
==- Some Other Setting
Some setting stuff...
==-

+++ Tab 2

==- Some Setting
Some setting stuff...
==- Some Other Setting
Some setting stuff...
==-

+++


Expand All @@ -52,7 +50,11 @@ Used for something
Used for something else
===

OTHER NOTES HERE
### Exclusivity
This plugin is exclusive to the following types:
=== ScreenCapture / LaneDetection
Why?
===

### Debugging
PLEASE FILL IN OR REMOVE.
8 changes: 7 additions & 1 deletion retype.manifest
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"version": "3.5.0",
"created": "2024-01-31T17.00.58Z",
"created": "2024-01-31T17.40.40Z",
"files": [
{
"path": ".nojekyll"
Expand Down Expand Up @@ -1977,6 +1977,12 @@
{
"path": "src\\variables\\index.html"
},
{
"path": "tags\\before-controller\\index.html"
},
{
"path": "tags\\before-lane-detection\\index.html"
},
{
"path": "tags\\index.html"
},
Expand Down

0 comments on commit 1d1efc8

Please sign in to comment.