Skip to content

Commit

Permalink
improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jthistle committed Mar 20, 2021
1 parent b163fba commit baee534
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
12 changes: 10 additions & 2 deletions linux/plugins/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
# ETS2 Local Radio unofficial Linux port
# ETS2 Local Radio Linux port

## Installation instructions

To build and install the plugin and utility script, you will need GCC and Make (these come standard with a lot of distributions).

In this directory, run the command:

```bash
make all && ./install.sh
```

You will need to copy the plugin `telemetry.so` manually to your plugins directory if ETS is not installed via Steam on your main partition, or if you are using ATS.
If you get errors, you probably need to install a dependency.

You will need to copy the plugin `ets2-telemetry-lin.so` manually to your plugins directory if ETS is not installed via Steam on your main partition, or if you are using ATS.

## Running

Expand All @@ -17,3 +21,7 @@ Go to the `server` directory and run:
```bash
python3 main.py
```

This will by default run at `localhost:3141`, but feel free to change the port by adding the `--port` flag.

Then just visit `localhost:3141` (or your specified) port to view the web interface!
2 changes: 1 addition & 1 deletion linux/plugins/plugin.cpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @brief TODO
* @brief This plugin hooks into the telemetry API for ETS2, and writes it to a shm file.
*/

#include <stdio.h>
Expand Down

0 comments on commit baee534

Please sign in to comment.