ResidenceList

```text

/ _ ___ ___ (_)__/ /__ ___ _______ / / (_)__ / / / , / -|-</ / / -) _ / __/ -_) /__/ (_-</ __/ //||__/___//,_/__////__/__/____/_/___/__/ ```

README LANGUAGES [**English** | 中文 ]

Download

Java CI with Maven

ResidenceList

> Great listed all listed !

List existing residence in server in a gui, and allow players to manage, teleport, and comment.

<img src="https://github.com/ArtformGames/ResidenceList/raw/master/.doc/logo.png" width="300px" height="300px" alt="Project logo" align="right">

Features & Advantages

- Display all residences in a GUI! - Allow players to edit residence's nickname, description, icon and public status! - Allow players to pin their favourite residences! - Allow players to rate & comment residences! - Admin can manage all residences in a GUI!

Screenshots

Dependencies

- [Recommend] Residence part base on [Recommend]. - [Recommend] Placeholders based on %%MD1%% .

For development dependencies, please see Dependencies .

Commands

Player commands

Main command is `/ResidenceList` or `/reslist`.

```text

help

- Display all plugin commands

open [player-name]

- Open the residence list gui

info <residence-name>

- Display the residence info

edit <residence-name>

- Open the residence edit gui ```

Admin commands

Main command is `/ResidenceListAdmin` or `/reslistadmin`, with permission `residencelist.admin`.

```text

open [player-name]

- Open the residence manage list gui

edit <residence-name>

- Open the residence edit gui

reload

- Reload the plugin configuration ```

Placeholders

This function based on PlaceholderAPI . You should install it before using placeholders in game.

```text

%residencelist_status_<residence>%

- Display the residence public status

%residencelist_name_<residence>%

- Display the residence alias name or the residence name(if alias not set) ```

Configurations

You can find configuration translations at ResidenceList-Translations.

Plugin Configuration (`config.yml`)

Will be generated on the first boot up.

Messages Configuration (`messages.yml`)

Will be generated on the first boot up.

Permissions

```text

ResidenceList.admin

- The permissions for all admin commands and functions. ```

Statistics

bStats

Open Source Licence

The source code of this project adopts the GNU General Public License v3.0.

Supports

This project is mainly developed by the Artfrom Games .

<img src="https://raw.githubusercontent.com/ArtformGames/.github/master/logo/logo_full.svg" width="317px" height="117px" alt="ArtformGames">

Many thanks to Jetbrains for kindly providing a license for us to work on this and other open-source projects.

Open