Flats

# Flats Plugin   Flats (British for "Apartments") is a plugin that allows you to create 3-dimensional areas and let players claim them. It provides an easy way to manage plots and ensure that players have their own designated areas to build and interact in. ## Features - **Create Flats:** Easily create areas with the selection tool and commands. - **Claim Flats:** Let players claim areas, allowing them to build only in their designated flats. - **Manage Flats:** Add or remove trusted players to allow them building in your flat. - **Interactive Commands:** Use simple commands to interact with the plugin. ## Installation 1. Download the latest version of the plugin from [Latest release](https://github.com/nvclas/Flats/releases/latest). 2. Copy the downloaded `Flats-x.x.jar` file into the `plugins` folder of your Paper Minecraft server. 3. Restart the server to load the plugin. ## Getting Started Once the plugin is installed, follow these steps to create and claim your first flat: 1. **Select an area:** - Use `/flats select` to get the selection tool. - Mark two corners of a cubic area you want to define as a flat. - One block at any bottom corner and one block at the opposite top corner. 2. **Create a flat:** - Run `/flats add ` to register the selected area as a flat. 3. **Claim the flat:** - Stand inside the area and use `/flats claim` to make it yours. 4. **Manage access:** - Use `/flats trust ` to allow other players to build in your flat. - Use `/flats untrust ` to remove their access. You're now ready to use Flats and manage your own space in the world! ## Configuration After installation, the plugin will automatically create the configuration files `flats.yml` and `settings.yml` in the plugin directory. These files can be customized to control the plugin's behavior. `flats.yml` will save any created flats and their attributes whereas `settings.yml` contains general settings like language. ## Supported Languages You can change the active language by editing the language code inside the `settings.yml`. Currently, the plugin supports the following languages: - `en_us` - English (USA) - `es_es` - Español (España) - `pt_pt` - Português (Portugal) - `fr_fr` - Français (France) - `de_de` - Deutsch (Deutschland) - `it_it` - Italiano (Italia) - `pl_pl` - Polski (Polska) - `nl_nl` - Nederlands (Nederland) - `ja_jp` - 日本語 (日本) - `sv_se` - Svenska (Sverige) - `ro_ro` - Română (România) - `el_gr` - Ελληνικά (Ελλάδα) - `hu_hu` - Magyar (Magyarország) - `uk_ua` - Українська (Україна) ## Commands The plugin provides several commands to interact with the areas: - `/flats select` - Get the selection tool for defining the area of a flat. - `/flats add ` - Creates a new flat with the specified name. - `/flats remove ` - Deletes the flat with the given name. - `/flats list [page]` - Lists all available flats and their owners. - `/flats update` - Easily update the plugin to the latest version. - `/flats claim` - Claims the flat the player is currently in. - `/flats unclaim` - Unclaims the flat the player is currently in. - `/flats info [flat]` - Shows information about the flat the player is currently in or a specific flat. - `/flats trust ` - Allows the specified player to build in the flat the player is currently in. - `/flats untrust ` - Removes the specified player's access to the flat the player is currently in. - `/flats show` - Show every flat my marking it with yellow glass. - And more ## Permissions The plugin uses a permission system to control access to certain commands: ## Permissions - `flats.admin` - Administrative permission for commands like plugin updates and system management. - `flats.edit` - Allows creating, modifying, and deleting flats. - `flats.claim` - Enables claiming and unclaiming existing flats. - `flats.show` - Grants access to `/flats show` command to highlight nearby flats visually. - `flats.list` - Permission to view a list of all existing flats. - `flats.info` - Allows viewing detailed information about individual flats. - `flats.trust` - Enables trusting and untrusting other players, allowing them to build on claimed flats. - `flats.skip_command_delay` - Bypasses cooldown restrictions on commands that normally have a delay. ## Developer Flats was developed by [nvclas](https://github.com/nvclas). ## License This project is licensed under the [GNU General Public License v3.0](https://github.com/nvclas/Flats/blob/main/LICENSE).