MissingIdentifier/README.md

67 lines
1.9 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).
## 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-07 21:45:17 +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).
2021-03-07 19:31:31 +01:00
2. Change Bot Prefix if other Bots use the same (and use it from now on instead of `!`):
```
!admin setprefix <PREFIX>
```
2021-03-07 21:45:17 +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
```
!admin setmodrole <@MODROLE>
```
2021-03-07 21:45:17 +01:00
4. Use the `help` command to get an overview of the available Modules and commands.
2021-03-09 19:01:23 +01:00
5. Activate Modules to your liking:
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
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`
2021-03-09 19:01:23 +01:00
4. may activate `Privileged Gateway Intents` (right now bot uses them, may a non presence mode will be implemented)
2021-03-07 19:31:31 +01:00
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
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
## Bug Report
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`)