Skip to content

Commit

Permalink
Update main page
Browse files Browse the repository at this point in the history
  • Loading branch information
Tumppi066 committed Aug 29, 2024
1 parent 3a39f51 commit 65c5265
Show file tree
Hide file tree
Showing 16 changed files with 136 additions and 31 deletions.
1 change: 1 addition & 0 deletions Guides/index.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
icon: book
File renamed without changes.
1 change: 1 addition & 0 deletions Guides/installation/index.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
icon: download
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,11 @@ authors:
avatar: https://avatars.githubusercontent.com/u/83072683?v=4
date: 2024-3-3
icon: book
label: Manual Translation
tags:
- tutorial
---

!!! Warning
The translation backend and tokens are still not finalized. If you start translating now you might have to redo the work later on. We will also release a UI for translation shortly, it will display comments and other useful information while translating, making it easier.
I DO NOT ACCEPT TRANSLATIONS DUE TO THIS YET!
!!!
### Introduction to V2.0 translation
Unlike the previous versions, 2.0 has native translation support. This is done using several different json files.
==+ [!badge variant="ghost" text="Do not edit this file!"] [!badge variant="dark" text="keys.json"]
Expand All @@ -24,19 +21,22 @@ This file contains the base English translations. When translating use this as a
==+

### Language json file format
==- `name`
==+ `name`
The name of the language in the language itself.
==- `name_en`
==+ `name_en`
The name of the language in English.
==- `iso_code`
The ISO code of the language. Use the 2 letter code (`ISO 639-1 Code`) if your language has one, otherwise the 3 letter code (`ISO 639-2 Code`).
==+ `iso_code`
The ISO code of the language. Use the 2 letter code (`ISO 639-1 Code`).
https://www.loc.gov/standards/iso639-2/php/code_list.php
!!! Note
The iso_code variables **has to match** the file name of the translation file.

If your language does not have a 2 letter ISO code then you may use what you wish.
For example **zh-CN** for *Chinese (Simplified)*
!!!
==- `_COMMENTS`
Caps locked comments are comments only visible to editors that use the json files. Usually they are just used to explain the structure of the file.
==- `_CoMMeNTS`
==- `_comments`
Comments that are capitalized in any other way are shown to users of the translation UI. They might contain comments from translators to each other.
==- `keys`
This is how you actually translate. Just copy the key from keys.json and paste it, then add the translation.
Expand Down Expand Up @@ -112,8 +112,4 @@ Anything written here is overwritten by the comments.json file if there is a con
We use variables in the translations to add dynamic content. They are written as `{0}`, `{1}`, `{2}` etc... and are replaced with the actual content when the translation is used. You can see what the variables mean in the comments.json file, this file also often includes examples of how the translation would look in english.

**MAKE SURE TO KEEP ALL VARIABLES**
==+

### Not updating after translating!
![From @onayB09 on discord!](image.png)
If you get an error like this, then that means your local changes are preventing the app from updating. You should backup the file and then delete it. The app will then download the latest version of the file.
==+
File renamed without changes
1 change: 1 addition & 0 deletions Guides/translation/index.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
icon: globe
File renamed without changes.
5 changes: 0 additions & 5 deletions README.md

This file was deleted.

31 changes: 31 additions & 0 deletions Support Us.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
authors:
- name: Tumppi066
link: https://github.com/Tumppi066
avatar: https://avatars.githubusercontent.com/u/83072683?v=4
date: 2024-29-8
icon: heart
order: 99
---
### Translating ETS2LA
We are always looking for more translators to help us translate the app to more languages. If you are interested in helping us, then please check the translation page for more information.

[!ref](/Guides/translation/JSONTranslation.md)

### Become a helper on Discord
If you think you are well equipped to helping others with their issues, then you can simply head over to the #roles channel on discord to get the helper role. Keep in mind that people may ping you for help at any time, so only get the role if you truly willing.

### Become a Discord booster
This will help us keep many important discord features like the custom URL and better call quality. Just like with Ko-Fi donations you will receive an exclusive discord role for your donation.

