Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master'
Browse files Browse the repository at this point in the history
  • Loading branch information
max1mde committed Dec 22, 2024
2 parents 86a2b6e + 6d7ce38 commit 31e11dc
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
<div align="center">
<a href="https://discord.gg/2UTkYj26B4" target="_blank"><img src="https://img.shields.io/badge/Discord_Server-7289DA?style=flat&logo=discord&logoColor=white" alt="Join Discord Server" style="border-radius: 15px; height: 20px;"></a>
<a href="https://github.com/max1mde/ExampleHologramPlugin"><img src="https://img.shields.io/badge/Example%20plugin-13B8E1" alt="Version"></a>
<a href="https://jitpack.io/#max1mde/HologramAPI"><img src="https://jitpack.io/v/max1mde/HologramAPI.svg" alt="jitpack"></a>
<img width="800px" src="https://github.com/max1mde/HologramAPI/assets/114857048/d442ef02-aa87-41ed-bfc2-e2e61d6faffd">
<a href="https://jitpack.io/#max1mde/HologramLib"><img src="https://jitpack.io/v/max1mde/HologramLib.svg" alt="jitpack"></a>
<a href="https://github.com/max1mde/HologramLib/releases"><img src="https://img.shields.io/github/downloads/max1mde/HologramLib/total.svg" alt="Downloads"></a>
<img width="800px" src="https://github.com/max1mde/HologramLib/assets/114857048/d442ef02-aa87-41ed-bfc2-e2e61d6faffd">
</div>

Leave a :star: if you like this API :octocat:
Expand All @@ -21,8 +22,8 @@ Leave a :star: if you like this API :octocat:
# Installation

- Download packet events https://www.spigotmc.org/resources/80279/
- Download HologramAPI-[version]**.jar** file from the [latest release](https://github.com/max1mde/HologramAPI/releases)
- Upload the HologramAPI-[version]**.jar** and packet events file on your server (_yourserver/**plugins**_ folder)
- Download HologramLib-[version]**.jar** file from the [latest release](https://github.com/max1mde/HologramLib/releases)
- Upload the HologramLib-[version]**.jar** and packet events file on your server (_yourserver/**plugins**_ folder)
- Add the plugin as a dependency to your plugin and use it

**Gradle installation**
Expand All @@ -32,7 +33,7 @@ repositories {
}
dependencies {
compileOnly 'com.github.max1mde:HologramAPI:1.4.7'
compileOnly 'com.github.max1mde:HologramLib:1.4.8'
}
```
**Maven installation**
Expand All @@ -44,16 +45,16 @@ dependencies {

<dependency>
<groupId>com.github.max1mde</groupId>
<artifactId>HologramAPI</artifactId>
<version>1.4.7</version>
<artifactId>HologramLib</artifactId>
<version>1.4.8</version>
<scope>provided</scope>
</dependency>
```
Add this to your plugin
`plugin.yml`
```yml
depend:
- HologramAPI
- HologramLib
```
# Example/Showcase Plugin
Expand All @@ -67,7 +68,7 @@ private HologramManager hologramManager;

@Override
public void onEnable() {
hologramManager = HologramAPI.getManager().orElse(null);
hologramManager = HologramLib.getManager().orElse(null);
if (hologramManager == null) {
getLogger().severe("Failed to initialize HologramLib manager.");
return;
Expand All @@ -76,7 +77,7 @@ public void onEnable() {
```

> [!IMPORTANT]
> If you are shading the library use `HologramAPI.getManager(<Your plugin instance>)` instead!
> If you are shading the library use `HologramLib.getManager(<Your plugin instance>)` instead!
### Hologram Rendering Modes
```java
Expand Down

0 comments on commit 31e11dc

Please sign in to comment.