RecapTime
/
mcc-discord-rpc
mirror of https://gitlab.com/RecapTime/mcc-discord-rpc
1
1
Fork 0
Code Issues Projects Releases Wiki Activity
Public mirror of unofficial Discord Rich Presence for MC Championship, maintained by @ajhalili2006.
11 Commits 1 Branch 0 Tags 37 MiB
JavaScript 100%
Go to file
Andrei Jiroh Halili 541777c4e1 docs(global): 📝 add documentation Markdown files and LICENSE 
Signed-off-by: Andrei Jiroh Eugenio Halili <ajhalili2006@gmail.com>
 		2022-03-24 15:45:00 +00:00
.vscode chore(global): install more deps and add debugging stuff for VS Code 2022-03-22 15:15:05 +00:00
.yarn chore(global): 📦 more chaotic refresh on Yarn cache and lockfiles 2022-03-22 15:27:01 +00:00
docs docs(global): 📝 add documentation Markdown files and LICENSE 2022-03-24 15:45:00 +00:00
lib feat(global): add utility functions to library code + overhaul stuff 2022-03-22 15:29:40 +00:00
.editorconfig chore(global): ✨ initial commit 2022-03-13 16:33:21 +08:00
.gitignore chore(global): install more deps and add debugging stuff for VS Code 2022-03-22 15:15:05 +00:00
.gitpod.Dockerfile chore(global): install more deps and add debugging stuff for VS Code 2022-03-22 15:15:05 +00:00
.gitpod.yml chore(global): install more deps and add debugging stuff for VS Code 2022-03-22 15:15:05 +00:00
.pnp.cjs chore(global): 📦 more chaotic refresh on Yarn cache and lockfiles 2022-03-22 15:27:01 +00:00
.pnp.loader.mjs chore(devDependencies): 📦 add Commitizen and Commitlint related packages 2022-03-22 04:33:24 +00:00
.yarnrc.yml chore(global): 📦 more chaotic refresh on Yarn cache and lockfiles 2022-03-22 15:27:01 +00:00
LICENSE docs(global): 📝 add documentation Markdown files and LICENSE 2022-03-24 15:45:00 +00:00
README.md docs(global): 📝 add documentation Markdown files and LICENSE 2022-03-24 15:45:00 +00:00
app.js feat(global): add utility functions to library code + overhaul stuff 2022-03-22 15:29:40 +00:00
package.json chore(global): install more deps and add debugging stuff for VS Code 2022-03-22 15:15:05 +00:00
yarn.lock chore(global): 📦 more chaotic refresh on Yarn cache and lockfiles 2022-03-22 15:27:01 +00:00

README.md

Unofficial MCC Discord Rich Presence

Key Value
Maintability/Stability Status New Project / experimental
Description Unofficial Discord Rich Presence for MCC viewers/participants, in an REST API.
License MIT
Maintainer Andrei Jiroh
Canonical Repository https://gitlab.com/RecapTime/mcc-discord-rpc

Contains programmatic REST API to update Discord Rich Presence on the fly, especially for MCC viewers who use Discord. It's still not yet ready for production use, but we welcome accepting community contributions

Requirements

You need Node.js 16 (or later) and optionally Git if you choose not to download the source tarball (and want to easily update your copy).

Setup

  1. Make sure Yarn is installed, and if not try corepack enable && yarn (it's all same for PowerShell and Command Prompt).
  2. Navigate to your local copy of the repo (either through git clone https://gitlab.com/RecapTime/mcc-discord-rpc or extracted from tarball) and just run yarn start. No more npm install since we use Yarn Plug 'n Play in combination with offline caches checked in, especially in cases where Windows Defender will think Node.js processes are doing some ransomware-like activity on filesystem level when populating the node_modules directory via the regular npm install.
  3. Fire up Discord desktop client and enjoy. Optionally hook up your stream board to do some API calls behind the scenes.

Documentation

Additional documentation can be found on the docs directory, including asset key names and API Docs.