Eurotruck Simulator 2 Dashboard skin

CodeFactor GitHub Version GitHub Milestone GitHub Commit since GitHub Release Download Github Licence GitHub Release Date Dependecy Status devDependencies Status

About

The idea with this repository is to update a collection of dashboard from the Funbit repository with the newest SCS SDK.

And then, use a best way to maintain the different dashboard.

The first to be rework are my own dashboard. In the future, all dashboard in the Funbit repository will be include

This project was based on the TruckSim-Telemetry-Demo

Screenshot

Info

The current stable version have a memory leak issue. It may cause slow down on the data update or cause a crash for the app. I’m still on a solution research.

What’s it ?

This is an web app who you can switch over dashboard skin (Custom or from other truck brand (DAF, Man, Mercedes, Renault, Scania or Volvo)). See screenshots here

I’m also introduce the possibility to change the unit of measurement as you prefer. See the full list here

A event overlay can also be configured !

It’s work on desktop and mobile browser.

Requirements

Important: It dosen’t work with all Internet Explorer browsers

Installation

Prerequisite

Install scs-sdk-plugin by RenCloud

For normal use

You can use this dashboard without build anything.

You can download the *.tar.gz archive from the release page.

Extract this archive and run the ets2-dashboard-skin_vX.X.X.exe. That’s it !

See the How to use section to know how to run it !

Note: You need to start the game to see the dashboard

For development

  1. Install the prerequisite things
  2. Install the Windows-Build-Tools
  3. Clone this repository
  4. Build this project
  5. Run the ets2-dashboard-skin_vX.X.X.exe place on the bundle directory

Windows-Build-Tools

Install Windows-Build-Tools

$ npm install --global windows-build-tools

Clone this repository

$ git clone https://github.com/JAGFx/ets2-dashboard-skin.git
$ cd ets2-dashboard-skin

Build resources

$ npm i && npm rb
$ npm run server:install
$ npm run build

How to use ?

First, you need to run the dashboard app. See the Installation section End then run the ETS2 or ATS game.

Use from desktop device

  1. Open your favorite web browser
  2. Go to http://localhost:3000

And that’s it :D

Use from a mobile device

  1. Find your local IP address for your PC (Find how here)
  2. Open a web browser on your mobile device
  3. Access to the dashboard on your mobile: http://<YOUR_LOCAL_IP>:3000 (e.g. http://192.168.1.42:3000)
  4. And voilà ! You can enable / disable the fullscreen on tap on the dashboard

Note: Your mobile device AND your PC need to be on the same network

Tip: You can save a shortcut on your home screen to use it as an app like.

Know issues

If you found an issue, please see the KNOW_ISSUES.md. Your issue may be already known.

Features

To see all features used into the dashboard, see the FEATURES.md.

Skins

To know more about the skin integrated or how to add a new skin, see the SKINS.md

Configuration

To know more about the configuration, see the CONFIG_SETTINGS.md

Development

Environment file

This project use a .env file. If you wan to override one or more variable in the development, create a .env.local at the same place of the .env file

Telemetry data

If you want to use a fake file data instead of the data from the SCS API, set the VUE_APP_USE_FAKE_DATA to true

VUE_APP_USE_FAKE_DATA=true

Resources

I provide all resources what i’m use to develop this dashboard. Such as svg, AI file for svg or others element who can be need to contribute too.

See the RESOURCES.md section to get more details

Commands

Dashboard

Dev

Launch the dashboard development app

$ npm run dashboard:dev

Build

Build the dashboard dist files for the production

$ npm run dashboard:build

Start

Start the production version of dashboard

$ npm run dashboard:start

Server

Install

Install server dependencies

$ npm run server:install

Build

Build the server dist files for the production

$ npm run server:build

Start

Start the production version of the server

$ npm run server:start

OR

$ npm start

Dev

Start a tiny version of server to get data through Socket

$ npm run server:dev

Production

Build

Build the dist files for the dashboard, the server and font

$ npm run build

Bundle

Generate a *.tar.gz archive with all production files of Dashboard and Server

$ npm run bundle

Build and Bundle

Combine Build task and Bundle task

$ npm run bAndB

Other

Font build

Create a font with all svg files from the resources directory

To get more details, see RESOURCES.md

$ npm run font:build

ESLint

Launch the lint inspector

$ npm run lint

License

Under the MIT License

© JAGFx - hey@emmanuel-smith.me