From 5606849f833a9e3b74a15f9434963c747fc3f120 Mon Sep 17 00:00:00 2001 From: Hiajen Hiajen Date: Sun, 7 Mar 2021 19:31:31 +0100 Subject: [PATCH] add Setup Instructions --- README.md | 84 +++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 60 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 6bbf52d..e20d5d6 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,65 @@ -**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 +## How to use MissingIdentifier -**INVITE** -[CLICK](https://discordapp.com/oauth2/authorize?client_id=550770123946983440&scope=bot&permissions=285961296) +### Using my Bot hostet by me -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` +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 pre-set bot permissions to your linking). +2. Change Bot Prefix if other Bots use the same (and use it from now on instead of `!`): -**COMMANDS** -Please use `!help` to get a full command list + ``` +!admin setprefix +``` +3. Set a Modrole so non Guild-Owner are able to configurate this bot (Preferably the admin role) + + ``` +!admin setmodrole <@MODROLE> +``` +4. Use the `help` command to get a overview of teh awailable Modules and commands. +5. Active Modules to your liking: + + ``` +!admin +``` +6. Reenter the `help` command to get overview of new settings and commands available + +### Selfhost 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` + 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 exchange 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 (COMMING SOON) + +## Bug Report + +(COMMING SOON) + +## Contact + +Well finde me ... i am using the name `Hiajen` + +or just text me via [Matrix](https://matrix.to/#/@hiajen:matrix.hiajen.de) (`@hiajen:matrix.hiajen.de`)