GitHub - SubsurfaceStudios/Compensation-Bot-V2: The official bot of the Compensation VR discord server, including API commands and other helpful utilities.

This repository has been archived by the owner on Jul 2, 2023. It is now read-only.

SubsurfaceStudios / Compensation-Bot-V2 Public archive

Notifications You must be signed in to change notification settings
Fork 0
Star 1

The official bot of the Compensation VR discord server, including API commands and other helpful utilities.

compensationvr.tk

BSD-3-Clause license

1 star 0 forks Branches Tags Activity

Star

Notifications

Branches Tags

Name		Name	Last commit message	Last commit date
Latest commit History 28 Commits
.vscode		.vscode
data		data
src		src
.gitignore		.gitignore
.prettierrc		.prettierrc
LICENSE		LICENSE
README.txt		README.txt
package.json		package.json
pnpm-lock.yaml		pnpm-lock.yaml
tsconfig.json		tsconfig.json

Repository files navigation

  ______   _______
 / ___/ | / / ___/
/ /__ | |/ / /    
\___/ |___/_/     
      bot v3      

A bot for Compensation VR (found at https://compensationvr.tk)

======== Usage ========
1. Fill out data/config.json (see Configuration)
2. Install dependencies: pnpm i
3. Build: pnpm build
4. Start the bot with: pnpm start

==== Configuration ====
The configuration file (data/config.json) has the following properties:
 - "token" The bot's Discord token.
 - "sudoers" A list of user ids permitted to use sudo commands.
 - "log" A channel to log errors that occur in.
 - "messaging" Message bridge configuration:
    - "token" A CVR token to authenticate with (must be permament)
    - "channel" Which channels to sync:
       - "discord" The discord channel to sync
       - "ingame" The CVR channel to sync
    - "webhook" Credentials for the webhook used to display in-game messages.
                Can be left out, in which case the bot generates it automatically.