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

# installation

## Required Plugin

StarGenerator requires StarLibs.

Put both jars in the server `plugins` folder:

```
plugins/StarLibs.jar
plugins/StarGenerator-1.1.0.jar
```

Start the server once so StarGenerator can generate its default folders and files.

## Optional Plugins

StarGenerator can integrate with these plugins when they are installed:

| Plugin         | Purpose                                                                 |
| -------------- | ----------------------------------------------------------------------- |
| PlaceholderAPI | External placeholder parsing and the `%sg_...%` expansion.              |
| MythicMobs     | MythicMobs table entities and interaction support.                      |
| ModelEngine    | ModelEngine table entities and animations.                              |
| ItemsAdder     | Starter item/resource provider.                                         |
| Nexo           | Starter item/resource provider.                                         |
| Oraxen         | Starter item/resource provider.                                         |
| MMOItems       | Optional item ecosystem compatibility through StarLibs item resolution. |

ItemsAdder, Nexo, and Oraxen are alternatives for the starter item pack. Install the one your server uses.

## First Run Behavior

On startup, StarGenerator copies bundled default files only when the target file does not already exist. Existing user files are not overwritten.

The base StarGenerator files are generated under:

```
plugins/StarGenerator/
```

If supported optional plugins are installed, StarGenerator also installs matching starter resources:

| Provider   | Generated target                                                                           |
| ---------- | ------------------------------------------------------------------------------------------ |
| ItemsAdder | `plugins/ItemsAdder/contents/starter_icecream/`                                            |
| Nexo       | `plugins/Nexo/items/starter_icecream.yml` and `plugins/Nexo/pack/assets/starter_icecream/` |
| Oraxen     | `plugins/Oraxen/items/starter_icecream.yml` and `plugins/Oraxen/pack/`                     |

When starter provider resources are installed for the first time, reload or restart the item provider if its commands require it. For example, ItemsAdder may need `/iareload`, Nexo may need `/nexo reload`, and Oraxen may need `/oraxen reload`.

The bundled Starter Ice Cream table YAML references ModelEngine model ids such as `frostcraft`, `orchardcraft`, `sugarcraft`, and `syrupcraft`. Install matching ModelEngine models separately if you want custom 3D table visuals.

## Disabling Bundled Defaults

If you do not want StarGenerator to create bundled starter packs, default groups, or provider resources on startup/reload, set:

```yaml
default-content:
  enabled: false
```

This does not delete files that already exist. It only stops future default extraction.

## Loading Order

StarGenerator depends on StarLibs and soft-depends on supported optional plugins. This lets the plugin run on servers that use ItemsAdder, Nexo, or Oraxen without requiring all of them.

When ItemsAdder is installed, StarGenerator waits for ItemsAdder content readiness before fully loading recipes that need those custom items.


---

# 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:

```
GET https://star-generator.gitbook.io/star-generator-docs/getting-started/installation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.