From 5606849f833a9e3b74a15f9434963c747fc3f120 Mon Sep 17 00:00:00 2001 From: Hiajen Hiajen Date: Sun, 7 Mar 2021 19:31:31 +0100 Subject: [PATCH 1/5] 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`) From ea86ba0c77f391f81be87e08f67e53e59a52f330 Mon Sep 17 00:00:00 2001 From: Hiajen Hiajen Date: Sun, 7 Mar 2021 21:45:17 +0100 Subject: [PATCH 2/5] some spelling --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index e20d5d6..0a78386 100644 --- a/README.md +++ b/README.md @@ -4,20 +4,21 @@ This is a Utility Discord providing some helpful and some not so helpful feature ## How to use MissingIdentifier -### Using my Bot hostet by me +### 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 pre-set bot permissions to your linking). +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 Modrole so non Guild-Owner are able to configurate 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 a overview of teh awailable Modules and commands. + +4. Use the `help` command to get an overview of the available Modules and commands. 5. Active Modules to your liking: ``` @@ -25,7 +26,7 @@ This is a Utility Discord providing some helpful and some not so helpful feature ``` 6. Reenter the `help` command to get overview of new settings and commands available -### Selfhost the bot +### Self host the bot 1. Create Discord Bot-User 1. Go to the [Discord Developer](https://discord.com/developers/applications) Page @@ -52,14 +53,14 @@ Just exchange the .jar executable ## Contributing -Uhm may just ask me to get started (COMMING SOON) +Uhm may just ask me to get started (COMING SOON) ## Bug Report -(COMMING SOON) +(COMING SOON) ## Contact -Well finde me ... i am using the name `Hiajen` +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`) From 19391b81964c4537dcadf8bae297c537761a425e Mon Sep 17 00:00:00 2001 From: Hiajen Hiajen Date: Tue, 9 Mar 2021 19:01:23 +0100 Subject: [PATCH 3/5] add some clarification --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0a78386..d333aa3 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ This is a Utility Discord providing some helpful and some not so helpful feature ``` 4. Use the `help` command to get an overview of the available Modules and commands. -5. Active Modules to your liking: +5. Activate Modules to your liking: ``` !admin @@ -32,7 +32,7 @@ This is a Utility Discord providing some helpful and some not so helpful feature 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` + 4. may activate `Privileged Gateway Intents` (right now bot uses them, may a non presence mode will be implemented) 5. Copy Bot-Token 2. Copy release .jar executable 3. Copy sample config to .jar location From 50aecceb157eb427996431fa53869528c6ae5f07 Mon Sep 17 00:00:00 2001 From: Hiajen Hiajen Date: Tue, 9 Mar 2021 19:18:19 +0100 Subject: [PATCH 4/5] Add Featurelist --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index d333aa3..7a08ad5 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,23 @@ 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: 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 + * 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 display them randomly + * RANDOMRESPONDE: Answer to given trigger words + * SECRETCHANNEL: Grants member 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 + ## How to use MissingIdentifier ### Using my Bot hosted by me From be4c07a2771838fb366146042976a2f8c2121d0f Mon Sep 17 00:00:00 2001 From: Hiajen Hiajen Date: Thu, 11 Mar 2021 12:05:40 +0100 Subject: [PATCH 5/5] some typos --- README.md | 46 +++++++++++++++++++++++----------------------- 1 file changed, 23 insertions(+), 23 deletions(-) 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)