1
mirror of https://github.com/CarmJos/MoeTeleport.git synced 2024-09-19 21:35:56 +00:00

docs(en): 提供英文版本的介绍,并发布于SpigotMC

This commit is contained in:
Carm Jos 2023-02-16 21:05:21 +08:00
parent cb76e86b80
commit f728d1f7e6
3 changed files with 26 additions and 26 deletions

View File

@ -5,6 +5,7 @@
/_/ /_/\___/\__/_/ \__/_/\__/ .__/\___/_/ \__/
/_/
```
README LANGUAGES [ [中文](README.md) | [**English**](README-EN.md) ]
# MoeTeleport
@ -19,10 +20,9 @@ MoeTeleport is an open source delivery plugin that contains several features and
The project code conforms to the development specifications and is suitable for new developers to learn Bukkit and make their own plugins.
## Function and advantage
### Current function
## Functions and advantages
### Current functions
- Multiple storage formats, select on demand.
- Support YAML, JSON and MySQL/MariaDB storage
@ -37,7 +37,7 @@ The project code conforms to the development specifications and is suitable for
- Support setting different number of homes according to permissions as VIP add-on content
- Return to the place of death and the last location
### Advantage
### Advantages
- ** Lightweight plugin. ** Suitable for small servers, simple and convenient configuration.
- ** Specification development. ** Plugin architecture conforms to development specifications, suitable for new developers to learn.
@ -49,25 +49,26 @@ The project code conforms to the development specifications and is suitable for
## [Dependencies](https://github.com/CarmJos/MoeTeleport/network/dependencies)
- **[Necessary]** The plugin is based on [Spigot-API](https://hub.spigotmc.org/stash/projects/SPIGOT) 、[BukkitAPI](http://bukkit.org/).
- **[自带]** Message format is based on [MineDown](https://github.com/Phoenix616/MineDown).
- **[Included]** Message format is based on [MineDown](https://github.com/Phoenix616/MineDown).
- All messages.yml support MineDown syntax。
- **[Recommend]** The variable part is based on [PlaceholderAPI](https://www.spigotmc.org/resources/6245/).
- **[Recommended]** The variable part is based on [PlaceholderAPI](https://www.spigotmc.org/resources/6245/).
Read this if you need more details. [Dependencies](https://github.com/CarmJos/MoeTeleport/network/dependencies).
## [Command](src/main/resources/plugin.yml)
## [Commands](src/main/resources/plugin.yml)
The main command is `/MoeTeleport` or `/mt`.
All commands in this plugin support configuration of "simplified commands", such as allowing the player to directly input '/back' and execute '/MoeTeleport back', see [configuration file](# configuration) related content.
All commands in this plugin support configuration of "simplified commands",
such as allowing the player to directly input '/back' and execute '/MoeTeleport back', see [configuration](#Config) related content.
- Required parameter '< Parameter >'
- Optional parameter '[parameter]'
```text
# reload
@ executive command (MoeTeleport.admin)
- Overload the plugin configuration file.
@ Admin command (MoeTeleport.admin)
- Reload the plugin configuration file.
# back
- Return to the last location.
@ -114,8 +115,8 @@ All commands in this plugin support configuration of "simplified commands", such
# warp set <warp name>
- Set a warp location.
- If the warp already exists and you are the owner (or the server administrator) of the warp
- The old warp point will be overwritten.
- If the warp already exists and you are the owner (or the server administrator) of the warp,
- the old warp point will be overwritten.
# warp delete <Warp name>
- Delete one of your own warps
@ -124,11 +125,11 @@ All commands in this plugin support configuration of "simplified commands", such
## Config
### Plugin configuration file ([config.yml](src/main/resources/config.yml))
### Plugin configuration file ([config.yml]())
Read source file for more details.
### Message configuration file ([messages.yml](src/main/resources/messages.yml))
### Message configuration file ([messages.yml]())
Support [MineDown syntax](https://wiki.phoenix616.dev/library:minedown:syntax)
@ -146,6 +147,9 @@ Sincere thanks to the following friends who support the development of this proj
- This plugin is entrusted by [**璎珞 **](https://www.yingluo.world/) server , authorized already.
- Thank you to [**XingMC**(MagicMC server developer)](https://www.mcbbs.net/?4816320) for funding the subsequent development of this plugin.
Many thanks to Jetbrains for kindly providing a license for me to work on this and other open-source projects.
[![](https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.svg)](https://www.jetbrains.com/?from=https://github.com/CarmJos/UserPrefix)
## Open source agreement
The source code of this project uses [GNU General Public License v3.0](https://opensource.org/licenses/GPL-3.0) License.

View File

@ -5,6 +5,7 @@
/_/ /_/\___/\__/_/ \__/_/\__/ .__/\___/_/ \__/
/_/
```
README LANGUAGES [ [**中文**](README.md) | [English](README-EN.md) ]
# MoeTeleport 喵喵传送
@ -124,11 +125,11 @@
## 配置
### 插件配置文件 ([config.yml](src/main/resources/config.yml))
### 插件配置文件 ([config.yml]())
详见源文件。
### 消息配置文件 ([messages.yml](src/main/resources/messages.yml))
### 消息配置文件 ([messages.yml]())
支持 [MineDown 语法](https://wiki.phoenix616.dev/library:minedown:syntax),详见源文件。
@ -144,6 +145,9 @@
- 本插件由 [**璎珞**服务器](https://www.yingluo.world/) 委托本人开发,经过授权后开源。
- 感谢 [**XingMC**(MagicMC服务器开发者)](https://www.mcbbs.net/?4816320) 为本插件提供后续开发的资金赞助。
Many thanks to Jetbrains for kindly providing a license for me to work on this and other open-source projects.
[![](https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.svg)](https://www.jetbrains.com/?from=https://github.com/CarmJos/UserPrefix)
## 开源协议
本项目源码采用 [GNU General Public License v3.0](https://opensource.org/licenses/GPL-3.0) 开源协议。

View File

@ -1,8 +0,0 @@
package cc.carm.plugin.moeteleport.effect;
public class TeleportEffect {
}