Skip to content
This repository was archived by the owner on Jun 8, 2022. It is now read-only.

README.md

Latest commit

 

History

History
40 lines (29 loc) · 2.58 KB

README.md

File metadata and controls

40 lines (29 loc) · 2.58 KB

This repository is now obsolete and not maintained, in favour of main DevSubmarine Discord Bot, which has this feature built in, and more.

Luke Dictionary Bot

GitHub top language GitHub GitHub Workflow Status GitHub issues

!lukeadd <word> was a running joke for a long while now. Let's make the joke real.

This is a Discord bot that will allow people add Luke's misspellings to database, and then retrieve them.

Creating bot

To create the bot, go to Discord Developer Portal and create a new application. Make sure to grab Token from Bot tab, as it'll be needed in steps below.

To add the bot to the guild (server), go to OAuth2 tab, and create a new link. Make sure to select both bot and applications.commands scopes.

Running

Pre-requirements:

  • .NET 5.
  • MongoDB Cluster.
  • The bot is added to target guild (server). See Creating bot above.

Run locally:

  1. Download or clone.
  2. Run Database Bootstrapper tool to create MongoDB collections.
  3. Add appsecrets.json file ("Content" for Build Action, and "Copy always" or "Copy if newer" for Copy to Output Directory).
  4. Populate with secrets. See appsecrets.Example.json for example.
  5. Ensure IP Address of the host that will run the bot is whitelisted in your MongoDB cluster.
  6. Build and run.

Run on host:

  1. Follow steps 1 to 5 above.
  2. Publish LukeDictionary.Bot project.
  3. Move published files to host machine.
  4. Run dotnet LukeDictionary.Bot.dll, create a systemd service, or build and run Docker image using Dockerfile.

Note: Do NOT push this docker image to remote repo (like dockerhub) if you created appsecrets.json file. Just don't, unless you want yor secrets compromised.

License

Copyright (c) 2021 DevSubmarine & TehGM

Licensed under Apache 2.0 License.