Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/puharesource/titlemanager

Adds hovering titles, actionbar titles, tabmenu titles and a scoreboard sidebar to your Minecraft 1.8 - 1.18 server.
https://github.com/puharesource/titlemanager

bukkit kotlin spigot

Last synced: 5 days ago
JSON representation

Adds hovering titles, actionbar titles, tabmenu titles and a scoreboard sidebar to your Minecraft 1.8 - 1.18 server.

Awesome Lists containing this project

README

        


TitleManager



Version


Actions Status


Javadoc


Minecraft versions


Players currently experiencing TitleManager


Servers currenty running TitleManager

A Bukkit plugin for sending titles and setting the header and footer of the player list. Spigot Project Page

---

* **[WIKI & GUIDES](https://tmdocs.tarkan.dev)** – plugin guidelines.
* **[COMMANDS](https://tmdocs.tarkan.dev/admins/commands)** – command guidelines.
* **[PERMISSIONS](https://tmdocs.tarkan.dev/admins/permissions)** – command and feature permissions.
* **[SUPPORT CHAT](https://discord.gg/U3Yyu6G)** - discord support chat and help.

For Developers
--------------

#### The Repository
Example for Gradle .kts:
```kotlin
maven("https://repo.tarkan.dev")
```

Example for Gradle:
```groovy
maven {
url 'https://repo.tarkan.dev'
}
```

Example for Maven:
```xml

tarkan-repo
https://repo.tarkan.dev

```

#### The dependency
Example for Gradle .kts:
```kotlin
implementation('io.puharesource.mc:TitleManager:2.3.1')
```

Example for Gradle:
```groovy
compile group: 'io.puharesource.mc', name: 'TitleManager', version: '2.3.1'
```

Example for Maven
```xml

io.puharesource.mc
TitleManager
2.3.1

```

### plugin.yml
If your plugin can't run without TitleManager add the following line to your plugin.yml file.
```yaml
depend: [TitleManager]
```

If your plugin can run without TitleManager, then add the following line to your plugin.yml file instead
```yaml
softdepend: [TitleManager]
```

### Getting the API instance
Once you want to use TitleManager's API, you'll need an instance of `TitleManagerAPI`, which carries all of the methods available for TitleManager. I suggest getting the instance once you load your plugin and store it somewhere easily accessible, for this example I'll however just be storing it locally in the `onEnable` method.

##### Java
```java
@Override
public void onEnable() {
TitleManagerAPI api = (TitleManagerAPI) Bukkit.getServer().getPluginManager().getPlugin("TitleManager");
}
```

##### Kotlin
For kotlin I suggest using the `lazy` delegate for storing the instance of TitleManager when accessed.
```kotlin
val titleManagerAPI : TitleManagerAPI by lazy { Bukkit.getServer().pluginManager.getPlugin("TitleManager") }
```