Kenneth: /* README */

2024-08-18T14:27:46Z

README

← Older revision		Revision as of 14:27, 18 August 2024
Line 78:		Line 78:
	- `./gradlew clean build`		- `./gradlew clean build`
	</pre>		</pre>

			== jocull edit ==

			Migration to JDA:v5.0.0-beta by jocull · Pull Request #69 · freyacodes/ukulele
			https://github.com/freyacodes/ukulele/pull/69

			<pre>
			# original configuration
			git clone https://github.com/freyacodes/ukulele.git
			cd ukulele
			git checkout master
			git pull
			cp ukulele.example.yml ukulele.yml
			# configure ukulele.yml
			mkdir db && chown -R 999 db/

			---
			# edit docker-compose.yml and change:
			# image: ghcr.io/freyacodes/ukulele:master
			image: ghcr.io/jocull/ukulele:jda-5
			---

			# routinely update jda-5 docker image:
			docker rm -f ukulele_ukulele_1
			docker pull ghcr.io/jocull/ukulele:jda-5
			docker-compose up -d

			# follow the logs to make sure it is happy:
			docker logs -f ukulele_ukulele_1
			</pre>

			== keywords ==

Kenneth at 00:23, 22 April 2021

2021-04-22T00:23:15Z

New page

== Ukulele ==

git clone https://github.com/Frederikam/ukulele.git
# cd ukulele
sudo mv ukulele /opt/
cd /opt/ukulele

cp ukulele.example.yml ukulele.yml
# edit ukulele.yml and set token to Bot Token

See applicaitons:
https://discord.com/developers/applications

Run inside screen:
screen

Run (and build with):
./ukulele

== ukulele.yml ==

config:
token: "[BOT TOKEN]"
shards: 1
prefix: ";"
database: "./database" # Database filename
game: ""

prefix is "::" by default.

== Commands ==

;p [url] # ;play

;v [%] # ;volume

;q # ;queue ;l ;list
;np # ;nowplaying

;pause
;resume
;s # ;skip
;stop

;prefix [prefix] # or 'reset'

;say [msg]

== README ==

<pre>
# Ukulele
...and his music was electric.

Ukulele is a bot made by the creator and collaborators of FredBoat. The concept is to replicate FredBoat while keeping it simple. The original stack is engineered for serving millions of servers, and is thus too complex to selfhost.

The bot is self-contained and only requires Java 11 to run.

This is currently work-in-progress.

## Features
- Basic player commands (::play, ::list, ::skip)
- Volume command
- Zero-maintenance embedded database

## Host it yourself
- Make a copy of `ukulele.example.yml` and rename it to `ukulele.yml`
- Input the bot token [(guide)](https://discordjs.guide/preparations/setting-up-a-bot-application.html)
- Run `./ukulele` to build and run the application (Windows users use the .bat files via commandline)

## Contributing
Pull requests are welcome! Look through the issues and/or create one if you have an idea.

Please read [CONTRIBUTING.md](CONTRIBUTING.md)

## Make your own changes (More info soon)
- Change code
- `./gradlew clean build`
</pre>

Discord/Ukulele - Revision history

Kenneth: /* README */

Kenneth at 00:23, 22 April 2021