hiajen/MissingIdentifier
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

add Setup Instructions

Browse source
This commit is contained in:
Hiajen Hiajen 2021-03-07 19:31:31 +01:00
parent 221c930a32
commit 5606849f83
1 changed files with 60 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

84
README.md
View file

@ -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 <PREFIX>
```
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 <MODULE>
```
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 <filename>.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`)