diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..7e7a4bf --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 Brett Bender + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..fc82e7a --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +
Made with :heart: by @GreatGodApollo
+ +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/) \ No newline at end of file