MoeTeleport/README.md

```text
   __  ___       ______    __                  __ 
  /  |/  /__  __/_  __/__ / /__ ___  ___  ____/ /_
 / /|_/ / _ \/ -_) / / -_) / -_) _ \/ _ \/ __/ __/
/_/  /_/\___/\__/_/  \__/_/\__/ .__/\___/_/  \__/ 
                             /_/                  
```

# MoeTeleport 喵喵传送

开源的传送插件，包含数个功能，并根据用户需求持续更新添加新功能。

项目代码符合开发规范，适合新手开发者学习Bukkit，制作属于自己的插件。

## 功能与优势

### 当前功能

- 多种存储格式，按需选择。
    - 支持 YAML、JSON 与 MySQL/MariaDB 存储方式
    - 支持直接调用 [EssentialsX](https://github.com/EssentialsX/Essentials) 数据，无缝切换
- 可点击的消息(如“点击同意”)
    - 基于MineDown语法，可自定义配置
- 玩家间的传送请求
    - 支持指定处理某位玩家的请求
- 设置家与回家 (可以理解为私人地标)
    - 支持依照权限设定不同数量的家作为VIP附加内容
- 回到死亡地点、上一传送地点

### 优势

- **轻量插件。** 适合小型服务器使用，配置简单方便。
- **规范开发。** 插件架构符合开发规范，适合新手开发者学习。
    - 自 [3.0.0]() 版本开始采用了 EasyPlugin 开发，可能与其他主流插件结构有些不同。
- **持续维护。** 新功能需求均可提交，大概率在后续开发中支持。
  -
  功能需求请 [提交Issues](https://github.com/CarmJos/MoeTeleport/issues/new?assignees=&labels=enhancement&template=feature_issues.md&title=)
  ，不要在帖子中提交！
    - 提交与 “传送” 相关联的请求才大概率会被更新支持。

## [依赖](https://github.com/CarmJos/MoeTeleport/network/dependencies)

- **[必须]** 插件本体基于 [Spigot-API](https://hub.spigotmc.org/stash/projects/SPIGOT) 、[BukkitAPI](http://bukkit.org/)
  实现。
- **[自带]** 消息格式基于 [MineDown](https://github.com/Phoenix616/MineDown) 实现。
    - 所有 messages.yml 均支持 MineDown 语法。
- **[推荐]** 变量部分基于 [PlaceholderAPI](https://www.spigotmc.org/resources/6245/) 实现。

详细依赖列表可见 [Dependencies](https://github.com/CarmJos/MoeTeleport/network/dependencies) 。

## [指令](src/main/resources/plugin.yml)

以下指令的主指令为 `/MoeTeleport` 或 `/mt`。

本插件所有指令支持配置“简化指令”，如允许玩家直接输入 `/back` 执行 `/MoeTeleport back`，详见 [配置文件](#配置) 相关内容。

- 必须参数 `<参数>`
- 可选参数 `[参数]`

```text
# reload
@ 管理指令 (MoeTeleport.admin)
- 重载插件配置文件。

# back
- 回到之前的传送位置。

----- [ 传送相关指令 ] -----

# teleport to <目标玩家>
- 请求传送到目标玩家的位置。

# teleport here <玩家>
- 请求目标玩家传送到自己的位置。

# teleport accept [玩家]
- 同意一个传送请求(可具体指定玩家的请求)。

# teleport deny [玩家]
- 拒绝一个传送请求(可具体指定玩家的请求)。

----- [ 家相关指令 ] -----

# home to [家名]
- 传送到指定的家。
- 若不填写具体的家明则返回首个设置的家，
- 若存在名为“home”的家则优先返回“home”。

# home list
- 列出所有的家位置。

# home set [家名]
- 设定一个家的位置。
- 若不填写家的名称则默认为“home”。

# home delete [家名]
- 删除一个家的位置。

----- [ 地标相关指令 ] -----

# warp to <地标名>
- 传送到指定的地标点。

# warp list
- 列出当前所有的地标点。

# warp set <地标名>
- 设定一个地标点。
- 若地标点已存在，且您是地标点的设立者(或是服务器管理员)，
- 则会覆盖原有的地标点位置。

# warp delete <地标名>
- 删除一个自己设立的地标点。

```

## 配置

### 插件配置文件 ([config.yml](src/main/resources/config.yml))

详见源文件。

### 消息配置文件 ([messages.yml](src/main/resources/messages.yml))

支持 [MineDown 语法](https://wiki.phoenix616.dev/library:minedown:syntax)，详见源文件。

### 玩家数据配置文件 (data/\<UUID\>.yml)

本插件采用 `YAML格式` 存储玩家数据。

```yaml
# 玩家的家位置记录
# 格式为 world;x;y;z;yaw;pitch
homes:
  "name": "world;112.21;45;21.241245552;92.5512;-11"

```

## 使用统计

[![bStats](https://bstats.org/signatures/bukkit/MoeTeleport.svg)](https://bstats.org/plugin/bukkit/MoeTeleport/14459)

## 支持与捐赠

若您觉得本插件做的不错，您可以捐赠支持我，感谢您成为开源项目的支持者！

由衷感谢以下支持本项目开发的朋友们：
- 本插件由 [**璎珞**服务器](https://www.yingluo.world/) 委托本人开发，经过授权后开源。
- 感谢 [**XingMC**(MagicMC服务器开发者)](https://www.mcbbs.net/?4816320) 为本插件提供后续开发的资金赞助。

## 开源协议

本项目源码采用 [GNU General Public License v3.0](https://opensource.org/licenses/GPL-3.0) 开源协议。
<details>
<summary>关于 GPL 协议</summary>

> GNU General Public Licence (GPL) 有可能是开源界最常用的许可模式。GPL 保证了所有开发者的权利，同时为使用者提供了足够的复制，分发，修改的权利：
>
> #### 可自由复制
> 你可以将软件复制到你的电脑，你客户的电脑，或者任何地方。复制份数没有任何限制。
> #### 可自由分发
> 在你的网站提供下载，拷贝到U盘送人，或者将源代码打印出来从窗户扔出去（环保起见，请别这样做）。
> #### 可以用来盈利
> 你可以在分发软件的时候收费，但你必须在收费前向你的客户提供该软件的 GNU GPL 许可协议，以便让他们知道，他们可以从别的渠道免费得到这份软件，以及你收费的理由。
> #### 可自由修改
> 如果你想添加或删除某个功能，没问题，如果你想在别的项目中使用部分代码，也没问题，唯一的要求是，使用了这段代码的项目也必须使用
> GPL 协议。
>
> 需要注意的是，分发的时候，需要明确提供源代码和二进制文件，另外，用于某些程序的某些协议有一些问题和限制，你可以看一下
> @PierreJoye 写的 Practical Guide to GPL Compliance 一文。使用 GPL 协议，你必须在源代码代码中包含相应信息，以及协议本身。
>
> *以上文字来自 [五种开源协议GPL,LGPL,BSD,MIT,Apache](https://www.oschina.net/question/54100_9455) 。*
</details>