benediktmagnus/openrct2twitchserver

A Twitch integration server software for OpenRCT2.

openrct2twitchserver's Issues

The way to get a client ID changed

The referenced article to get a client ID is slightly outdated.
Twitch moved the registration of new apps to https://dev.twitch.tv/
When logging in with a Twitch account, one can create a new app and get a client ID for the new application.

I wonder if this will require me to get an OAuth token with that new app. My server starts and says that it is connected to the Twitch API, but the stream did not go live. Are additional steps required to get the server going?

Missing in Instructions: Install Node and NPM dependencies

In the README steps are missing to install the NPM and the projects dependencies before running the Node script.

To serve a wider audience the instructions should not imply that you know about Node and how its package system works.

Please add the following steps:

1. Install Node.js either from their website or through the software distribution in your operating system. The following steps imply that node is a globally accessible command. If this is not the case, you may run it from any folder by specifying the path of your installation like /path/to/node.
2. To install the projects dependencies run npm ci. The program npm can be found in the folder of you Node.JS installation.

Missing in Instructions: "Enable Twitch integration"

When playing a campaign, one needs to check "Enable Twitch integration" in the save dropdown menu of the game for the world to be affected.

This step can easily be missed when starting with OpenRCT streaming. It should be explained or an article from OpenRCT about this should be referenced in the instructions.

Potential security issues in dependencies of tmi.js

The project tmi.js is known to have several security issues according to the NPM Security advisory. I have not taken the time to identify, if these are affecting the uses in OpenRCT2TwitchServer.

Ticket in the upstream repo: tmijs/tmi.js#311

To check your dependencies for vulnerabilities run npm audit. If they have been fixed in their upstream packages, you can resolve them by running npm audit fix. In this case, the issues have not been resolved in tmi.js.

Error: Cannot find module 'tmi.js'

**I am trying to start the server but i got the next error:

Can you maybe help me out?**

Starting Twitch integration server for OpenRCT2...
internal/modules/cjs/loader.js:883
throw err;
^

Error: Cannot find module 'tmi.js'
Require stack:

• C:\Program Files\nodejs\node_modules\OpenRCT2TwitchServer-master\OpenRCT2Twitchserver.js
  at Function.Module._resolveFilename (internal/modules/cjs/loader.js:880:15)
  at Function.Module._load (internal/modules/cjs/loader.js:725:27)
  at Module.require (internal/modules/cjs/loader.js:952:19)
  at require (internal/modules/cjs/helpers.js:88:18)
  at Object. (C:\Program Files\nodejs\node_modules\OpenRCT2TwitchServer-master\OpenRCT2Twitchserver.js:4:13)
  at Module._compile (internal/modules/cjs/loader.js:1063:30)
  at Object.Module._extensions..js (internal/modules/cjs/loader.js:1092:10)
  at Module.load (internal/modules/cjs/loader.js:928:32)
  at Function.Module._load (internal/modules/cjs/loader.js:769:14)
  at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:72:12) {
  code: 'MODULE_NOT_FOUND',
  requireStack: [
  'C:\Program Files\nodejs\node_modules\OpenRCT2TwitchServer-master\OpenRCT2Twitchserver.js'
  ]
  }

Please specify the version of the tmi.js depencency

OpenRCT2TwitchServer/package.json

Line 8 in 3aed001

"tmi.js": ""

When not specifying the version of a dependency, npm audit will fail:

$ npm audit
npm ERR! code E400
npm ERR! 400 Bad Request - POST https://registry.npmjs.org/-/npm/v1/security/audits

As of 2018-Dec-31, the latest version of tmi.js is 1.2.1, which is also the version locked in package-lock.json.