diff --git a/README.md b/README.md index 6bbf52d..67c527c 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,83 @@ -**MISSINGIDENTIFIER a Utility Discord Bot** +# MissingIdentifier -This is a Utility Discord providing some helpfull and some not so helpfull features. -It uses the [JDA](https://github.com/DV8FromTheWorld/JDA) wrapper. +This is a Utility Discord providing some helpful and some not so helpful features. It uses the [JDA wrapper](https://github.com/DV8FromTheWorld/JDA). -**Features:** -* ANNOY Members without a role will get messaged once a day with a custom text -* FOLD Shows some statistics for a given [Folding@Home](https://foldingathome.org/) team -* SHUFFLEROLE A given role gets a new color one a while -* LOBBY Temporary voicechannels -* QUOTE Save quotes and show random quotes -* RANDOMRESPONSE Response if text contains a trigger word -* AUTOSELECT Give members roles by reacting -* DICE Role a dice -* PRUGE Delete Messages -* LOVECALC Calculate chances between two members -* WELCOME Welcome new members with a custom text -* STATS Show some Serverstats -* ONLINEHIGHLIGHT Gives User a given Role if they are playing one of a given set of games -* SECRETCHANNEL Add Users to Secretchat if they mention given keywords -* VOICELOBBY Moves Users joining a given Voicechannel to a temporary VoiceChannel +## Features -**INVITE** -[CLICK](https://discordapp.com/oauth2/authorize?client_id=550770123946983440&scope=bot&permissions=285961296) + * 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) + * ONLINEHIGHLIGHT: Gives users a role who play a certain game + * PURGE: Bulk delete messages + * QUOTE: Saves quotes and displays them randomly + * RANDOMRESPONDE: Answer to given trigger words + * 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 + * WELCOME: Messages for new members -note: on default only the Guildowner is able to use the bot! he have to set a Admin/Modrole, so others can configurate the bot! `!admin setmodrole @role` +## How to use MissingIdentifier -**COMMANDS** -Please use `!help` to get a full command list +### 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 `!`): + + ``` +!admin setprefix +``` +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: + + ``` +!admin +``` +6. Reenter the `help` command to get overview of new settings and commands available + +### 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 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`) + +#### Updating + +Just replace the .jar executable + +### Building the bot your self + +1. Clone Repo +2. Run `gradle fatJar` +3. .jar executable is located in ./build/libs/ + +(run the bot via `gradle run` should work fine too) + +## Contributing + +Uhm may just ask me to get started (COMING SOON) + +## Bug report + +(COMING SOON) + +## Contact + +Well find me ... i am using the name `Hiajen` + +or just text me via [Matrix](https://matrix.to/#/@hiajen:matrix.hiajen.de) (`@hiajen:matrix.hiajen.de`)