diff --git a/linux/plugins/README.md b/linux/plugins/README.md index b0c4c1789..540f9c6b3 100644 --- a/linux/plugins/README.md +++ b/linux/plugins/README.md @@ -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 @@ -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! diff --git a/linux/plugins/plugin.cpp b/linux/plugins/plugin.cpp index 2372c50a1..69a303853 100644 --- a/linux/plugins/plugin.cpp +++ b/linux/plugins/plugin.cpp @@ -1,5 +1,5 @@ /** - * @brief TODO + * @brief This plugin hooks into the telemetry API for ETS2, and writes it to a shm file. */ #include