forked from DiscordBots/lilJudd
A Splatoon bot for the chat app Discord with actually unique features.
moonleay
24687d4060
chore: updated UpdateRolesExtension Documentation Signed-off-by: moonleay <contact@moonleay.net> |
||
---|---|---|
.forgejo/workflows | ||
gradle/wrapper | ||
src/main | ||
.dockerignore | ||
.gitignore | ||
.gitlab-ci.yml | ||
build.gradle.kts | ||
Dockerfile | ||
gradle.properties | ||
gradlew | ||
gradlew.bat | ||
LICENSE | ||
README.md | ||
settings.gradle.kts |
li'l Judd version 2
"Oh boy, here we go again" ~ me
A Discord Bot for Splatoon Teams
Contributors
Known issues
If you encounter any bugs, message me on Discord (@moonleay) or send me a mail (issues@moonleay.net).
Commands & Features
- Commands
- version -- Show the versions of the bot and the most important dependencies
- feature -- Manage bot features
- Features
- Time Planner -- Make the bot send messages and reactions into a selected channel in order to make planning easier
- Availability Manager -- Make the bot assign users roles every day, so it is possible to notify available people
(Maybe) upcoming features
- Match Planner (Send Notifications some time before a match starts)
- Game Tracker (Save the results of the last matches)
- Replay Saver (Maybe; will save the replay code to a database)
- Rndm map command
- Maybe a DSB / DSL API
TODO
- Rewrite the Database connection system (from transactions all over the place to a single package with transactions)
How to self-host (using the Docker container)
- Pull the container
- Map /data/ to a folder on disk
- Run the Bot once
- Follow step 4 - 7 of "How to self-host (using the JAR)"
How to self-host (using the JAR)
- Download the latest release from the Package Registry ("Packages and registries" > "Package Registry")
- It should be called something like this: "lilJudd-X.X.X-xxxxxxxx-prod.jar" (replace "X.X.X" with the latest version and xxxxxxxx" with the commit its based on.)
- If you want to run an early version, which may be (very) unsable, you can run a development version. Just use an entry ending in "-dev.jar"
- Place it anywhere you want.
- Run the following command:
java -jar lilJudd-X.X.X-xxxxxxxx-prod.jar
- The bot should start and create a config file named "credentials.nils" in a folder called "data"
- Open it and put in your credentials.
- token: your Discord bot token
- dbDomain: the domain and port of your postgresql database (e.g.: 192.168.178.1:5432)
- dbName: the name of your database
- dbUser: the username of the database
- dbPassword: the password to your user
- Rerun the command
java -jar lilJudd-X.X.X-xxxxxxxx-prod.jar
- The bot should now be up and running.
How to set up workspace
Install IntellJ and import the project from git. Done.
Docker commands 4 me
- docker build -t limiteddev/liljudd:x.x.x .
- docker push limiteddev/liljudd:x.x.x