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

# Overview

Welcome! This guide walks you through installing TCP-WildSpawners, configuring your first preset, distributing spawners to players, and managing everything from the in-game GUI.

The pitch in one sentence: **vanilla Trial Spawners that work anywhere on your survival map**, with custom mobs, holograms, mining-and-redeploy, and griefing protection. Players already know how vanilla spawners feel; this just lets you put them outside Trial Chambers.

## Where to start

1. [**Installation**](/plugins/mc/ws-documentation/installation.md) — Drop the JAR in, restart, verify the plugin loaded.
2. [**Your first spawner**](/plugins/mc/ws-documentation/your-first-spawner.md) — A 5-minute walkthrough: configure a preset, give yourself a spawner, place it, fight some mobs.
3. [**Configuring wild-presets.yml**](/plugins/mc/ws-documentation/wild-presets-yml.md) — Full reference for the preset definitions file.
4. [**Custom mobs**](/plugins/mc/ws-documentation/custom-mobs.md) — Using MythicMobs, EliteMobs, EcoMobs, LevelledMobs, InfernalMobs, and Citizens with this plugin.
5. [**Distributing spawners**](/plugins/mc/ws-documentation/distributing-spawners.md) — How to hand out spawners via shops, mob drops, quest rewards.
6. [**The admin GUI**](/plugins/mc/ws-documentation/admin-gui.md) — Tour of `/tcpws gui`.
7. [**Commands & permissions**](/plugins/mc/ws-documentation/commands-and-permissions.md) — Quick reference.
8. [**config.yml reference**](/plugins/mc/ws-documentation/config-yml.md) — Global toggles (holograms, mining, mob tether, griefing protection).
9. [**Mining and re-deploying**](/plugins/mc/ws-documentation/mining-and-redeploy.md) — How state-preserving mining works.
10. [**messages.yml**](/plugins/mc/ws-documentation/messages-yml.md) — Translating or customising the player-facing text.
11. [**Integration with TCP-VaultCrates**](/plugins/mc/ws-documentation/vaultcrates-integration.md) — Make spawner mobs drop crate keys.
12. [**Troubleshooting & FAQ**](/plugins/mc/ws-documentation/troubleshooting.md) — Common gotchas.

## What this plugin needs

* **Paper or Folia 1.21.1+**
* **Java 21+**
* **TrialChamberPro v1.4.0+** — the free base plugin

Full requirements — including the Minecraft 26.x build note and the optional custom-mob plugins (MythicMobs, EliteMobs, …) — are in [**Installation**](/plugins/mc/ws-documentation/installation.md).

## Getting help

If you hit a snag the docs don't cover, the Discord linked from the marketplace product page is the fastest way to get an answer.

When asking, include:

* Plugin version (`/tcpws version` shows it)
* Server software + version (`Paper 1.21.4`, `Paper 1.21.8`, `Folia 1.21.8`, etc.)
* The relevant config snippet (`wild-presets.yml` entry, `config.yml` block)
* The full console log around the moment the issue happened
* Which custom-mob plugins (if any) you have installed, and their versions

That's usually enough to diagnose almost anything.


---

# 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://darkstarworks.gitbook.io/plugins/mc/ws-documentation/readme.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.