Cookieso/lilJudd
1
0
Fork 0
forked from DiscordBots/lilJudd
Code Pull requests Activity
A Splatoon bot for the chat app Discord with actually unique features.
109 commits 2 branches 12 tags 637 KiB
Kotlin 99.9%
Dockerfile 0.1%
Find a file
moonleay 2bfc327ceb fix: fixed build.yml??? 
Signed-off-by: moonleay <contact@moonleay.net>
2023-08-04 21:25:46 +02:00
.forgejo/workflows fix: fixed build.yml??? 2023-08-04 21:25:46 +02:00
gradle/wrapper fix: fixed gradle after fucking it up 2023-05-28 13:51:12 +02:00
src/main fix: fixed AvailabilityManager not being able to set the right roles 2023-07-13 00:58:43 +02:00
.dockerignore feat: added .dockerignore 2023-06-15 08:06:35 +02:00
.gitignore chore: update gitignore 2023-05-13 01:20:49 +02:00
.gitlab-ci.yml chore: formatting 2023-07-13 00:58:51 +02:00
build.gradle.kts chore: bump version 2023-07-13 01:15:24 +02:00
Dockerfile chore: added docker support 2023-05-18 20:51:06 +02:00
gradle.properties chore: updated copyright 2023-05-18 17:38:50 +02:00
gradlew chore: updated copyright 2023-05-18 17:38:50 +02:00
gradlew.bat big bang 2023-04-27 10:35:09 +02:00
LICENSE chore: update LICENSE 2023-05-20 19:28:12 +02:00
README.md chore: update README.md 2023-06-29 08:40:10 +02:00
settings.gradle.kts chore: updated copyright 2023-05-18 17:38:50 +02:00

README.md

li'l Judd version 2

"Oh boy, here we go again" ~ me

A Discord Bot for Splatoon Teams

Latest Release pipeline status License

Contributors

Developer

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)

  1. Pull the container
  2. Map /data/ to a folder on disk
  3. Run the Bot once
  4. Follow step 4 - 7 of "How to self-host (using the JAR)"

How to self-host (using the JAR)

  1. Download the latest release from the Package Registry ("Packages and registries" > "Package Registry")
    1. 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.)
    2. 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"
  2. Place it anywhere you want.
  3. Run the following command:

    java -jar lilJudd-X.X.X-xxxxxxxx-prod.jar

  4. The bot should start and create a config file named "credentials.nils" in a folder called "data"
  5. Open it and put in your credentials.
    1. token: your Discord bot token
    2. dbDomain: the domain and port of your postgresql database (e.g.: 192.168.178.1:5432)
    3. dbName: the name of your database
    4. dbUser: the username of the database
    5. dbPassword: the password to your user
  6. Rerun the command

    java -jar lilJudd-X.X.X-xxxxxxxx-prod.jar

  7. 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