2023-05-18 19:00:37 +00:00
# li'l Judd version 2
"Oh boy, here we go again" ~ me
2023-09-17 11:20:41 +00:00
A Discord Bot for Splatoon Teams.
2023-12-06 15:03:41 +00:00
More information can be found on the [Homepage ](https://liljudd.ink ).
2023-05-18 19:00:37 +00:00
## Contributors
2023-05-21 13:21:00 +00:00
[](https://gitlab.com/moonleay)
2023-05-18 19:00:37 +00:00
## Known issues
2023-12-06 15:02:32 +00:00
##### If you encounter any bugs, message me on Discord (@moonleay) or send me a mail (issues@moonleay.net). You can also open a ticket [on the support server](https://discord.gg/HTZRktfH4A).
2023-05-18 19:00:37 +00:00
## Commands & Features
- Commands
- version -- Show the versions of the bot and the most important dependencies
- feature -- Manage bot features
2023-09-17 11:20:41 +00:00
- match -- Create a new match
- updateroles -- Update the roles of all users
- sendplanner -- Send the planner message
2023-05-18 19:00:37 +00:00
- Features
- Time Planner -- Make the bot send messages and reactions into a selected channel in order to make planning easier
2023-06-28 22:05:12 +00:00
- Availability Manager -- Make the bot assign users roles every day, so it is possible to notify available people
2023-09-17 11:20:41 +00:00
- Match Planner -- Make a match, for which players can sign up and the bot will assign teams and roles to them
2023-05-18 19:00:37 +00:00
2023-06-05 10:10:25 +00:00
## (Maybe) upcoming features
2023-05-29 11:58:16 +00:00
2023-12-06 15:02:32 +00:00
##### See the [todo list](https://todo.moonleay.net/share/OmisuzgPDdsrCAXKjGrTfYzWwqNDNclOMGJWeMsi/auth?view=kanban) for more information.
2023-05-29 11:58:16 +00:00
2023-05-18 19:00:37 +00:00
## How to self-host (using the Docker container)
2023-09-17 11:17:14 +00:00
1. Pull the container from [Docker Hub ](https://hub.docker.com/repository/docker/limiteddev/liljudd/general )
2023-05-18 19:00:37 +00:00
2. Map /data/ to a folder on disk
3. Run the Bot once
2023-09-17 11:17:14 +00:00
4. follow step 4 and 5 from the JAR section
5. Run the Bot again
6. Profit.
2023-05-18 19:00:37 +00:00
## How to self-host (using the JAR)
2023-09-17 11:17:14 +00:00
1. Download the latest release from the Releases page.
2023-05-18 19:00:37 +00:00
2. Place it anywhere you want.
3. Run the following command:
2023-09-17 11:17:14 +00:00
> java -jar lilJudd.jar
2023-05-18 19:00:37 +00:00
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)
2023-09-17 11:17:14 +00:00
3. dbName: the name of the database
2023-05-18 19:00:37 +00:00
4. dbUser: the username of the database
2023-09-17 11:17:14 +00:00
5. dbPassword: the password to the db user
2023-05-18 19:00:37 +00:00
6. Rerun the command
2023-09-17 11:17:14 +00:00
> java -jar lilJudd.jar
2023-05-18 19:00:37 +00:00
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
