diff --git a/README.md b/README.md index c95bb5ee..bd6e0488 100644 --- a/README.md +++ b/README.md @@ -1,76 +1,125 @@ -![](fancyholograms_title.png) +
-# +![Banner](https://github.com/FancyMcPlugins/FancyHolograms/blob/main/images/banner.png?raw=true) -![Latest Version](https://img.shields.io/github/v/release/FancyMcPlugins/FancyHolograms?style=flat-square) -[![Generic badge](https://img.shields.io/badge/folia-supported-green.svg)](https://shields.io/) -[![Discord](https://img.shields.io/discord/899740810956910683?color=7289da&logo=Discord&label=Discord&style=flat-square)](https://discord.gg/ZUgYCEJUEx) -![GitHub Downloads](https://img.shields.io/github/downloads/FancyMcPlugins/FancyHolograms/total?logo=GitHub&style=flat-square) -[![Downloads](https://img.shields.io/modrinth/dt/fancyholograms?color=00AF5C&label=modrinth&style=flat&logo=modrinth)](https://modrinth.com/plugin/fancyholograms/versions) +[![GitHub Release](https://img.shields.io/github/v/release/FancyMcPlugins/FancyHolograms?logo=github&labelColor=%2324292F&color=%23454F5A)](https://github.com/FancyMcPlugins/FancyHolograms/releases/latest) +[![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) -Simple, lightweight and fast hologram plugin using display entities.
-It is lightweight and fast (using [packets](https://wiki.vg/Protocol)). +[![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) -PlaceholderAPI and MiniPlaceholders is supported. +
-**Only for minecraft server versions 1.19.4 - 1.20.6**
-_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). +
## 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: +
-- 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)** -![example1](exampleImages/example1.png) +### Download (Development Builds) +- **[Jenkins CI](https://jenkins.fancyplugins.de/job/FancyHolograms/)** +- **[FancyPlugins Website](https://fancyplugins.de/FancyHolograms/download)** -![example2](exampleImages/example2.png) +
-![example3](exampleImages/example3.png) +## 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)** -![example4](exampleImages/example4.png) +**Have more questions?** Feel free to ask them on our **[Discord](https://discord.gg/ZUgYCEJUEx)** server. -![example5](exampleImages/example5.png) +
## Developer API - -```kotlin -// repo -maven("https://repo.fancyplugins.de/releases") - -// dependency -implementation("de.oliver:FancyHolograms:") -``` \ No newline at end of file +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) diff --git a/exampleImages/example1.png b/exampleImages/example1.png deleted file mode 100644 index 88c0c2dc..00000000 Binary files a/exampleImages/example1.png and /dev/null differ diff --git a/exampleImages/example2.png b/exampleImages/example2.png deleted file mode 100644 index 824b0024..00000000 Binary files a/exampleImages/example2.png and /dev/null differ diff --git a/exampleImages/example3.png b/exampleImages/example3.png deleted file mode 100644 index 5fd71856..00000000 Binary files a/exampleImages/example3.png and /dev/null differ diff --git a/exampleImages/example4.png b/exampleImages/example4.png deleted file mode 100644 index 6d6d1604..00000000 Binary files a/exampleImages/example4.png and /dev/null differ diff --git a/exampleImages/example5.png b/exampleImages/example5.png deleted file mode 100644 index 963f5950..00000000 Binary files a/exampleImages/example5.png and /dev/null differ diff --git a/fancyholograms_title.png b/images/banner.png similarity index 100% rename from fancyholograms_title.png rename to images/banner.png diff --git a/images/screenshots/example1.jpeg b/images/screenshots/example1.jpeg new file mode 100644 index 00000000..97cc97d3 Binary files /dev/null and b/images/screenshots/example1.jpeg differ diff --git a/images/screenshots/example2.jpeg b/images/screenshots/example2.jpeg new file mode 100644 index 00000000..7dd724e4 Binary files /dev/null and b/images/screenshots/example2.jpeg differ diff --git a/images/screenshots/example3.jpeg b/images/screenshots/example3.jpeg new file mode 100644 index 00000000..db23574a Binary files /dev/null and b/images/screenshots/example3.jpeg differ diff --git a/images/screenshots/example4.jpeg b/images/screenshots/example4.jpeg new file mode 100644 index 00000000..6f647d41 Binary files /dev/null and b/images/screenshots/example4.jpeg differ diff --git a/images/screenshots/example5.jpeg b/images/screenshots/example5.jpeg new file mode 100644 index 00000000..cce15620 Binary files /dev/null and b/images/screenshots/example5.jpeg differ