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

README LANGUAGES [ English | 中文 ]

ResidenceList

Great "Residence" all listed !

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

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

• [Necessary] Residence part base on Residence.
• [Recommend] Placeholders based on PlaceholderAPI .

For development dependencies, please see Dependencies .

Commands

Player commands

Main command is /ResidenceList or /reslist.

# 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.

# 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.

# %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

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

# ResidenceList.admin
- The permissions for all admin commands and functions.

Statistics

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 .

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