diff --git a/README.md b/README.md index 7a08ad5..67c527c 100644 --- a/README.md +++ b/README.md @@ -4,39 +4,39 @@ This is a Utility Discord providing some helpful and some not so helpful feature ## Features - * ANNOY: Sends a message to Guildmembers who did not choose a role yet - * AUTOSELECT: Grands users a Role when they react to a given reaction - * DICE: Roles a dice + * ANNOY: Sends a message to guild members who did not choose a role yet + * AUTOSELECT: Grands users a role when they react to a given reaction + * DICE: Rolles a dice * FOLD: Show some statistics about a [Folding@home](https://foldingathome.org) team. - * LOVECALC: chances of two users falling in love (no guarantee) + * LOVECALC: Chances of two users falling in love (no guarantee) * ONLINEHIGHLIGHT: Gives users a role who play a certain game - * PURGE: bulk delete messages - * QUOTE: Saves quotes and display them randomly + * PURGE: Bulk delete messages + * QUOTE: Saves quotes and displays them randomly * RANDOMRESPONDE: Answer to given trigger words - * SECRETCHANNEL: Grants member access to channels if they mention keywords + * SECRETCHANNEL: Grants members access to channels if they mention keywords * SHUFFLE: Color changing role - * STATS: some guild stats - * VOICELOBBY: Temporary Voice channels via command or joining certain channels + * STATS: Some guild stats + * VOICELOBBY: Temporary voice channels via command or joining certain channels * WELCOME: Messages for new members ## How to use MissingIdentifier ### Using my Bot hosted by me -1. Invite Bot to your Discord Guild using this [LINK](https://discordapp.com/oauth2/authorize?client_id=550770123946983440&scope=bot&permissions=285961296) (You may want to adjust the preset bot permissions to your linking). -2. Change Bot Prefix if other Bots use the same (and use it from now on instead of `!`): +1. Invite bot to your Discord guild using this [LINK](https://discordapp.com/oauth2/authorize?client_id=550770123946983440&scope=bot&permissions=285961296) (You may want to adjust the preset bot permissions to your linking). +2. Change bot prefix if other bots use the same (and use it from now on instead of `!`): ``` !admin setprefix ``` -3. Set a Mod-Role so non Guild-Owner are able to configure this Bot (Preferably the admin role) +3. Set a Mod-Role so non guild owner are able to configure this bot (preferably the admin role) ``` !admin setmodrole <@MODROLE> ``` -4. Use the `help` command to get an overview of the available Modules and commands. -5. Activate Modules to your liking: +4. Use the `help` command to get an overview of the available modules and commands. +5. Activate modules to your liking: ``` !admin @@ -46,19 +46,19 @@ This is a Utility Discord providing some helpful and some not so helpful feature ### Self host the bot 1. Create Discord Bot-User - 1. Go to the [Discord Developer](https://discord.com/developers/applications) Page - 2. Create a new Application and edit it to your liking - 3. navigate to `BOT` and hit `add Bot` - 4. may activate `Privileged Gateway Intents` (right now bot uses them, may a non presence mode will be implemented) - 5. Copy Bot-Token + 1. Go to the [Discord developer](https://discord.com/developers/applications) page + 2. Create a new application and edit it to your liking + 3. navigate to `BOT` and hit `add bot` + 4. may activate `Privileged Gateway Intents` (right now bot uses them, may a non presence mode be implemented) + 5. Copy bot token 2. Copy release .jar executable 3. Copy sample config to .jar location -4. Enter Bot-Token from step one into config file -5. run Bot (`java -jar .jar`) +4. Enter bot token from step one into config file +5. run bot (`java -jar .jar`) #### Updating -Just exchange the .jar executable +Just replace the .jar executable ### Building the bot your self @@ -72,7 +72,7 @@ Just exchange the .jar executable Uhm may just ask me to get started (COMING SOON) -## Bug Report +## Bug report (COMING SOON)