HoloAPI
An advanced and powerful holographic display plugin
Features
With the discovery of new hologram technology (as seen in the video below), HoloAPI is designed to bring you a seamless experience in holographic display creation through the powerful command base and API.
Providing advanced Hologram Technology for your Bukkit server, HoloAPI has the following features (and more!):
Easily manage your own holographic displays | |
Create Holographic displays with images, animations (GIFs) and multi-line text | |
Allows developers to create and manage their own holographic displays through the extensive API | |
Holographic chat bubbles (captions) that show chat messages above the speaker'a head | |
Animated text support | |
Automatic UTF-8 character formatting and replacing | |
Super smooth Animated Holograms and hologram teleportation! | |
Automatic tag replacement e.g. "Hello there %name%!" (Where name is replaced with the observer's name) | |
Holographic chat bubbles with in-built support for VanishNoPacket | |
TouchScreen Holograms with an extensive and easy to use API | |
Floating Item displays with easy to use tags - %item:id% | |
BungeeCord support for TouchScreen holograms and online count placeholders | |
Supports Bukkit from 1.6.4 through to 1.7.9 and MCPC+ 1.6.4 |
Stay up to date and make sure you have the latest version of HoloAPI!
This extensive API is designed to provide you with the easiest, most feature packed resources for creating and managing your own holograms.
HoloAPI also uses intelligent image-translation technology (thanks to @bobacadodl) to transform ordinary images into futuristic holograms that can enhance your server in ways that you have never imagined.
or
Development builds of this project can be acquired at the provided continuous integration server. These builds have not been approved by the BukkitDev staff. Use them at your own risk.
Commands and Permissions
Command | Permission | Description |
---|---|---|
/holoupdate | holoapi.update | Update HoloAPI if a new version has been found. |
/holo | holoapi.holo | Base HoloAPI command. All in-game methods for creating holographic displays can be found under this command. Entering this command by itself will provide version information for HoloAPI. |
/holo create | holoapi.holo.create | Create a holographic display. Lines can be entered one after each other. |
/holo create image <image_id> | holoapi.holo.create | Create a holographic display from an image. See the Configuration page on the Wiki for more information on how to set this up. |
/holo create animation | holoapi.holo.create | Create an animated holographic display from lines of text. |
/holo create animation <animation_id> | holoapi.holo.create | Create an animated hologram. See the Configuration Wiki page for info on how to set up GIFs. |
/holo remove <id> | holoapi.holo.remove | Remove a hologram by its assigned ID. |
/holo info | holoapi.holo.info | View all active holographic displays and their respective IDs. |
/holo move <id> | holoapi.holo.move | Move a hologram to your current position. |
/holo teleport <id> | holoapi.holo.teleport | Teleport to a specific hologram. |
/holo build | holoapi.holo.build | Dynamically build a combined hologram of both text and images. |
/holo edit <id> <line> | holoapi.holo.edit | Edit a line of an existing hologram. |
/holo edit <id> <line> <content> | holoapi.holo.edit | Edit a line of an existing hologram. The content can be more than one line. |
/holo nearby <radius> | holoapi.holo.nearby | View information on all nearby holograms within the specified radius |
/holo copy <id> | holoapi.holo.copy | Copy an existing hologram to your current position. |
/holo refresh <id> | holoapi.holo.refresh | Refresh a Hologram of the specified ID. |
/holo reload | holoapi.holo.reload | Reload all configuration files and holograms |
TouchScreen Hologram Commands
Command | Permission | Description |
---|---|---|
/holo touch add <id> <command> | holoapi.holo.touch.add | Add an action for a certain hologram to perform when touched. Actions defined without the use of the API (through this command) may only be commands. The `%name%` placeholder can be used to define the user that touched the hologram. Commands can be more than one word. |
/holo touch add <id> <command> <as_console> | holoapi.holo.touch.add | Same functionality as `/holo touch add <command>`. `<as_console>` defines whether the action is performed by the console or the player that touched the hologram |
/holo touch remove <id> <touch_id> | holoapi.holo.touch.remove | Remove an action for a TouchScreen hologram, where `<touch_id>` is the ID of the TouchAction. To remove a command-based Touch Action, simply enter the command" |
/holo touch clear <id> | holoapi.holo.touch.clear | Clear all Touch Actions for a particular TouchScreen hologram |
/holo touch info <id> | holoapi.holo.touch.info | View information on all Touch Actions for a particular TouchScreen hologram |
Configuration
Metrics
Metrics is used to collect plugin statistics. Only data such as plugin version and players online is collected. If you do not wish for this data to be collected, disable it in the 'Plugin Metrics' folder of your 'plugins' directory.
Update Checking
HoloAPI comes with an auto-updater to save you, as a server owner, from continually checking this page for new files. It simply connects to dev.bukkit.org and compares the versions of available files. If you do not wish for HoloAPI to perform this check, navigate to the Configuration File (config.yml) in the HoloAPI directory of your plugins folder and change "checkForUpdates" and "autoUpdate" to "false". The first value disables the version comparison altogether and the second updates the plugin automatically if new files are detected.
Plugins Using HoloAPI
Some of the plugins that utilise the powerful features in HoloAPI:
...And many more!
Credit to Asdjke for coming up with the idea
Is there support for 1.6.x modded servers yet? MCPC+?
My 1.7.9 server lags like hell with this plugin. Please update to support 1.7.9.
Two questions One: Would it be possible to add metadata to the %item:itemid% placeholder? Certain items in servers that use mcpc+ are fit withing metadata, and can't be displayed without it Two: Is touchscreen compatible with mcpc+, and if not will it be?
how can i set the UpdateDisplayTask ?
@DSH105
I am actually on 1.7.2 and the remove command doesn't actually remove the hologram until I reload the plugin :( That's the only issue I encounter besides the item thing.
X
-------------X HoloAPI v1.2.3 Total: 1.372 s Pct: 0.15%Pct Total Pct Tick Total Avg Count Event
0.06% 77.82% 0.584 s 38.9091 ms 0.02k Task: UpdateDisplayTask(interval 1200)
0.06% 2.95% 0.570 s 1.4731 ms 0.39k PlayerTeleportEvent X
-------------XMay i know that how to solve it ? the UpdateDisplayTask is too more
@sanjay900
I love this plugin's api. Used it and my falling blocks modifications to make... flags that wave in the wind :)
Keep getting this error on my console ERROR Could not pass event PlayerJoinEvent to HoloAPI v1.2.0. fix it plss
Please fix ASAP - Sometimes HoloAPI loads no holograms, and I'm forced to manually reload.
Really unreliable. Gotta use holographicdisplays for now.
Another question -
If I use an Item tag: %item:50%
and call Hologram.move, the item disappears.
Calling Hologram.refreshDisplay() makes the hologram appear but weirdly causes a flickering issue. Basically, I'm calling this in a sync thread on repeat, is it not possible to use Items in this case?
@DSH105
Yeah, i worked that one out yesterday..
Thanks for API!
I used this plugin with VarScript to display healthbar of towers
http://www.youtube.com/watch?v=pxt1PLNIX5Y
Can I create a hologram, which will not be saved to a file?
Now I should use HoloManager.clearFromFile(holo) after using. If I forget to remove the hologram, it will be loaded again after server restart
@sanjay
I worked that out afterwards, unfortunately if you're making these before the HoloApi has displayed "loaded holograms" it doesn't work.
I've had to wrap all of those lines in a BukkitRunnable with a 10 tick delay - It works, it's just a pain in the ass :P I don't understand why it's not naturally an option, the HologramFactory could easily replace "withSimplicity" with "withTracking" and "withSaving".
@DSH105
I stated that I still needed the tracking active, I even tried manually enabling HoloManager.track(hologram) after settting simplicity to true. It doesn't work.
@ceata Already done ;D. Use /holo move <world> <x> <y> <z> in v1.2.3
It would be pretty cool if we could move a hologram to certain coordinates with a command
@TomFromCollege
I had to do this in my plugin, if you do a HoloAPI.getManager().clearFromFile(hologram.getSaveId()); it will remove it from the file, but it will still be tracked.
Also, &s and %item:id% place holders are not working.
You can only set commands for the whole hologram, not for a line.
How would I do it If wanted something like this:
^
something here
something here
V
I want the ^ and V only, but its hard to line it up.
I made a hologram with:
To make it work, I had to copy and paste the coords for the first one, and change the Y coord.
Hi,
Not sure if this has already been asked but as of yet, I've been unable to find the answer to this:
Is it possible to prevent a hologram from being saved?
I'm building and saving holograms from my plugin and as such would like to be able to create a complex (Tracking with visibility to all) without having to save the Hologram.
Thanks.