An easy tool to let others see your current job, truck, etc. on Discord!
Branch: master
Clone or download
Latest commit b72b2f3 Jan 17, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets Version 2.6.0 Sep 28, 2018
bat Version 2.5.2 Jun 26, 2018
setup Version 2.6.0 Sep 28, 2018
vbs Version 2.6.0 Sep 28, 2018
.gitignore Version 2.5.2 Jun 26, 2018
LICENSE Added License Jan 17, 2019
LogManager.js Version 2.6.0 Sep 28, 2018
README.md Fixed Errors Sep 29, 2018
RichPresenceManager.js Version 2.6.0 Sep 28, 2018
UpdateNotifier.js Version 2.6.0 Sep 28, 2018
UserGuide.md Version 2.6.0 Sep 28, 2018
clientconfiguration.json Version 2.6.0 Sep 28, 2018
compile.js Version 2.6.0 Sep 28, 2018
config.js Version 2.6.0 Sep 28, 2018
index.js Version 2.6.0 Sep 28, 2018
package-lock.json Version 2.6.0 Sep 28, 2018
package.json Version 2.6.0 Sep 28, 2018

README.md

Virtual Trucker Rich Presence on Discord

Version 2.6.0 (2.60)

An easy tool to let others see your current job, truck, etc. using Discord Rich Presence!

Here's our Discord server for support: https://discord.gg/Zt49WDH

Your image will change on the rich presence depending if your lights are on.
ETCARS 0.15 is required for the RPC to work, older versions will not work.
THIS VERSION INCLUDES ETCARS 0.15, YOU MUST DO A FULL INSTALL FOR THIS TO WORK

Things to note!

  • TruckersMP has their own Rich Presence which needs to be disabled in MP Settings!
  • Due to a few problems with previous ETCARS, you will need to install ETCARS 0.15 from our installer.
  • Promods isn't supported currently but there are future plans for supporting it.

Supports Euro Truck Simulator 2, American Truck Simulator and TruckersMP.

Rich presence example on Single Player

Rich presence example on Single Player

Rich presence example on Multiplayer

Rich presence example on Multiplayer

Changelog

  • Removed Rain Image
  • Updated Images
  • Changed Singleplayer Status Text
  • ATS Images Now Added!
  • Updated NPM Packages
  • Added Icon to Update Notifier
  • Added VT-RPC Icon to install directory
  • Location detection is now on SP and more reliable!
  • Removed Custom Message (No room for it on rpc)
  • New images once again!
  • Fixed a few bugs
  • README has had duplicated text removed
  • New logo added
  • When there's no MP connection but you're on MP it will now just say Multiplayer instead of connecting.
  • Fixed random crashes.

Use in end user environment

  • Install Virtual Trucker Rich Presence using a release installation package from Releases Page .

Take a look to User Guide for further details.

Use in development environment

But here is the most important information:

REQUIRED PROGRAMS:

  1. Install and download the required programs.
  2. Open cmd/powershell by holding shift while right clicking inside the VT-RPC directory.
  3. Install the required node modules by typing "npm i" in PS/CMD.
  4. Start the rich presence by typing "node index.js".
  5. Start ETS2.
  6. Select that and start playing!

Prepare for distribution

Without custom icon

  • Run npm run compile .
  • Bundled exe will be written in release directory.

With custom icon

  • Install Python 2.7 to c:\Python27 - https://www.python.org/ftp/python/2.7.14/python-2.7.14.msi
  • Set environment variable PYTHON to c:\Python27\
  • Run npm run compile --ico . Nexe will download node.js sources and compile it, first time will take a while. It's necessary to compile node from sources to set custom icon via nexe.
  • Bundled exe will be written in release directory.

Create installation package

  • Install InnoSetup - http://www.jrsoftware.org/isdl.php
  • Install Inno Download Plugin - https://bit.ly/2KnepSA
  • Open setup\InnoSetup.iss with InnoSetup and compile it
  • Run iscc .\setup\InnoSetupScript.iss (Add to PATH variable env C:\Program Files (x86)\Inno Setup 5)
  • Installation package will be written in setup\Output\VirtualTruckerRichPresenceSetup.exe

Why there is a VBScript in this project?

We need RunHidden.vbs to run a packaged node.js app windowless in windows. So, the application is launched from that vbscript.

Logging

Log file vtrpc.log is written in:

  • Windows: %appdata%\VirtualTruckerRichPresence\
  • Linux: /var/local/VirtualTruckerRichPresence/
  • MacOS: /home/Library/Preferences/VirtualTruckerRichPresence/

Startup parameters

  • --dev : enable verbose development logging and dev environment behaviour
  • --logetcarsdata : prints in console every ETCARS data received
  • --logallactivity : prints in console every activity sent to Discord
  • --clientConfiguration : specify clientconfiguration.json path

Credits To Staff

Current Staff

dowmeister: ETCARS plugin, coding, Trucky & Trucky API.
SgtBreadStick: Coding, Images, Website Developer.
Josh Menzel: ETCARS plugin, compatibility with ETCARS.
Rein: Images.
Heyhococo: Testing, Mac Testing.

Retired Staff

Lasse: Initial project, coding.