BukRadio 1.2.1

Contributors:

@Unknowncmbk

Introduction to BukRadio
BukRadio is a Minecraft Utility extension that abstracts the Minecraft Inventory GUI in order to mimic a radio. Players can listen in to a specific radio station which will rotate songs based on their genre.

Purpose
BukRadio is a Java based utility extension to Minecraft that allows server
owners to construct genre based radio stations for their players enjoyment.
These users will find enjoyment in doing regular grinding tasks that typically
are monotonous and boring.

The following are example usages of BukRadio:
- Allow users to freely get a radio via in-game commands.
- Give VIP/premium access to the users that can get a radio.

Requirements
BukRadio uses a library source called NoteBlockAPI.
- This library is absolutely needed in order to display the BukRadio to the player.
- BukRadio uses .nbs files to play to the user. A list of .nbs files can be
downloaded here.

Snapshots

Spoiler

Below is the BukRadio item that a player holds in their inventory as well as
the GUI that is displayed to the player.


Server owners can create stations for users to listen to. Each new station is
a new disk item in the GUI.


If a player decides to stop listening to music after joining a station, they
can mute the BukRadio by clicking the lever in the GUI.

Commands

Spoiler

BukRadio comes with a set of commands, only available to players that have op
or the permission node:
```
- bukradio.br
```

Users can access the help screen by typing:
```
/br help
or
/br
```
The following will be displayed:


An extended description is provided below:
```
- /br version
Displays the version of this plugin.

- /br give <PLAYER>
Give PLAYER a BukRadio object.

- /br get
Give yourself a BukRadio object.

- /br reload
Reloads the config.yml into the Puzzle Crates plugin.

```

Configuration

Spoiler

When BukRadio is loaded for the first time, two config.ymls are created.
```
config.yml
and
example-config.yml
```
The config.yml is the actual configuration file that is read from the plugin,
whereas the example-config.yml provides comments for how to edit the config.yml
and what values stand for what.

Below is the example-config.yml with extended comments:
```
# ---------------------------
# Example BukRadio Configuration
# ---------------------------
#
# ---------------------------
# Product by Hyphenical Technologies
# ---------------------------
#
# - Note about editing -
# Make sure to check the YAML syntax against a YAML parser.
# Ex: http://yaml-online-parser.appspot.com/
#
# Also make sure your product key below is edited to
# the one from the Hyphenical website.
# Website: http://hyphenical.net
#
# ---------------------------
# - Example configuration -
# ----- DO NOT EDIT -----
# ---------------------------
#
#
# # Version of this config, do not edit this.
# config-version: 1
# global-settings:
# # the file that exists in this folder
# # that contains the .nbs songs
# songs-directory: songs
# # give players radio when they join
# radio-on-join: true
#
#
# ---------------------------
# End of Example Configuration
# ---------------------------
```

Disclaimer
BukRadio is a product of Hyphenical Technologies. Please do not redistribute, or reproduce.

Suggestions, feedback, and other things are greatly appreciated. We also can see these better in email!