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

https://github.com/hrobasti/timberella-plugin

Tree capitator / cutting / felling, leaves decay and replanting abilities. Completely configurable.
https://github.com/hrobasti/timberella-plugin

gaming minecraft papermc plugin server server-side

Last synced: 2 months ago
JSON representation

Tree capitator / cutting / felling, leaves decay and replanting abilities. Completely configurable.

Awesome Lists containing this project

README

          

# Timberella ๐ŸŒฒ

Drop-in quality-of-life plugin for Paper 26.1.x servers: instant tree felling, tidy leaf cleanup, and automatic replanting with safety rails so mega-builds stay intact.

![Timberella demo](img/timber_01.gif)

## Why server owners love it

- โšก One axe swing can clear an entire tree while damage, particles, and timing stay configurable.
- ๐ŸŒฑ Optional replant + soil checks keep forests alive.
- ๐Ÿ›ก๏ธ Species-aware limits (per-tree caps, radii, durability rules) stop griefing before it starts.
- ๐Ÿ” Live config + locale reloads merge new defaults automaticallyโ€”no manual diffing.
- ๐Ÿ”” Update checker (Modrinth + Hangar) and join reminders keep your fleet current.
- ๐ŸŒ MiniMessage-powered localization lets you style player + console feedback exactly the way you like.

## Server requirements

- Paper 26.1, 26.1.1, or 26.1.2 (Spigot/vanilla forks are not supported).
- Java 25 runtime.
- Optional: a permissions plugin (LuckPerms, etc.) for fine-grained access to `/timberella` commands.

## Setup in 3 steps

1. Copy the latest `timberella-paper-.jar` into `plugins/`.
2. Boot the server onceโ€”`config.yml`, `lang/`, and `leaf_mappings.yml` appear automatically.
3. Tweak `plugins/Timberella/config.yml` (modules, safety caps, labels) and run `/timberella reload`.

Thatโ€™s it. The async watcher keeps configs + locales synced, and every reload revalidates permissions, caches, and message bundles.

## Everyday tips

- Use `sneak-mode` to decide when timbering should trigger (only sneaking, only not sneaking, or always).
- Flip specific logs/woods/fences on or off in `categories.*`. Unknown materials are ignored safely.
- Watch the console after reloads: Timberella prints how many saplings, soils, and species are active plus any typos it auto-fixed.
- Update notifications surface in console and (optionally) to ops with `timberella.update.notify`; set `update-check.notify-console-always-shown` true if you still want โ€œno updateโ€ provider summaries every cycle, and leave `update-check.filter-by-server-version` true so Modrinth/Hangar matches your server build.

## Supported languages

Timberella bundles each locale as a MiniMessage YAML file so you can recolor or restyle them freely:

- ๐Ÿ‡บ๐Ÿ‡ธ English (en_US)
- ๐Ÿ‡ฉ๐Ÿ‡ช German (de_DE)
- ๐Ÿ‡ธ๐Ÿ‡ฆ Arabic (ar_SA)
- ๐Ÿ‡ช๐Ÿ‡ธ Spanish (es_ES)
- ๐Ÿ‡ซ๐Ÿ‡ท French (fr_FR)
- ๐Ÿ‡ฎ๐Ÿ‡น Italian (it_IT)
- ๐Ÿ‡ฏ๐Ÿ‡ต Japanese (ja_JP)
- ๐Ÿ‡ฐ๐Ÿ‡ท Korean (ko_KR)
- ๐Ÿ‡ณ๐Ÿ‡ฑ Dutch (nl_NL)
- ๐Ÿ‡ต๐Ÿ‡ฑ Polish (pl_PL)
- ๐Ÿ‡ต๐Ÿ‡น Portuguese (pt_PT)
- ๐Ÿ‡น๐Ÿ‡ท Turkish (tr_TR)
- ๐Ÿ‡บ๐Ÿ‡ฆ Ukrainian (uk_UA)
- ๐Ÿ‡จ๐Ÿ‡ณ Simplified Chinese (zh_CN)

Missing keys fall back to English, and `/timberella reload` hot-reloads both config + language edits.

## Need deeper guidance?

This README keeps things short on purpose. All developer and deep-dive documentation (config matrices, command charts, operations guides) lives in the project wiki. Start there whenever you need advanced workflows or contribution notes.

## License & Credits

- Timberella is released under the Apache License 2.0 (see `LICENSE`).
- Third-party components such as MiniMessage (MIT), Gson (Apache 2.0), Shadow (Apache 2.0), and bStats (MIT) ship with their respective notices inside `THIRD_PARTY_LICENSES.md` and the packaged `licenses/` folder.
- Parts of this plugin and documentation were produced with AI assistance (e.g., GitHub Copilot) and reviewed by the maintainer before release.