衷心感谢 Jetbrains 慷慨地为我们提供许可证,使我们能够开展这项以及其他开源项目的工作。
[](https://www.jetbrains.com/?from=https://github.com/ArtformGames/ResidenceList)
```text
___ _ __ __ _ __
/ _ \___ ___ (_)__/ /__ ___ _______ / / (_)__ / /_
/ , _/ -_|_- / _ / -_) _ \/ __/ -_) /__/ (_- __/
/_/|_|\__/___/_/\_,_/\__/_//_/\__/\__/____/_/___/\__/
```
README LANGUAGES [ [**English**](README.md) | [中文](https://github.com/ArtformGames/ResidenceList/blob/master/README_CN.md) ]

[](https://github.com/ArtformGames/ResidenceList/releases)
[](https://github.com/ArtformGames/ResidenceList/actions/workflows/maven.yml)

# **ResidenceList**
> 伟大的 **“Residence”** 全部 **列出**!
在服务器中以GUI显示所有住宅,并允许玩家管理、传送和评论。
## 特点与优势
- 在GUI中显示所有住宅!
- 允许玩家编辑住宅的昵称、描述、图标和公开状态!
- 允许玩家固定他们最喜欢的住宅!
- 允许玩家评分和评论住宅!
- 管理员可以在GUI中管理所有住宅!
## 截图


## 依赖
- **[必要]** 住宅基础依赖于 [Residence](https://www.zrips.net/residence/)。
- **[推荐]** 基于 [PlaceholderAPI](https://www.spigotmc.org/resources/6245/) 的占位符。
关于开发依赖,请
参考 [Dependencies](https://github.com/ArtformGames/ResidenceList/network/dependencies) 。
## 指令
### 玩家指令
主指令是 `/ResidenceList` 或 `/reslist`。
```text
# help
- 显示所有插件指令
# open [player-name]
- 打开住宅列表GUI
# info
- 显示住宅信息
# edit
- 打开住宅编辑GUI
```
### 管理员指令
主指令是 `/ResidenceListAdmin` 或 `/reslistadmin`,需要 `residencelist.admin` 权限。
```text
# open [player-name]
- 打开住宅管理列表GUI
# edit
- 打开住宅编辑GUI
# reload
- 重新加载插件配置
```
## 占位符
此功能基于 [PlaceholderAPI](https://www.spigotmc.org/resources/6245/) 。
在使用游戏中的占位符之前,您需要安装它。
```text
# %residencelist_status_%
- 显示住宅的公开状态
# %residencelist_name_%
- 显示住宅的别名名称或住宅名称(如果未设置别名)
```
## 配置
您可以在 [ResidenceList-Translations](https://github.com/ArtformGames/ResidenceList-Translations) 中找到配置翻译。
### 插件配置 (`config.yml`)
将在首次启动时生成。
### 消息配置 (`messages.yml`)
将在首次启动时生成。
## 权限
```text
# ResidenceList.admin
- 所有管理员指令和功能的权限。
```
## 统计
[](https://bstats.org/plugin/bukkit/ResidenceList/19709)
## 开源许可
此项目的源代码采用 [GNU General Public License v3.0](https://opensource.org/licenses/GPL-3.0)。
## 支持
本项目主要由 [Artfrom Games](https://github.com/ArtformGames/) 开发。
衷心感谢 Jetbrains 慷慨地为我们提供许可证,使我们能够开展这项以及其他开源项目的工作。
[](https://www.jetbrains.com/?from=https://github.com/ArtformGames/ResidenceList)
衷心感谢 Jetbrains 慷慨地为我们提供许可证,使我们能够开展这项以及其他开源项目的工作。
[](https://www.jetbrains.com/?from=https://github.com/ArtformGames/ResidenceList)