b6863806cd
Some checks failed
Build / build (push) Has been cancelled
Centered hero header with chunky black Download badge, small chip badges below, em-dash tagline, single-line nav row. Sections trimmed, license collapsed to <sub> footer line. Same visual language as s8n-ru/minecraft-launcher README.
118 lines
3.2 KiB
Markdown
118 lines
3.2 KiB
Markdown
<div align="center">
|
|
|
|
# auth-limbo
|
|
|
|
<br>
|
|
<a href="https://github.com/s8n-ru/auth-limbo/releases/latest">
|
|
<img src="https://img.shields.io/badge/Download_.jar-black?style=for-the-badge&logoColor=white&labelColor=black&color=white" height="60" alt="Download latest jar">
|
|
</a>
|
|
<br><br>
|
|
|
|
[](https://papermc.io/)
|
|
[](https://adoptium.net/)
|
|
[](https://github.com/s8n-ru/auth-limbo/actions/workflows/build.yml)
|
|
|
|
---
|
|
|
|
a small paper plugin - ***fixes AuthMe's broken post-login teleport***
|
|
|
|
built for my server, runs there daily.
|
|
|
|
---
|
|
|
|
[Issues](../../issues) · [Releases](../../releases)
|
|
|
|
</div>
|
|
|
|
---
|
|
|
|
## What it does
|
|
|
|
Two things.
|
|
|
|
1. **Void `auth_limbo` world.** Custom `ChunkGenerator`, 5x5 barrier
|
|
platform under spawn. AuthMe uses it as pre-auth limbo. No
|
|
Multiverse-Core required.
|
|
2. **Restore-teleport that actually works.** `LoginEvent` listener at
|
|
`MONITOR` priority reads quit-location from `plugins/AuthMe/authme.db`,
|
|
pins destination chunk via `addPluginChunkTicket`, chains
|
|
`getChunkAtAsyncUrgently` into `teleportAsync`. No spawn-snap.
|
|
|
|
Bug background: [PaperMC/Paper#4085](https://github.com/PaperMC/Paper/issues/4085).
|
|
|
|
---
|
|
|
|
## Install
|
|
|
|
1. Download `AuthLimbo-1.0.0.jar` from [Releases](https://github.com/s8n-ru/auth-limbo/releases).
|
|
2. Drop in `plugins/`.
|
|
3. Restart server. Don't `/reload`.
|
|
|
|
Hard dep: **AuthMe-ReReloaded**. Plugin refuses to load without it.
|
|
|
|
For `itzg/minecraft-server` Docker image, see [`docs/installation.md`](docs/installation.md).
|
|
|
|
---
|
|
|
|
## Config
|
|
|
|
Defaults work. `plugins/AuthLimbo/config.yml` on first start:
|
|
|
|
```yaml
|
|
limbo:
|
|
world: auth_limbo
|
|
spawn-x: 0.5
|
|
spawn-y: 128.0
|
|
spawn-z: 0.5
|
|
build-platform: true
|
|
platform-y: 127
|
|
authme:
|
|
db-path: plugins/AuthMe/authme.db
|
|
teleport-delay-ticks: 10
|
|
preload-chunks: true
|
|
debug: false
|
|
```
|
|
|
|
Full reference: [`docs/configuration.md`](docs/configuration.md).
|
|
|
|
---
|
|
|
|
## Commands
|
|
|
|
| Command | Permission | Effect |
|
|
|---|---|---|
|
|
| `/authlimbo reload` | `authlimbo.admin` | Reload `config.yml`. |
|
|
| `/authlimbo tp <player>` | `authlimbo.admin` | Teleport player to saved location. |
|
|
|
|
Alias: `/alimbo`.
|
|
|
|
---
|
|
|
|
## Tested
|
|
|
|
| Component | Status |
|
|
|---|---|
|
|
| Paper 1.21.11 | Yes |
|
|
| Purpur 1.21.11 | Yes |
|
|
| Folia | Untested — login event threading may differ |
|
|
| AuthMe-ReReloaded (HaHaWTH b49) | Yes |
|
|
| AuthMe-ReReloaded other 5.x forks | Untested — schema same, should work |
|
|
| Multiverse-Core | Untested — possible teleport-intercept conflict, see [`docs/compatibility.md`](docs/compatibility.md) |
|
|
|
|
---
|
|
|
|
## Build from source
|
|
|
|
```bash
|
|
mvn clean package
|
|
```
|
|
|
|
Shaded jar lands at `target/AuthLimbo-1.0.0.jar`. Java 21, Maven 3.9.
|
|
`lib/AuthMe-5.6.0-FORK-Universal.jar` is `system`-scope so build
|
|
needs no private repo credentials.
|
|
|
|
CI builds via [GitHub Actions](.github/workflows/build.yml) on every tag.
|
|
|
|
---
|
|
|
|
<sub>[AGPL-3.0](LICENSE) — modified network-deployed builds must offer source per §13. Built by [s8n-ru](https://github.com/s8n-ru).</sub>
|