![Banner](../../docs/src/static/logos-and-banners/fancyholograms-banner.png) [![Supports Folia](https://img.shields.io/badge/folia-supported-%23F9D879?labelColor=%2313154E&color=%234A44A6)](https://papermc.io/software/folia) [![Discord](https://img.shields.io/discord/899740810956910683?cacheSeconds=3600&logo=discord&logoColor=white&label=%20&labelColor=%235865F2&color=%23707BF4)](https://discord.gg/ZUgYCEJUEx) [![GitHub Downloads](https://img.shields.io/github/downloads/FancyMcPlugins/FancyHolograms/total?logo=github&labelColor=%2324292F&color=%23454F5A)](https://github.com/FancyMcPlugins/FancyHolograms/releases/latest) [![Modrinth Downloads](https://img.shields.io/modrinth/dt/fancyholograms?logo=modrinth&logoColor=white&label=downloads&labelColor=%23139549&color=%2318c25f)](https://modrinth.com/plugin/fancyholograms) [![Modrinth](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/available/modrinth_vector.svg)](https://modrinth.com/plugin/fancyholograms) [![Hangar](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/available/hangar_vector.svg)](https://hangar.papermc.io/Oliver/FancyHolograms)
Simple, lightweight and feature-rich hologram plugin for **[Paper](https://papermc.io/software/paper)** ( and [Folia](https://papermc.io/software/folia)) servers using [display entities](https://minecraft.wiki/w/Display) and packets.
## Features With this plugin you can create holograms with customizable properties like: - **Hologram Type** (text, item or block) - **Position**, **Rotation** and **Scale** - **Text Alignment**, **Background Color** and **Shadow**. - **Billboard** (fixed, center, horizontal, vertical) - **MiniMessage** formatting. - Placeholders support through [PlaceholderAPI](https://github.com/PlaceholderAPI/PlaceholderAPI) and [MiniPlaceholders](https://github.com/MiniPlaceholders/MiniPlaceholders) integration. - [FancyNpcs](ttps://github.com/FancyMcPlugins/FancyNpcs) integration. - ...and much more! Check out **[images section](#images)** down below.
## Installation Paper **1.19.4** - **1.21.5** with **Java 21** (or higher) is required. Plugin should also work on **Paper** forks. **Spigot** is **not** supported. ### Download (Stable) - **[Hangar](https://hangar.papermc.io/Oliver/FancyHolograms)** - **[Modrinth](https://modrinth.com/plugin/fancyholograms)** - **[GitHub Releases](https://github.com/FancyMcPlugins/FancyHolograms/releases)** ### Download (Development Builds) - **[Jenkins CI](https://jenkins.fancyplugins.de/job/FancyHolograms/)** - **[FancyPlugins Website](https://fancyplugins.de/FancyHolograms/download)**
## Documentation Official documentation is hosted **[here](https://fancyplugins.de/docs/fancyholograms.html)**. Quick reference: - **[Getting Started](https://fancyplugins.de/docs/fh-getting-started.html)** - **[Command Reference](https://fancyplugins.de/docs/fh-commands.html)** - **[Using API](https://fancyplugins.de/docs/fh-api.html)** **Have more questions?** Feel free to ask them on our **[Discord](https://discord.gg/ZUgYCEJUEx)** server.
## Developer API More information can be found in **[Documentation](https://fancyplugins.de/docs/fh-api.html)** and [Javadocs](https://fancyplugins.de/javadocs/fancyholograms/). ### Maven ```xml fancyplugins-releases FancyPlugins Repository https://repo.fancyplugins.de/releases ``` ```xml de.oliver FancyHolograms [VERSION] provided ``` ### Gradle ```groovy repositories { maven("https://repo.fancyplugins.de/releases") } dependencies { compileOnly("de.oliver:FancyHolograms:[VERSION]") } ```
## Building Follow these steps to build the plugin locally: ```shell # Cloning repository. $ git clone https://github.com/FancyMcPlugins/FancyHolograms.git # Entering cloned repository. $ cd FancyHolograms # Compiling and building artifacts. $ gradlew shadowJar # Once successfully built, plugin .jar can be found in /build/libs directory. ```
## Images Images showcasing the plugin, sent to us by our community. ![Screenshot 1](https://github.com/FancyMcPlugins/FancyHolograms/blob/main/images/screenshots/example1.jpeg?raw=true) Provided by [@OliverSchlueter](https://github.com/OliverSchlueter) ![Screenshot 2](https://github.com/FancyMcPlugins/FancyHolograms/blob/main/images/screenshots/example2.jpeg?raw=true) Provided by [@OliverSchlueter](https://github.com/OliverSchlueter) ![Screenshot 3](https://github.com/FancyMcPlugins/FancyHolograms/blob/main/images/screenshots/example3.jpeg?raw=true) Provided by [@OliverSchlueter](https://github.com/OliverSchlueter) ![Screenshot 4](https://github.com/FancyMcPlugins/FancyHolograms/blob/main/images/screenshots/example4.jpeg?raw=true) Provided by [@OliverSchlueter](https://github.com/OliverSchlueter) ![Screenshot 5](https://github.com/FancyMcPlugins/FancyHolograms/blob/main/images/screenshots/example5.jpeg?raw=true) Provided by [@OliverSchlueter](https://github.com/OliverSchlueter)