Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
MeowServer committed Sep 1, 2024
2 parents d7083ab + e3425af commit 087d884
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 3 deletions.
17 changes: 17 additions & 0 deletions ReadMe/README_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,23 @@ To install this plugin, please
2. If you are using PluginAPI (The default API), put Harmony.dll into dependencies folder.
3. Restart your server.

## Features
HintServiceMeow includes following features:
#### Hint Adapter
HintServiceMeow includes a hint adapter that can convert other plugins' hints into HintServiceMeow-compatible Hint. This allows people to use any plugin that uses hints, even if they are neither compatible with each other nor with HintServiceMeow.

## Developer Features
#### Auto text
An auto-update text in the Hint classes.
#### Dynamic Hint
A hint that can automatically position itself on the screen in the most optimal position.
#### Auto Update
Any changes to a hint will be automatically updated on the player's screen.
#### Update forecast
This framework can analyze the update frequency of each hint and schedule updates accordingly. You can also customize the update delay for each Hint, ranging from Fastest to No-sync.
#### Player UI
Player UI includes advanced components to simplify your development. For example, the common hint component of PlayerUI allows you to show commonly used hints to a player using a single method.

## To Developers
Here's an easy documentary of this plugin:
There are 2 ways to show a hint to a player.
Expand Down
24 changes: 21 additions & 3 deletions ReadMe/README_zh.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,30 @@
### 简介
## 简介
HintServiceMeow 是一款基于Exiled框架的插件,用于向玩家同时展示多条Hint。
### 安装

## 安装
如果希望安装这个插件
1. 进入发行(Release)页面并下载最新的HintServiceMeow.dll文件。
2. 如果您正在使用PluginAPI(默认的API),请将Harmony.dll放入dependencies文件夹
3. 将这个文件粘贴于插件文件夹中,并重启服务器即可安装。

### 致开发者
## 功能
#### Hint适配器
HintServiceMeow包含了一个Hint适配器,这个适配器可以将本不适配HintServiceMeow的插件适配HintServiceMeow。通过这样,可以让使用了Hint的插件在没有任何适配的情况下互相兼容。

## 开发者功能
#### 自更新文字
可通过AutoText属性自动更新Hint内容
#### 动态Hint
一种自动插入到屏幕最佳位置的Hint
#### 自动更新
任何对Hint类属性的改变都会自动更新到玩家的屏幕上
#### 更新预测
这个框架可以分析并预测每个Hint的更新速度,并根据更新速度规划更新时间。您可以通过改变Hint中的SyncSpeed属性来调整每个Hint的更新延时,可选择从最快到不同步。
#### 玩家UI
玩家UI包含了一系列的简化开发的部件。其中的CommonHint部件可以帮助开发者快速的向玩家展示常用的Hint。


## 致开发者
这里是一个简单的指导:
有两种方式向一个玩家展示一条Hint
- 创建一个hint类型的实例,并将其加入到PlayerDisplay类中
Expand Down

0 comments on commit 087d884

Please sign in to comment.