Skip to content

Latest commit

 

History

History
96 lines (68 loc) · 4.75 KB

README.md

File metadata and controls

96 lines (68 loc) · 4.75 KB
Raw

jdr9000

A simple Discord bot

Basic features:

  • The prefix before each command can be changed in .env (default is /)
  • /man to list available commands. Also takes commands as arguments (f.e /man jdr)
  • /ah Invokes the spirit of Denis Brogniart
  • /aws and /async-aws Sends gifs of dogs that know that they're doing
  • /clfu Post snippets from commandlinefu.com. See man for args. Pass --public as second arg to make the bot answer on current channel.
  • /fear Fear the bot
  • /gandalf Post a gif + text and play Gandalf sound
  • /gif Post a gif depending on the argument (querying 3rd party API)
  • /jdr Commands useful for roleplay
  • /judgement Come in channel to play a sound (Currently set to Judgement Knights Of Thunder)
  • /omaewa Post a picture + mention
  • /roll Takes XdY argument, where X is the number of dices & Y the number of faces for dices. Ex: /roll 3d100
  • /r Shortcut for rolling 1D100
  • /say Implements phraze module
  • /stop Stop the sound played with /judgement
  • /waifu Posts an anime girl

Nerdy features:

Allows arbitrary code execution, so it's only accessible to powerusers.

Declare POWERUSERS

by providing their user.id in POWERUSERS environment variable, in csv format like so:

POWERUSERS=333331313111111111111331,13090932222222222222222

If you don't know your user.id, calling eval or sh will log it in console.

Commands

  • /eval Good ol' eval accessible from Discord. Can optionally be passed a js blockcode for more readability.
  • /sh Run bash commands thanks to child_process.exec & returns stdout in Discord
  • /lisp Run some lisp thanks to lips. Also accepts lisp blockcode.
  • /heapdump Takes an argument. ! Need to run node --expose-gc index.js instead of your usual node index.js to be able to "manually" proc the GC.

Install

Dependencies:

  • A shell (terminal)
  • FFMPEG (must be on your system. Type ffmpeg or ffmpeg -version in terminal to check)
  • Node.js >= 13 (node -v to check)

Launch project:

First time (in terminal): git clone https://github.com/TheRealBarenziah/jdr9000.git && cd ./jdr9000

Legacy:

  • Rename .env.template into .env
  • Change TOKEN field with your own API key (ex: TOKEN=yournewapikey)
  • First time launch: npm i && node index.js (npm i will install local dependencies)
  • Stop bot: Ctrl+C
  • Launch in development mode (node --expose-gc index.js) or in production mode (NODE_ENV=production node index.js)

Using Docker:

  • In the root directory, use docker image build -t jdr9000:v2 -f docker/jdrDockerfile . to build the image.
  • Use docker container run -tid -e TOKEN=YourToken -e PREFIX=YourPrefix --name jdr-v2 --restart=always jdr9000:v2 node --expose-gc index.js to launch the container from the image.

Using Kubernetes:

  • You will find the deployement manifest here kube/deploy_jdrbot.yaml
  • Use kubectl apply -f kube/deploy_jdrbot.yaml from the root directory of this repo to deploy the manifest on the kubernetes cluster described in your kubeconfig.
  • As you can see, this deployement is using a secret object containing your access Token
  • Create the secret using this command kubectl create secret generic discord-api-token --from-literal TOKEN="YourToken"
  • In the manifest, feel free to change, remove or add env vars and values.
  • You also can modify to your needs the args for the node command.
  • This deployement do not use hosted docker images, you have to build it with the dockerfile as seen previously.
  • Obviously, you will use the same name in the manifest as the name you used to build the image.

facultative:

Create a Discord server and invite your bot there (Discord dev website > Oauth section. Then tick "bot" and select appropriate permissions to get the invite link) see the documentation

Todo

  • check for bot id before letting him try to connect to vocal channel

Credits

Thanks Michiel Mulders for his article + repo that helped me get started in no time.