Virtual Visuals

This module provides utilities for displaying things to players, which includes bossbars, sidebars, tab displays, cameras, countdowns, and more.

All of these are 'virtual', meaning that they only exist as packets sent to the players that are shown them. A VirtualBossbar is not a boss event that the server knows about, and a VirtualSidebar is not a scoreboard objective. Nothing you display here affects the server's state, and because of this, two players can be shown completely different things at the same time.

Adding to Dependencies

The virtual visuals module depends on some other arcade modules; it's recommended that you include all of these.

repositories {
    maven("https://maven.casualchampionships.net/snapshots")
}

dependencies {
    include(implementation("net.casualchampionships:arcade-virtual-visuals:0.13.0-beta.1+26.2")!!)

    include(implementation("net.casualchampionships:arcade-commands:0.13.0-beta.1+26.2")!!)
    include(implementation("net.casualchampionships:arcade-event-registry:0.13.0-beta.1+26.2")!!)
    include(implementation("net.casualchampionships:arcade-events-server:0.13.0-beta.1+26.2")!!)
    include(implementation("net.casualchampionships:arcade-extensions:0.13.0-beta.1+26.2")!!)
    include(implementation("net.casualchampionships:arcade-nametags:0.13.0-beta.1+26.2")!!)
    include(implementation("net.casualchampionships:arcade-resource-pack:0.13.0-beta.1+26.2")!!)
    include(implementation("net.casualchampionships:arcade-scheduler:0.13.0-beta.1+26.2")!!)
    include(implementation("net.casualchampionships:arcade-utils:0.13.0-beta.1+26.2")!!)
    include(implementation("net.casualchampionships:arcade-virtual-entities:0.13.0-beta.1+26.2")!!)
}

Where To Start

Every visual in this module is built out of the same two concepts, and it's worth reading about them first. The Values Section covers how a visual holds what it displays, and how one player can be shown something different to everyone else. The Observing Section then covers how we display a visual to a player, and how it gets updated.

Once we know those, the individual visuals; bossbars, sidebars, and tab displays, are all the same ideas applied to different parts of the screen. The Elements Section covers generating what's displayed automatically, instead of setting it ourselves.