[!ref](https://discord.gg/ets2la)

### Donate to fund development
We use a lot of GPU time to train our AI models. Even a little will go a long way towards funding the continued development. You will also receive an exclusive discord role for your donation.

Below is a Ko-fi widget that you can use to donate to us.


<iframe id='kofiframe' src='https://ko-fi.com/tumppi066/?hidefeed=true&widget=true&embed=true&preview=true' style='border:none;width:400px;padding:4px;background:#1e1e1e;border-radius:20px;' height='640' title='tumppi066'></iframe>

[!ref](https://ko-fi.com/tumppi066)
Binary file added assets/navigation.mp4
Binary file not shown.
Binary file added assets/settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/vehicle_detect.mp4
Binary file not shown.
Binary file added assets/visualization.mp4
Binary file not shown.
19 changes: 19 additions & 0 deletions media.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
icon: image
label: Media
---
#### Visualisation
!!! Note
This visualisation might or might not be the current version. What we can guarantee is that the current version will look better or equal to this one!
!!!
[!embed](assets/visualization.mp4)
#### Settings page(s)
![](assets/settings.png)
#### Navigation system debug
[!embed](assets/navigation.mp4)
#### Vehicle detection debug
!!! Note
The yolo model in this video is running at **2FPS**, we use a custom tracker to interpolate the positions to make tracking smooth.
This is also an earlier version, ignoring a few mistakes the detection is still quite comparable.
!!!
[!embed](assets/vehicle_detect.mp4)
43 changes: 31 additions & 12 deletions retype.manifest
Original file line number Diff line number Diff line change
@@ -1,36 +1,58 @@
{
"version": "3.5.0",
"created": "2024-08-11T20.16.46Z",
"created": "2024-08-29T15:48:05Z",
"files": [
{
"path": ".nojekyll"
},
{
"path": "404.html"
},
{
"path": "annotation\\index.html"
},
{
"path": "assets\\favicon.ico"
},
{
"path": "assets\\markdownlogo.png"
},
{
"path": "assets\\navigation.mp4"
},
{
"path": "assets\\settings.png"
},
{
"path": "assets\\vehicle_detect.mp4"
},
{
"path": "assets\\vehicledeetectionannotation\\annotation_example.png"
},
{
"path": "assets\\vehicledeetectionannotation\\blurry_vehicle.png"
},
{
"path": "CNAME"
"path": "assets\\visualization.mp4"
},
{
"path": "CNAME",
"old": true
},
{
"path": "guides\\installation\\beta-1\\index.html"
},
{
"path": "guides\\translation\\image.png"
},
{
"path": "guides\\translation\\jsontranslation\\index.html"
},
{
"path": "index.html"
},
{
"path": "installation\\beta-1\\index.html"
"path": "media\\index.html"
},
{
"path": "others\\annotation\\index.html"
},
{
"path": "resources\\css\\retype.css"
Expand Down Expand Up @@ -77,6 +99,9 @@
{
"path": "sitemap.xml.gz"
},
{
"path": "support-us\\index.html"
},
{
"path": "tags\\ai\\index.html"
},
Expand All @@ -91,12 +116,6 @@
},
{
"path": "tags\\vehicle-detection\\index.html"
},
{
"path": "translation\\image.png"
},
{
"path": "translation\\json-translation\\index.html"
}
]
}
42 changes: 42 additions & 0 deletions welcome.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
icon: home
label: Welcome
image: assets/markdownLogo.png
order: 100
---
![](assets/markdownLogo.png)

# Welcome to ETS2LA
**ETS2LA** is a project that aims to finally bring self-driving technology to **SCS Software's Truck Simulators**. This documentation is a work in progress and will be updated as the project progresses. If you have any questions, please ask in the Discord.

{.callout}
> Okay so I don't mean to spam this channel with my absolute excitement for this program, because I have already told you guys how much I love it, but I think it bears repeating one more time that I am in a wheelchair and do not have the manual dexterity to play this game on my own and it is ONLY because of this program that I am able to play the game! I absolutely love it and I really want the developers to know that I appreciate all their hard work into making this program. There is a sense of satisfaction that comes from being able to drive in a simulator when I can't even do it in the real world because of my disability. 🙂
>
> **Unnamed User** - ETS2LA Discord
* * *

### Features
#### :icon-git-branch: Full access to simulator data
Like many other applications we use a telemetry server in the ETS2 directory to get live data from the game. **However unlike others** we also have access to the games' road and prefab network to build a true full self-driving experience without the need for compute expensive vision models. **This also means that ETS2LA will work regardless of the camera or game version.*** You can now get those perfect cinematic shots without the need to hop onto multiplayer!

#### :icon-globe: Multilingual
We provide an easy to use translation framework for anyone to translate the app into their own language. The app will reload said language file on the fly, so you can see your the changes instantly.

#### :icon-location: Custom made navigation system
ETS2LA has a custom made A* based navigation system to find the shortest path to your destination**. This system is used because the game's own navigation system path cannot be accessed from the telemetry provided by the game.

#### :icon-log: State of the art custom AI models
We use state of the art AI models that are trained on a large dataset of custom annotated images created and labeled by our community! This allows us to have a much more accurate and reliable experience than what you would get out of the box.

#### :icon-terminal: A rich developer experience
We've built an easy to use backend that will let anyone create beautiful and functional plugins for ETS2LA. You can define an entire settings page with just a few lines of json. We also have a powerful event system that will let you listen to any events or keybinds from the game or within the app.

#### :icon-project: A beautiful and modern user interface
Built on top of NextJS and shadcn, we've made an easy to use and beautiful interface that will let you easily find what you need. We also include a visualization of the current state around the truck built with godot. Said visualization is highly inspired by a certain EV company...

* * *
\* The base self driving will work on any camera or game version, including VR use. But we still use vision models for vehicle detection, the app will not detect other vehicles and objects outside of the interior camera view.
\*\* The navigation system currently finds the **shortest path**. This is not guaranteed to be the **fastest path**.
* * *
[!ref Screenshots and Videos](/media.md)

0 comments on commit 65c5265

Please sign in to comment.