MissingIdentifier/README.md

84 lines
2.7 KiB
Markdown
Raw Normal View History

2021-03-07 19:31:31 +01:00
# MissingIdentifier
This is a Utility Discord providing some helpful and some not so helpful features. It uses the [JDA wrapper](https://github.com/DV8FromTheWorld/JDA).
2021-03-09 19:18:19 +01:00
## Features
2021-03-11 12:05:40 +01:00
* 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
2021-03-09 19:18:19 +01:00
* FOLD: Show some statistics about a [Folding@home](https://foldingathome.org) team.
2021-03-11 12:05:40 +01:00
* LOVECALC: Chances of two users falling in love (no guarantee)
2021-03-09 19:18:19 +01:00
* ONLINEHIGHLIGHT: Gives users a role who play a certain game
2021-03-11 12:05:40 +01:00
* PURGE: Bulk delete messages
* QUOTE: Saves quotes and displays them randomly
2021-03-09 19:18:19 +01:00
* RANDOMRESPONDE: Answer to given trigger words
2021-03-11 12:05:40 +01:00
* SECRETCHANNEL: Grants members access to channels if they mention keywords
2021-03-09 19:18:19 +01:00
* SHUFFLE: Color changing role
2021-03-11 12:05:40 +01:00
* STATS: Some guild stats
* VOICELOBBY: Temporary voice channels via command or joining certain channels
2021-03-09 19:18:19 +01:00
* WELCOME: Messages for new members
2021-03-07 19:31:31 +01:00
## How to use MissingIdentifier
2021-03-07 21:45:17 +01:00
### Using my Bot hosted by me
2021-03-07 19:31:31 +01:00
2021-03-11 12:05:40 +01:00
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 `!`):
2021-03-07 19:31:31 +01:00
```
2021-03-07 19:31:31 +01:00
!admin setprefix <PREFIX>
```
2021-03-11 12:05:40 +01:00
3. Set a Mod-Role so non guild owner are able to configure this bot (preferably the admin role)
2021-03-07 19:31:31 +01:00
```
2021-03-07 19:31:31 +01:00
!admin setmodrole <@MODROLE>
```
2021-03-07 21:45:17 +01:00
2021-03-11 12:05:40 +01:00
4. Use the `help` command to get an overview of the available modules and commands.
5. Activate modules to your liking:
2021-03-07 19:31:31 +01:00
```
2021-03-07 19:31:31 +01:00
!admin <MODULE>
```
6. Reenter the `help` command to get overview of new settings and commands available
2021-03-07 21:45:17 +01:00
### Self host the bot
2021-03-07 19:31:31 +01:00
1. Create Discord Bot-User
2021-03-11 12:05:40 +01:00
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
2021-03-07 19:31:31 +01:00
2. Copy release .jar executable
3. Copy sample config to .jar location
2021-03-11 12:05:40 +01:00
4. Enter bot token from step one into config file
5. run bot (`java -jar <filename>.jar`)
2021-03-07 19:31:31 +01:00
#### Updating
2021-03-11 12:05:40 +01:00
Just replace the .jar executable
2021-03-07 19:31:31 +01:00
### 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
2021-03-07 21:45:17 +01:00
Uhm may just ask me to get started (COMING SOON)
2021-03-07 19:31:31 +01:00
2021-03-11 12:05:40 +01:00
## Bug report
2021-03-07 19:31:31 +01:00
2021-03-07 21:45:17 +01:00
(COMING SOON)
2021-03-07 19:31:31 +01:00
## Contact
2021-03-07 21:45:17 +01:00
Well find me ... i am using the name `Hiajen`
2021-03-07 19:31:31 +01:00
or just text me via [Matrix](https://matrix.to/#/@hiajen:matrix.hiajen.de) (`@hiajen:matrix.hiajen.de`)