Tutorial
HoloAPI v1.1.0 and onwards are compatible with both 1.6.x and 1.7.x. Versions before 1.1.0 are only compatible with 1.7.x, however.
After downloading the desired release of HoloAPI, drop the .JAR File into the plugins folder of your server directory and restart the server to ensure the plugin is enabled. A variety of files will generate in the ~/plugins/HoloAPI directory:
-
config.yml- General HoloAPI configuration file -
data.yml- Data storage for holograms -
language.yml- Configuration for all HoloAPI messages -
animations- Stores hologram animation sources (must be placed by the user) -
images- Stores hologram image sources (must be placed by the user)
See the Configuration page of the Wiki for information on these files.
HoloAPI greatly utilises Bukkit's Conversation API to gain information for command input. For most of the HoloAPI commands, extra input will be required after the command is executed.
This tutorial will cover the creation of holograms in the following forms:
Also see the video showcases and tutorials page for information on setting up holograms..
Colour codes may be used in the creation of holograms.
See this page for more information on tags and placeholders
Text holograms can be created using the /holo create command, which will begin the hologram builder. Text lines of the new hologram can be entered in sequentially, with the DONE keyword terminating the builder.
For example, entering the following lines into chat will create the following hologram.
/holo create
&6Hey there &l%name%
&6This is a hologram!
Done
For information on setting up images for use in holograms, see the Configuration page of the Wiki
Once you have successfully configured your image, using the /holo create image <image_id> will create a hologram based on that setup. In the example, an image under the ID of apple has been created.
/holo create image apple
Holograms can also be built upon a combination of image and text using HoloAPI.
The example hologram below uses the above apple image.
/holo build
text
&e&lAPPLES
image
apple
done
As well as images and static text, GIFs can also be used to generate moving holograms. In the following example, an animation called explosion was used to create the hologram.
/holo create animation explosion
Animated text can also be added into holograms using the /holo create animation command. Lines of a particular frame can be entered sequentially, with the NEXT keyword moving to the next frame.
For example:
/holo create animation
&6&lHolo&c&lAPI
Next
&4&lHolo&e&lAPI
done
NOTE: Using the EXIT keyword in ANY HoloAPI builder will cancel the creation of the hologram and reactivate normal chat.
Holograms with floating items can be creating by simply adding an item ID tag to any line of a hologram. Item ID tags are in the following format: %item:id%, where id is an integer
For example, if the tag %item:276% was used in the second line of the following hologram, it would look like this:
Holograms can be removed simply by entering in /holo remove. Entering YES to the resulting prompt will clear the hologram from file, whereas NO will only disable the hologram temporarily.
As well as the ability to create and remove holographic displays, HoloAPI provides users with the commands required to move the position of and teleport to existing holograms, using
/holo move <hologram_id>/holo teleport <hologram_id>
The teleport command can also be auto-suggested by clicking on an entry in the Hologram Info list, accessible via the /holo info command
Holograms can be edited using the /holo edit <hologram_id> <line_number> command. Again, HoloAPI will prompt for the new line information via the chat window.
