# Overview Bookshelf is the plugin everything else sits on. It replaces EssentialsX, and it's what most other Lodestone plugins expect to find installed. The difference from EssentialsX is mostly in feel. Commands are built to look like vanilla ones rather than inventing their own syntax, so `/ban Steve griefing -d 7d` works the way you'd guess, and everything can be switched off individually if you'd rather another plugin handled it. ## Try it Ban someone for a week: ``` /ban Steve griefing -d 7d ``` Set up a warp: ``` /setwarp shop /warp shop ``` Save what you're holding as a kit and hand it out: ``` /kit save starter /kit give @a starter ``` ## What's in it Bookshelf is big. Rather than listing everything here, each area has its own page with proper explanations and examples: | Area | What's in it | |---|---| | [[Bookshelf/Server Owners/Features/Moderation]] | Bans, mutes, warnings, kicks, infraction history, alt detection, vanish, social spy | | [[Bookshelf/Server Owners/Features/Teleportation]] | Teleporting, warps, `/back`, `/spawn`, `/top`, world management, delays and cooldowns | | [[Bookshelf/Server Owners/Features/Chat System]] | Chat formatting from LuckPerms, mentions, links, item display, filtering, channels, cross-server chat | | [[Bookshelf/Server Owners/Features/Kits]] | Saving and giving out player states, including sharing kits between servers | | [[Bookshelf/Server Owners/Features/Utilities]] | Gamemode, fly, god, heal, item editing, player attributes, powertools and a great deal more | | [[Bookshelf/Server Owners/Features/Locales]] | Translating everything players see | For a flat list of every command, see [[Bookshelf/Server Owners/Commands]]. ## The parts worth knowing about **Moderation is proper moderation.** Bans and mutes can be temporary, IP bans work, and Bookshelf tracks alt accounts by IP and UUID so a ban evader turns up in `/alts`. Every action a player has ever received is in `/infractions`. **Chat reads your ranks from LuckPerms.** Prefixes, suffixes, colours and per-rank chat cooldowns all come from the meta you've already set. Nothing to duplicate. **Teleporting remembers where you were.** `/back` works after a teleport, after a death, and after logging back in. **Warps have their own permissions.** Each one is a separate file with its own permission, so you can give ranks access to different places. **Everything is optional.** Every command can be turned off in the config, so Bookshelf can be as small or as complete as you want. **It speaks across servers.** With Redis, chat and some state cross between servers on a network. ## Permissions They all follow the same pattern: ``` lodestone.bookshelf.commands.<category>.<command> ``` So `/ban` is `lodestone.bookshelf.commands.infractions.ban`. Each page lists the exact node for its commands. ## Running a network Point your servers at MongoDB and Redis and things start working across all of them: - Bans and mutes apply everywhere, and staff get told about them wherever they are - Whispers reach someone on another server - Chat channels span the network - Player data is shared rather than kept per server ## What you need | | | |---|---| | Server | Paper 1.21.4 or newer | | Java | 21 or newer | There's a Velocity build too, which enforces network bans and handles cross-server commands at the proxy. You can run either on its own, or both. Optional, and all picked up automatically if you have them: | Plugin | What it adds | |---|---| | LuckPerms | Ranks, prefixes and per-group settings feeding into chat | | PlaceholderAPI | Placeholders wherever you can write text | | InvSeePlusPlus | Better inventory inspection | | PacketEvents | A handful of packet-level features | None of them are required. ## Related Pages - [[Bookshelf/Server Owners/Features/Chat System]] - Chat formatting, LuckPerms, moderation, and channels - [[Bookshelf/Server Owners/Features/Moderation]] - Infractions, vanish, social spy, and alt detection - [[Bookshelf/Server Owners/Features/Teleportation]] - Warps, delays, cooldowns, and offline teleportation - [[Bookshelf/Server Owners/Features/Kits]] - Kit system with save, load, export, and weighted selection - [[Bookshelf/Server Owners/Features/Utilities]] - Item commands, attributes, flight, god mode, and powertool - [[Bookshelf/Server Owners/Features/Locales]] - Editing plugin text and adding languages - [[Bookshelf/Server Owners/Configuration]] - Full config.yml breakdown - [[Bookshelf/Server Owners/Commands]] - Complete command reference - [[Bookshelf/Developers/API Reference]] - Developer API documentation