Skip to content

Latest commit

 

History

History
324 lines (222 loc) · 10.5 KB

CONTRIBUTING.md

File metadata and controls

324 lines (222 loc) · 10.5 KB
Raw

Contributing

Hi there, if you're here, I'll say to you: THANKS !

Currently, you can only contribute for the map tiles, but in a future, I'll write somes lines to guide you for the code contribution.

You can join the discord to exchange about it ;) Discord

How to

If you want to contribute in this project, you can:

For the last point, please read in full this contribution guide.

Identify a problem

If you encounter a problem with this application, please check all suggestions:

  • The application launches without errors.
  • The device is connected on the same network as the application.
  • The game is launched and you are on the road (If you don't make the spawn once on the road, the connection will not be made).
  • Check if a known problem has been listed
  • Run the application as an administrator

If you still have a problem, you can open a bug on Github

Note: If the application crashes and closes immediately, you can open a terminal and type ets2-dashboard-skin.exe. With this, the application will not crash anymore and the error will be displayed.

Please give all mentioned information about the problem. Without this, I am not able to reproduce the problem and solve it.

  • Give the device used (PC, Tablette or Mobile)
  • Give the device details (OS, browser used)
  • Give the application version used
  • Give the SCS telemetry version used
  • Give the skin name if necessary
  • Give the log file

Logs

Logs data will be available in the place:

  • In-app logs
  • File on logs/ folder

To activate In-app log, tap five (5) time in the top-left corner to display the log view. You'll be able to copy and past them.

In-app logs

Contributing

Many thanks if you want to contribute on this project.

Please follow the "fork-and-pull" Git workflow.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull request so that we can review your changes

All point on the pull request description must be checked and completed (if applicable).

Prepare your local instance

Requirements

This project use NodeJs. Please be sure the NodeJs v14+ is installed before.

This project can be developed on Linux or Windows

Installation

  1. Clone this repository
  2. 1Install dependencies

Clone this repository

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

Install dependencies

$ npm i && npm rb

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

Useful commands

Description Command
Launch the dashboard development app $ npm run dashboard:dev
Build the dashboard dist files for the production $ npm run dashboard:build
Start the production version of dashboard $ npm run dashboard:start
Start a tiny version of server to get data through Socket $ npm run server:dev
Create a font with all svg files from the resources directory

To get more details, see RESOURCES.md		 $ npm run font:build
Launch the linter $ npm run lint

Others stuff

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

Map

The map tiles was generated from a side project: Unicor-p/ts-map

When can you request a map tiles update ? At each new minor release, you can request an update.

If a new map DLC are released through the same minor version of the current game, you don't need to follow this guide. You just need to generate the map tiles collection and share it to me. See this readme ;)

Example of valid version for the requesting:

  • 1.39.1.1
  • 1.40.1.1
  • 1.41.1.1

Example of INVALID version for the requesting:

  • 1.41.1.1
  • 1.41.2.1
  • 1.41.2.2

Tiles generation

  • 1/ Download the Unicor-p/ts-map program
  • 2/ Generate a setting file: TsMap2.exe export -s and follow instruction
  • 3/ Generate tiles TsMap2.exe export
  • 4/ Create an archive with all content from the Output folder

Update version

To keep a backward compatibility, we need to add the old map tiles entry on the map configuration.

For example, if you're on Euro truck simulator 2 or American truck simulator 1.40.x.x and a new version 1.41.x.x was just release, you must set an old value for the 1.40.x.x

Please note:

  • Only map tile update for minor release will be accepted (1.40.x.x, 1.41.x.x, etc...)
  • The map tiles will be updated when both game will on this new version

Edit the map configuration file

This file are located at src/data/config/map.json. On it, identify the entry maps_map_tilesVersion and add another entry at the end of values:

{
	"label" : "v1.40",
	"value" : "1.40"
}

Example of the maps_map_tilesVersion entry after editing:

{
	"id" :          "maps_map_tilesVersion",
	"label" :       "Game version",
	"description" : "The latest get the tiles for the latest version, else the specified version",
	"values" :      [
		{
			"label" : "Latest",
			"value" : "latest"
		},
		{
			"label" : "1.40",
			"value" : "1.40"
		}
	]
}

Translations

You can help to translate the application by following these steps.

The translations files are stored inside the src/translations/ folder.

All translations files are in YAML format. The key is the English version and the value is your locale.

The format for the file contents is: key : value, being key in English and value the translated equivalent.

Translate file in your locale

  1. Create a file at src/translations and name it to the desired BCP 47 Code, appended with the .yaml extension.
    Example for de-DE (German Germany): de-DE.yaml

  2. Open the new file with a text editor and copy the contents of another translation file into your new file, using fr-FR.yaml located at src/translations/fr-FR.yaml for example.

  3. Translate all keys, by changing the values to the desired language.

Example:

Delivered !: Geliefert !   
Config: Konfigurationen
  1. Add a new line at the end of the file with the language translated.

Example:

German: Deutsch

Note: Do not leave trailing spaces and try to respect punctuation marks.

Update the translations changes

As mentioned, when you create a new translation file, you need to indicate a new entry to others contributor.

  1. Open the doc\TRANSLATION_CHANGESmd readme. At the top, after # Next release, add a new line below ### Added containing the name of the new language.

Example:

### Added

- German

Enable your language

  1. Edit the file src/data/config-field-values.json and find the entry "general_skin_locale". Append the label and value sub-section, given that label is the language name and value is the BCP 47 Code.

Example:

"general_skin_locale": [
    ...
    {
        "label" : "German",
        "value" : "de-DE"
    }
]
  1. Edit the file src/utils/_i18n.js, and insert the importation line for your language
import fr_fr from '@/translations/fr-FR.yaml';
import cn_cn from '@/translations/cn-CN.yaml';
import ru_ru from '@/translations/ru-RU.yaml';
// Here >>
import de_de from '@/translations/de-DE.yaml';
  1. Add your language code at the end of availableLocale variable.
const availableLocale = ['fr-FR', 'en-EN', 'cn-CN', 'ru-RU', 'pt-PT', 'de-DE'];
  1. Insert a new case at currentLocaleTranslations before the default case.
...
// Here >
case 'de-DE':
    return de_de;
default:
    return {};

Test your language

Now, you can test your translation ! Save every change.

  1. Edit the file lib/config/config.json and replacing the value for the entrygeneral_skin_locale by your desired locale code.

Example:

"general_skin_locale": "de-DE"

  1. Launch the dashboard development server with $ npm run dashboard:dev, as described above in Useful commands

  2. Open your browser and navigate to one of the url's provided by the server.

  - Local:   http://localhost:8080/
  - Network: http://192.168.1.65:8080/
  1. Create a .env.local file as described here. This will let you launch the app without the game running, for testing purposes.

Publish your changes

  1. Create a pull request by following.

If you are having issues or don't know how to edit any file, you can ask for help or just edit the sample fr-FR.yaml file and send your translation via Discord. Some members may be able to help filling in the rest of the requirements.

More information about how to do a pull request can be found here Github - Creating a Pull Request