yuri2

README

⚠️ This repository has been archived in favour of the successor yuri69.

---

~ Yuri v.2 ~

Faster, harder, louder!
The best Discord sound board in whole North Korea!

       

---

Index

• Intro
• Screen Shots
• Setup
• Compiling
• Used 3rd Party Dependencies

---

Intro

Yuri is the best Discord sound board in whole North Korea, if you believe it or not! And now, even better with v.2 with way better performance, better code structure, easier installation and a brand new web interface! Also, now, Lavalink is completely implemented as Discord voice backend. With the new, open REST and Web Socket API you are now able to create applications hooking up the Yuri back end!

Screen Shots

Discord Front End

Web Interface

---

Setup

Runtime Requirements

• Lavalink
  Lavalink is a stand-alone Discord Voice backend which is used by Yuri for playing sounds in Discord voice Channels.
  You need to download the Lavalink.jar and run it with a custom config. An example for this you can find here.
• pm2 or screen (or something else liek this)
  You will need a software to deamonize the Lavalink and Yuri instance. In this setup tutorial, I will use pm2. You can also use screen or something else you want to use.

How To

1. Download the precompiled assets or compile them yourself. Then, place the binary with the web folder in the same location somewhere you want.

2. Download, configure and run Lavalink.

3. Start the Yuri binary for the first time. Then, an example config will be created where you need to enter your preferences and credentials for the Discord API and Lavalink connection.

4. Restart the bot using the created config file.

---

Compiling

Requirements

• go compiler toolchain
• gcc compiler toolchain
  For windows you can use TDM-GCC
• dep dependency manager
• optional: GNU make
  For windows see here

1. Clone the repository to your gopath:

   $ git clone https://github.com/zekroTJA/yuri2 --depth 5 --branch master
   

2. Now you can simply use the make file which will download and install all needed dependencies and compile the binary:

   $ make
   

   Optionally, you can use the ./scripts/build.sh script to ensure dependencies and compile binaries.

3. Now, grab the binary located in ./bin and the ./web folder and follow the setup steps.

---

Used 3rd Party Dependencies

Frontend

Dependency	Licence
Bootstrap 4	MIT

Backend

Dependency	Licence
my fork of bwmarrin/discordgo	BSD-3-Clause
foxbot/gavalink	ISC
mattn/go-sqlite3	MIT
ghodss/yaml	MIT
op/go-logging	BSD-3-Clause
gorilla/websocket	BSD-2-Caluse

---

© 2019 zekro Development (Ringo Hoffmann)
zekro.de | contact[at]zekro.de