🏷️ IO's & Categories
Notify IO's🔗
A NotifyIO is a method of displaying a notification to the player. Here's a demo video showing an example configuration of all NotifyIO's.
Most NotifyIO's have unique settings that somehow change how a notification is displayed.
Additionally, they all allow each setting of the SoundIO to be used!
This is the case because every NotifyIO has an internal SoundIO.
Therefore, you can play a sound whenever a notification is shown.
The actual message is either defined in the event that triggers the NotifyIO or in the messages.yml for all built-in notifications.
Check the notification event documentation on how to use the notify event!
Chat🔗
Writes the notification in the players chat.
Preview
| Option | Description |
|---|---|
| SoundIO | Any option from the SoundIO. |
Advancement🔗
Shows the notification using an achievement popup. Unfortunately Minecraft does play the default advancement sound here. It's not possible to stop this sound from playing - if you want to get rid of it you would have to override / remove that sound from your server's ressource pack. You can still add your own additional sound as usual though. It will then be played together with the default advancement sound.
Preview
| Option | Description |
|---|---|
| frame | What Achievement frame to use. Can be: challenge, goal, task |
| icon | What icon to show. Must be the vanilla name of an item. Example: minecraft:map |
| SoundIO | Any option from the SoundIO. |
Actionbar🔗
Shows the notification using the actionbar.
Preview
| Option | Description |
|---|---|
| SoundIO | Any option from the SoundIO. |
Bossbar🔗
Shows the notification using a bossbar at the top of the players screen.
Preview
| Option | Description |
|---|---|
| barFlags | What flags to add to the bossbar. PLAY_BOSS_MUSIC seems to be broken in either Spigot or the game itself. |
| barColor | What color to draw the bar. |
| progress | What progress to show the bar. A floating point number between 0.0 (empty) and 1.0 (full) |
| style | What bar style to use. |
| stay | How many ticks to keep the bar on screen. Defaults to 70 |
| countdown | If set, will step the progress of the bar by countdown steps. For example, if set to 10, then 10 times during the time it is on the screen the progress will drop by 1/10 |
| SoundIO | Any option from the SoundIO. |
Title🔗
Shows the notification using a title.
A subtitle can be played simultaneously by adding \n to the notification text.
Anything after these characters will be shown in the subtitle.
Preview
| Option | Description |
|---|---|
| fadeIn | Ticks to fade the title in. Default 10 |
| stay | Ticks to keep title on screen. Default 70 |
| fadeOut | Ticks to fade the title out. Default 20 |
| SoundIO | Any option from the SoundIO. |
SubTitle🔗
Shows the notification using a subtitle.
Preview
| Option | Description |
|---|---|
| fadeIn | Ticks to fade the title in. Default 10 |
| stay | Ticks to keep title on screen. Default 70 |
| fadeOut | Ticks to fade the title out. Default 20 |
| SoundIO | Any option from the SoundIO. |
Sound🔗
This IO just plays a sound. You can use it's options in any other IO. You should read the wiki page of the playsound command as Minecraft's sound system is kinda strange. Just one example: Sound never moves in Minecraft. It's totally static. Keep that in mind when creating sounds close to a player. They can move around the sound and make it louder or quieter by walking towards / away from it.
| Option | Description |
|---|---|
| sound | Sound to play. If blank, no sound. Either vanilla Minecraft sounds (get them using /playsound autocompletion) or the name of a sound from a resource pack. |
| soundcategory | The category in which the sound will be played. |
| soundvolume | Minecraft's special sound volume. Default: 1 |
| soundpitch | Pitch of the sound. Default: 1 Min: 0 Max: 2 |
| soundlocation | Default: The player's location. A location using the BetonQuest ULF. Can include variables. |
| soundplayeroffset | This option is special. See below. |
soundplayeroffset:
This option can be a number or a vector.
Number:
The location the sound will be played at is moved away from the player towards the soundlocation using the value of
soundplayeroffset.
The sound will be at the actual location if the player is closer to the soundlocation
then the soundplayeroffset would allow.
Visual Explanation
This shows how the sound will be played at the soundlocation if the soundplayeroffset is bigger then the current
distance between the player and the soundlocation
Example usage:
You could make a "sound compass" that will play a sound in the direction of a point of interest.
Vector:
A vector has to be in the format(x;y;z). This system will use the players relative coordinate system.
This means that the vectors x axis is right / left from the players head, the y axis is up or down from where ever the players face is
and the z axis is before / behind the players face. It will move along the players head.
Visual Explanation
In contrast to their global counterparts, relative x,y,z axes do not change their orientation relative to the player. Example: The positive x-axis will always point left from the perspective of the player.
This makes it possible to go crazy with sounds. Just one example: A halloween special
where the player hears a 
whispering into his left ear - no matter where he is or how he turns his head... 🎃
Here is a small example:
Video Example
blue line = direction the player is looking in
🟢 = soundlocation argument
🔴 = the actual location the sound is played at
soundplayeroffset = (0,0,5)
Suppress🔗
Does not output any sound or text 🔕. Can be used to remove built-in notifications.
Categories🔗
Notify Categories are pre-defined NotifyIO settings. They can be applied to any notify event and are used
by BetonQuests built-in notifications.
All categories must be defined in the custom.yml file in a section called notifications.
Warning
A note about the custom.yml: This is a strange file. BetonQuest searches through all packages and just uses the first one it finds. Therefore, you should probably create just one custom.yml with all your settings. We will improve this in BQ 2.0.
Custom Categories🔗
Custom categories are user defined presets for any notify event. They shorten your events and enable you to change how a notification of a certain category looks in one central place. They do not allow you to set a message though as the message is an argument of the notify event!
This is how a custom category looks:
notifications:
money: # Category name
io: advancement # Set's the used NotifyIO
icon: gold_ingot # A setting of the bossbarIO
The only thing you must be careful with is the name of your custom categories. You could end up using a reserved name - these stem from BetonQuest's build-in notification categories. Changing these is a different feature. A full list of all reserved names can be found below.
Built-in Categories🔗
The table below contains all build-in notification categories.
You may notice that the "Categories" column lists two categories.
These work exactly like the one in the notify event. The first existent category (from left to right) will be used.
This allows you to change all build-in notifications with just two entries in your custom.yml:
notifications:
info:
io: actionbar
error:
io: actionbar
notifications section. Example:
notifications:
info:
io: actionbar
error:
io: actionbar
new_journal_entry: # The info categories settings are overridden for the new_journal_entry notification
io: subtitle
| Notifications | Categories | Notifications | Categories | |
|---|---|---|---|---|
| Command Blocked | command_blocked, error | Animals to Breed | animals_to_breed, info | |
| No Permission | no_permission, error | Blocks to Break | blocks_to_break, info | |
| New Changelog | changelog, info | Blocks to Place | blocks_to_place, info | |
| Inventory Full | inventory_full, error | Mobs to click | mobs_to_click, info | |
| Language Changed | language_changed, info | Fish to catch | fish_to_catch, info | |
| Mobs to Kill | mobs_to_kill, info | Players to kill | players_to_kill, info | |
| Money Given | money_given, info | Potions to brew | potions_to_brew, info | |
| Money Taken | money_taken, info | Points given | point_given, info | |
| Quest Cancelled | quest_cancelled, info | Points taken | point_taken, info | |
| Items Given | items_given, info | Points multiplied | point_multiplied, info | |
| New Journal Entry | new_journal_entry, info | Sheep to shear | sheep_to_shear, info | |
| Conversation blocked | busy, error |