47 lines
2.0 KiB
Markdown
47 lines
2.0 KiB
Markdown
<h1 align="center">IEEEvents Bot</h1>
|
|
<p align="center"><i>Made with :heart: by <a href="https://github.com/GreatGodApollo">@GreatGodApollo</a></i></p>
|
|
|
|
A Discord bot that mirrors events from an iCal file to Discord, and allows users to browse them
|
|
|
|
## Important Note
|
|
The bot does not yet clone the events from iCal to Discord, rather it only currently implements a command to view the events. This is a limitation of using JDA 4.x instead of the newest JDA 5.x branch. Once JDA 5.x is stable, the bot will clone the events.
|
|
|
|
## Built With
|
|
|
|
- [sksamuel/hoplite](https://github.com/sksamuel/hoplite)
|
|
- [ical4j/ical4j](https://github.com/ical4j/ical4j)
|
|
- [DV8FromTheWorld/JDA](https://github.com/DV8FromTheWorld/JDA)
|
|
- [Litote/kmongo](https://github.com/Litote/kmongo)
|
|
- [junodevs/kriess](https://github.com/junodevs/kriess)
|
|
- [qos-ch/logback](https://github.com/qos-ch/logback)
|
|
- [square/okhttp](https://github.com/square/okhttp)
|
|
- [ronmamo/reflections](https://github.com/ronmamo/reflections)
|
|
- [snakeyaml/snakeyaml](https://github.com/snakeyaml/snakeyaml)
|
|
|
|
## Usage
|
|
### Build it!
|
|
I use the Gradle build system, so getting all the dependencies and building the jar should be as easy as:
|
|
|
|
`./gradlew clean shadowJar`
|
|
|
|
### Run it!
|
|
On the first run of `$ java -jar build/lib/IEEEventsBot*.jar` it'll automatically copy an example config.yml for you. From there, change the values to be relevant for you. After you have it fully configured, run the bot again with `java -jar build/lib/IEEEventsBot*.jar` and invite the bot to your server!
|
|
|
|
### All together
|
|
```bash
|
|
# Build the .jar file
|
|
$ ./gradlew clean shadowJar
|
|
# Run the bot for the first time (will stop right away)
|
|
# Will place a new config.yml in your directory - replace with your values
|
|
$ java -jar build/lib/IEEEventsBot*.jar
|
|
# Actually run the bot this time
|
|
$ java -jar build/lib/IEEEventsBot*.jar
|
|
```
|
|
|
|
## Licensing
|
|
|
|
This project is licensed under the [MIT License](https://choosealicense.com/licenses/mit/)
|
|
|
|
## Authors
|
|
|
|
* [Brett Bender](https://git.brettb.xyz/apollo/) |