Cookieso/lilJudd
1
0
Fork 0
forked from DiscordBots/lilJudd
Code Pull requests Activity

chore: update README.md

Browse source 
Signed-off-by: moonleay <contact@moonleay.net>
This commit is contained in:
moonleay 2023-09-17 13:17:14 +02:00
parent 344751b9de
commit ea505a1395
Signed by: moonleay
GPG key ID: 82667543CCD715FB
1 changed files with 10 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -4,10 +4,6 @@
A Discord Bot for Splatoon Teams A Discord Bot for Splatoon Teams
[![Latest Release](https://gitlab.com/moonleay/liljudd/-/badges/release.svg)](https://gitlab.com/moonleay/liljudd/-/releases)
[![pipeline status](https://gitlab.com/moonleay/liljudd/badges/master/pipeline.svg)](https://gitlab.com/moonleay/liljudd/-/commits/master)
[![License](https://img.shields.io/badge/license-GPL--3.0-brightgreen)](https://gitlab.com/moonleay/liljudd/-/blob/master/LICENSE)
## Contributors ## Contributors
[![Developer](https://img.shields.io/badge/moonleay-Developer-red)](https://gitlab.com/moonleay) [![Developer](https://img.shields.io/badge/moonleay-Developer-red)](https://gitlab.com/moonleay)
@ -33,36 +29,31 @@ A Discord Bot for Splatoon Teams
- Rndm map command - Rndm map command
- Maybe a DSB / DSL API - 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) ## How to self-host (using the Docker container)
1. Pull the container 1. Pull the container from [Docker Hub](https://hub.docker.com/repository/docker/limiteddev/liljudd/general)
2. Map /data/ to a folder on disk 2. Map /data/ to a folder on disk
3. Run the Bot once 3. Run the Bot once
4. Follow step 4 - 7 of "How to self-host (using the JAR)" 4. follow step 4 and 5 from the JAR section
5. Run the Bot again
6. Profit.
7.
## 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. Download the latest release from the Releases page.
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. 2. Place it anywhere you want.
3. Run the following command: 3. Run the following command:
> java -jar lilJudd-X.X.X-xxxxxxxx-prod.jar > java -jar lilJudd.jar
4. The bot should start and create a config file named "credentials.nils" in a folder called "data" 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. 5. Open it and put in your credentials.
1. token: your Discord bot token 1. token: your Discord bot token
2. dbDomain: the domain and port of your postgresql database (e.g.: 192.168.178.1:5432) 2. dbDomain: the domain and port of your postgresql database (e.g.: 192.168.178.1:5432)
3. dbName: the name of your database 3. dbName: the name of the database
4. dbUser: the username of the database 4. dbUser: the username of the database
5. dbPassword: the password to your user 5. dbPassword: the password to the db user
6. Rerun the command 6. Rerun the command
> java -jar lilJudd-X.X.X-xxxxxxxx-prod.jar > java -jar lilJudd.jar
7. The bot should now be up and running. 7. The bot should now be up and running.
## How to set up workspace ## How to set up workspace