DOCS berries.games ↗

Installation

Install

  1. Download BerryHomes.jar from BuiltByBit. One jar works on both Paper and Folia.
  2. Put it in your server's plugins/ folder.
  3. Restart the server (don't use /reload).
  4. Join and run /sethome, then /homes.

On first start BerryHomes creates its folder:

plugins/BerryHomes/
├── config.yml        storage, commands, permissions, limits, teleports, costs
├── lang.yml          every message
├── homes.db          the homes (with the default SQLite storage)
├── menus/
│   ├── homes.yml       the slots menu (/homes)
│   ├── homes-list.yml  the list menu
│   ├── home.yml        one home's settings
│   ├── icons.yml       the icon picker
│   └── confirm.yml     "are you sure?"
└── data/
    └── cooldowns.yml   saved cooldowns

Coming from another homes plugin

Your players keep their homes:

  • EssentialsX: /ahome convertall (or /ahome import essentials). Run /ahome import essentials dryrun first to see what it finds.
  • HuskHomes (SQLite): /ahome import huskhomes.
  • ModernHome (SQLite or MySQL): /ahome import modernhome.

Imports run in the background, skip homes that already exist and fix names that don't fit the name rules. See storage & importing.

Remove the old plugin afterwards, or turn its /home and /sethome off, so the commands don't clash.

On a network

Every server needs the same storage settings (MySQL, MariaDB or MongoDB) and its own server-name, matching the name in velocity.toml. The full checklist is on the cross-server page.

Updating

Replace the jar and restart. Your config files are never overwritten.

  • New settings and messages are added to your files automatically, with their comments. Nothing you changed is touched, and your old file is kept as config.old.yml / lang.old.yml.
  • New default menus only appear if you delete plugins/BerryHomes/menus/ so they can be created again.

Heads up: changing command names, aliases or permission nodes needs a full restart. Everything else applies with /ahome reload.