-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* readme changes * readme changes
- Loading branch information
Showing
12 changed files
with
105 additions
and
56 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,76 +1,125 @@ | ||
|  | ||
| <div align="center"> | ||
|
|
||
| # | ||
|  | ||
|
|
||
|  | ||
| [](https://shields.io/) | ||
| [](https://discord.gg/ZUgYCEJUEx) | ||
|  | ||
| [](https://modrinth.com/plugin/fancyholograms/versions) | ||
| [](https://github.com/FancyMcPlugins/FancyHolograms/releases/latest) | ||
| [](https://papermc.io/software/folia) | ||
| [](https://discord.gg/ZUgYCEJUEx) | ||
| [](https://github.com/FancyMcPlugins/FancyHolograms/releases/latest) | ||
| [](https://modrinth.com/plugin/fancyholograms) | ||
|
|
||
| Simple, lightweight and fast hologram plugin using display entities.<br> | ||
| It is lightweight and fast (using [packets](https://wiki.vg/Protocol)). | ||
| [](https://modrinth.com/plugin/fancyholograms) | ||
| [](https://hangar.papermc.io/Oliver/FancyHolograms) | ||
|
|
||
| PlaceholderAPI and MiniPlaceholders is supported. | ||
| <br /> | ||
|
|
||
| **Only for minecraft server versions 1.19.4 - 1.20.6**<br> | ||
| _Using [paper](https://papermc.io/downloads) is highly recommended_ | ||
| 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. | ||
|
|
||
| ## Get the plugin | ||
|
|
||
| You can download the latest versions at the following places: | ||
|
|
||
| - https://hangar.papermc.io/Oliver/FancyHolograms | ||
| - https://modrinth.com/plugin/fancyholograms | ||
| - https://github.com/FancyMcPlugins/FancyHolograms/releases | ||
| - Build from source (``gradlew shadowJar``) | ||
|
|
||
| ## Documentation | ||
|
|
||
| You can find the official FancyHolograms documentation here: https://fancyplugins.de/docs/fancyholograms.html | ||
|
|
||
| - Getting started: https://fancyplugins.de/docs/docs/fh-getting-started.html | ||
| - Commands: https://fancyplugins.de/docs/fh-commands.html | ||
| - API: https://fancyplugins.de/docs/fh-api.html | ||
|
|
||
| If you have any questions about the plugin/api, feel free to ask in the [discord](https://discord.gg/ZUgYCEJUEx). | ||
| </div> | ||
|
|
||
| ## 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! | ||
|
|
||
| With FancyHolograms you can create fancy holograms that take advantage of the display entities. You are able to create | ||
| text, item and block holograms. | ||
| Check out **[images section](#images)** down below. | ||
|
|
||
| Properties you can modify: | ||
| <br /> | ||
|
|
||
| - scale | ||
| - billboard | ||
| - rotation (yaw & pitch) | ||
| - background color | ||
| - text shadow | ||
| - text alignment | ||
| - placeholders in the text | ||
| - and more ... | ||
| ## Installation | ||
| Paper **1.19.4** - **1.20.6** with **Java 21** (or higher) is required. Plugin should also work on **Paper** forks. | ||
|
|
||
| The holograms are directly sent to the player via packets, which makes FancyHologram very fast and flexible. | ||
| **Spigot** is **not** supported. | ||
|
|
||
| ## Example images | ||
| ### 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)** | ||
|
|
||
|  | ||
| <br /> | ||
|
|
||
|  | ||
| ## 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. | ||
|
|
||
|  | ||
| <br /> | ||
|
|
||
| ## Developer API | ||
|
|
||
| ```kotlin | ||
| // repo | ||
| maven("https://repo.fancyplugins.de/releases") | ||
|
|
||
| // dependency | ||
| implementation("de.oliver:FancyHolograms:<version>") | ||
| ``` | ||
| More information can be found in **[Documentation](https://fancyplugins.de/docs/fh-api.html)** and **[Javadocs](https://fancyplugins.de/javadocs/fancyholograms/)**. | ||
|
|
||
| ### Maven | ||
| ```xml | ||
| <repository> | ||
| <id>fancyplugins-releases</id> | ||
| <name>FancyPlugins Repository</name> | ||
| <url>https://repo.fancyplugins.de/releases</url> | ||
| </repository> | ||
| ``` | ||
| ```xml | ||
| <dependency> | ||
| <groupId>de.oliver</groupId> | ||
| <artifactId>FancyHolograms</artifactId> | ||
| <version>[VERSION]</version> | ||
| <scope>provided</version> | ||
| </dependency> | ||
| ``` | ||
|
|
||
| ### Gradle | ||
| ```groovy | ||
| repositories { | ||
| maven("https://repo.fancyplugins.de/releases") | ||
| } | ||
| dependencies { | ||
| compileOnly("de.oliver:FancyHolograms:[VERSION]") | ||
| } | ||
| ``` | ||
|
|
||
| <br /> | ||
|
|
||
| ## 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. | ||
| ``` | ||
|
|
||
| <br /> | ||
|
|
||
| ## Images | ||
| Images showcasing the plugin, sent to us by our community. | ||
|
|
||
|  | ||
| <sup>Provided by [@OliverSchlueter](https://github.com/OliverSchlueter)</sup> | ||
|
|
||
|  | ||
| <sup>Provided by [@OliverSchlueter](https://github.com/OliverSchlueter)</sup> | ||
|
|
||
|  | ||
| <sup>Provided by [@OliverSchlueter](https://github.com/OliverSchlueter)</sup> | ||
|
|
||
|  | ||
| <sup>Provided by [@OliverSchlueter](https://github.com/OliverSchlueter)</sup> | ||
|
|
||
|  | ||
| <sup>Provided by [@OliverSchlueter](https://github.com/OliverSchlueter)</sup> |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.