# PronounsMC
**PronounsMC** 是一个 Minecraft Spigot 插件，允许玩家设置和显示他们的代词。它支持多种数据库类型 (**MySQL** 和 **SQLite**) 并通过语言文件提供可定制的消息。
## 注意事项
- 需要 PlaceholderAPI 才能使用占位符。
- 我们建议使用 [ChatInjector](https://www.spigotmc.org/resources/chatinjector-1-13.81201/) 之类的插件，以便与**不支持** PlaceholderAPI 的插件（例如 EssentialsX Chat）一起使用。
## 功能
- 玩家可以使用简单的命令设置和显示他们的代词。
- 代词带有颜色代码，可以通过 `config.yml` 进行配置。
- 支持 **MySQL** 或 **SQLite** 用于数据存储。
- 通过语言文件（例如 `lang/en_US.yml`）提供完全可定制的消息。
- 在不重启服务器的情况下重新加载设置和消息。
---
## 安装
1. **下载** 插件 jar 文件，并将其放在服务器的 `plugins/` 文件夹中。
2. **启动你的服务器** 以生成默认的配置文件。
3. **编辑 `config.yml`** 以配置：
- **数据库类型**: 在 `mysql` 或 `sqlite` 之间进行选择。
- **可用的代词**: 自定义代词列表及其颜色代码格式。
- **语言文件**: 指定语言文件 (默认为 `en_US`)。
4. **重启你的服务器** 或使用 `/pronouns reload` 应用更改。
---
## 占位符
| 占位符 | 描述 |
|------------------------|--------------------------------------------|
| `%pronouns%` | 显示用户的代词。与 PlaceholderAPI 配合使用 |
---
## 配置
### `config.yml`
颜色格式可以在代词中使用，如下所示，这是可选的。
```yaml
langFile: "en_US"
database:
type: sqlite # 使用 'mysql' 或 'sqlite'
host: localhost
port: 3306
name: minecraft
user: root
password: password
availablePronouns:
he/him: "&3(&bHe&3/&bHim&3)&r"
she/her: "&5(&dShe&5/&dHer&5)&r"
they/them: "&2(&aThey&2/&aThem&2)&r"
it/its: "&8(&7It&8/&7Its&8)&r"
he/they: "&3(&bHe&3/&bThey&3)&r"
she/they: "&4(&cShe&4/&cThey&4)&r"
xe/xem: "&8(&7Xe&8/&7Xem&8)&r"
ze/zir: "&8(&7Ze&8/&7Zir&8)&r"
```
### `lang/en_US.yml`
所有面向用户的信息都可以在语言文件中进行自定义。例如：
```yaml
messages:
usageMain: "&cUsage: /pronouns "
usageGet: "&cUsage: /pronouns get "
noPermission: "&cYou don't have permission to use this command."
playerNotFound: "&cPlayer not found!"
invalidPronoun: "&cInvalid pronoun. Use /pronouns list to see available options."
notSet: "&7Not set"
pluginReloaded: "&aPronounsMC config reloaded."
pronounSet: "&aYour pronouns have been set to: &r{pronouns}"
availablePronounsHeader: "&aAvailable pronouns:"
playerPronounFormat: "&a{player}'s pronouns: &r{pronouns}"
playerPronounNone: "&a{player}'s pronouns: &bNot set" # 用于 /pronouns get
onlyPlayers: "&cOnly players can set pronouns."
```
---
## 命令
| 命令 | 描述 | 权限 |
|------------------------|--------------------------------------------|---------------------|
| `/pronouns <代词>` | 将你的代词设置为指定的键。 | None |
| `/pronouns get <用户名>` | 显示另一个玩家的代词。 | `pronouns.get` |
| `/pronouns list` | 列出所有可用的代词。 | None |
| `/pronouns reload` | 重新加载配置和语言。 | `pronouns.reload` |
---
## 权限
| 权限 | 描述 | Default |
|---------------------|------------------------------------------|---------|
| `pronouns.get` | 允许检索另一个玩家的代词。 | OP |
| `pronouns.reload` | 允许重新加载配置和语言。 | OP |
---
## 数据库支持
### MySQL
要使用 MySQL:
1. 在 `config.yml` 中将 `database.type: mysql` 设置为。
2. 配置 `host`、`port`、`name`、`user` 和 `password`。
### SQLite
要使用 SQLite:
1. 在 `config.yml` 中将 `database.type: sqlite` 设置为。
2. 插件将在插件文件夹中创建一个 `pronouns.db` 文件。
---
## 许可证
本项目采用 [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt) 许可。
---
## 贡献
欢迎大家的贡献！要贡献：
1. 分叉该仓库。
2. 创建一个新的功能分支。
3. 提交一个拉取请求，解释你的更改。
---
## 感谢使用PronounsMC