> For the complete documentation index, see [llms.txt](https://advion.gitbook.io/advion-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://advion.gitbook.io/advion-docs/getting-started.md).

# Getting Started

This page explains how to install IslandHologram and get the first island holograms working.

## Requirements

IslandHologram `2.0.2` currently declares:

```yaml
api-version: '1.20'
```

The plugin is compiled for Java 21.

### Required plugin

| Plugin            | Required | Purpose                             |
| ----------------- | -------- | ----------------------------------- |
| SuperiorSkyblock2 | Yes      | Provides islands and island events. |

### Optional plugins

| Plugin          | Required | Purpose                                                                                                  |
| --------------- | -------- | -------------------------------------------------------------------------------------------------------- |
| DecentHolograms | No       | Hologram backend with click command support.                                                             |
| FancyHolograms  | No       | Alternative hologram backend. Click commands are not supported by this plugin when using FancyHolograms. |
| PlaceholderAPI  | No       | Resolves PlaceholderAPI placeholders in hologram lines and enables `%islandholo_enabled%`.               |

At least one hologram provider must be installed: DecentHolograms or FancyHolograms.

## Installation

1. Stop the server.
2. Install SuperiorSkyblock2.
3. Install DecentHolograms or FancyHolograms.
4. Place `IslandHologram-2.0.2.jar` or `IslandHologram-2.0.2-obfuscated.jar` in the server `plugins` folder.
5. Start the server.
6. Edit `plugins/IslandHologram/config.yml`.
7. Restart the server or run `/isholo reload`.

Paper downloads these runtime libraries automatically from Maven Central through `plugin.yml`:

```yaml
libraries:
  - org.xerial:sqlite-jdbc:3.45.3.0
  - com.zaxxer:HikariCP:5.1.0
```

## First Setup

Use this recommended first setup flow:

1. Start the server once to generate the plugin folder and database.
2. Choose a hologram provider in `config.yml`.
3. Configure hologram lines and offset.
4. Run `/isholo migrate` if islands already existed before installing IslandHologram.
5. Visit an island as a player. The hologram appears only when a player is within `proximity.spawn-radius`.

## Provider Selection

Example:

```yaml
hologram:
  provider: AUTO
```

Allowed values:

| Value              | Behavior                                                     |
| ------------------ | ------------------------------------------------------------ |
| `AUTO`             | Uses DecentHolograms if installed, otherwise FancyHolograms. |
| `DECENT_HOLOGRAMS` | Requires DecentHolograms.                                    |
| `FANCY_HOLOGRAMS`  | Requires FancyHolograms.                                     |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://advion.gitbook.io/advion-docs/getting-started.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.