Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yuko fuyutsuki committed Feb 23, 2018
1 parent 4ef0540 commit 1744eb4
Show file tree
Hide file tree
Showing 2 changed files with 83 additions and 46 deletions.
129 changes: 83 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@
-->

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/fuyutsuki/Texter/blob/master/LICENSE)
[![Github All Releases](https://img.shields.io/github/downloads/fuyutsuki/Texter/total.svg)](https://github.com/fuyutsuki/Texter/releases)
[![](https://poggit.pmmp.io/shield.state/Texter)](https://poggit.pmmp.io/p/Texter)
[![](https://poggit.pmmp.io/shield.api/Texter)](https://poggit.pmmp.io/p/Texter)

[![](https://poggit.pmmp.io/shield.dl/Texter)](https://poggit.pmmp.io/p/Texter) / [![](https://poggit.pmmp.io/shield.dl.total/Texter)](https://poggit.pmmp.io/p/Texter)

[![PoggitCI Badge](https://poggit.pmmp.io/ci.badge/fuyutsuki/Texter/Texter)](https://poggit.pmmp.io/ci/fuyutsuki/Texter/Texter)

Expand All @@ -15,112 +18,146 @@ Select Language: [English](#eng), [日本語](#jpn)
<a name="eng"></a>
# English

<!--
## !! Caution !!
This branch is under development.
It may have many bugs.
-->

## Texter
Texter is plugin that displays and deletes FloatingTextPerticle supported to multi-world.
Latest: ver **2.2.6** _Papilio dehaanii(カラスアゲハ)_
Latest: ver **2.3.0** _Phyllorhiza punctata_

### Supporting
- [x] Minecraft(Bedrock) v1.2.x
- [x] Multi-language (eng, jpn)
- [x] Multi-world display
- [x] Minecraft(Bedrock) v1.2.x

### Download
You may grab the plugin from [Source](https://github.com/fuyutsuki/Texter/archive/master.zip), or download the latest .phar from [Poggit](https://poggit.pmmp.io/ci/fuyutsuki/Texter/Texter).

### Commands
#### General command
| \ |command|argument|alias|
| \ |command|alias|
|:--:|:--:|:--:|:--:|
|Add text|`/txt add`|`<title> [text]`|`/txt a`|
|Remove text|`/txt remove`|`<ID>`|`/txt r`|
|Update text|`/txt update`|`<title, text> <ID> <message>`|`/txt u`|
|Help|`/txt or /txt help`|`none`|`/txt ?`|
|Add text|`/txt add`|`/txt a`|
|Edit text|`/txt edit`|`/txt e`|
|Move text|`/txt move`|`/txt m`|
|Remove text|`/txt remove`|`/txt r`|
|Help|`/txt or /txt help`|`/txt ?`|

#### Management command
| \ |command|argument|alias|
|:--:|:--:|:--:|:--:|
|Remove all|`/txtadm allremove`|`none`|`/tadm ar`|
|Remove texts/user|`/txtadm userremove`|`<username>`|`/tadm ur`|
|Remove texts/user|`/txtadm userremove`|`<userName>`|`/tadm ur`|
|Remove texts/level|`/txtadm levelremove`|`<worldName>`|`/tadm lr`|
|Info|`/txtadm info`|`none`|`/tadm i`|
|Help|`/txtadm or /txtadm help`|`none`|`/tadm ?`|

**Please use `#` for line breaks.**

### json notation
- crfts.json
```json
{
"LevelName": {
"TextName(Unique)": {
"Xvec": 128,
"Yvec": 90,
"Zvec": 128,
"TITLE": "Title",
"TEXT": "Text(New line with #)"
}
}
}
```
- fts.json
```json
anythingUniqueValue: {
"WORLD" : "worldName",
"Xvec" : 128,
"Yvec" : 90,
"Zvec" : 128,
"TITLE" : "title",
"TEXT" : "1st Line#2nd Line..."
{
"LevelName": {
"TextName1(Unique)": {
"Xvec": 128,
"Yvec": 90,
"Zvec": 128,
"TITLE": "Title",
"TEXT": "Text(New line with #)",
"OWNER": "Steve"
}
}
}
```
It is output as follows.
<img src="/assets/Example.jpg" width="320px">
<!-- for poggit
<img src="https://raw.githubusercontent.com/fuyutsuki/Texter/master/assets/Example.jpg" width="320px">
-->

***
<a name="jpn"></a>
# 日本語

<!--
## !! 注意 !!
このブランチは開発中です。多くのバグを含む可能性があります。
-->

## Texter
TexterはFloatingTextPerticleを複数ワールドに渡り表示、削除ができるプラグインです。
最新バージョン: **2.2.6** _Papilio dehaanii(カラスアゲハ)_
最新バージョン: **2.3.0** _Phyllorhiza punctata_

### 対応状況
- [x] Minecraft(Bedrockエンジン) v1.2.x
- [x] 複数言語 (eng, jpn)
- [x] 複数ワールドの表示
- [x] Minecraft(Bedrockエンジン) v1.2.x

### ダウンロード
ソースファイル群は [こちら](https://github.com/fuyutsuki/Texter/archive/master.zip)
最新の .pharファイルが必要であれば [PoggitCI](https://poggit.pmmp.io/ci/fuyutsuki/Texter/Texter) の最新ビルドの **Download** から。

### コマンド
#### 一般用コマンド
| \ |コマンド|引数|エイリアス|
| \ |コマンド|エイリアス|
|:--:|:--:|:--:|:--:|
|浮き文字追加|`/txt add`|`<タイトル> [テキスト]`|`/txt a`|
|浮き文字削除|`/txt remove`|`<ID>`|`/txt r`|
|浮き文字更新|`/txt update`|`<タイトル, テキスト> <ID> <メッセージ>`|`/txt u`|
|ヘルプ|`/txt or /txt help`|`無し`|`/txt ?`|
|浮き文字追加|`/txt add`|`/txt a`|
|浮き文字編集|`/txt edit`|`/txt e`|
|浮き文字移動|`/txt move`|`/txt m`|
|浮き文字削除|`/txt remove`|`/txt r`|
|ヘルプ|`/txt or /txt help`|`/txt ?`|

#### 管理用コマンド
| \ |コマンド|引数|エイリアス|
|:--:|:--:|:--:|:--:|
|浮き文字すべて削除|`/txtadm allremove`|`none`|`/tadm ar`|
|ユーザーの浮き文字を削除|`/txtadm userremove`|`<username>`|`/tadm ur`|
|浮き文字の各種情報を見る|`/txtadm info`|`none`|`/tadm i`|
|ヘルプ|`/txtadm or /txtadm help`|`none`|`/tadm ?`|
|浮き文字すべて削除|`/txtadm allremove`|`なし`|`/tadm ar`|
|ユーザーの浮き文字を削除|`/txtadm userremove`|`<ユーザー名>`|`/tadm ur`|
|ワールドの浮き文字を削除|`/txtadm levelremove`|`<ワールド名>`|`/tadm lr`|
|浮き文字の各種情報を見る|`/txtadm info`|`なし`|`/tadm i`|
|ヘルプ|`/txtadm or /txtadm help`|`なし`|`/tadm ?`|

**改行の際には `#` を使用してください。**

### json記法
### json 記法
- crfts.json
```json
{
"一意な文字列": {
"WORLD" : "world",
"Xvec" : 128,
"Yvec" : 90,
"Zvec" : 128,
"TITLE" : "title",
"TEXT" : "1st Line#2nd Line"
"ワールド名": {
"浮き文字名(一意)": {
"Xvec": 128,
"Yvec": 90,
"Zvec": 128,
"TITLE": "タイトル",
"TEXT": "テキスト(改行は #)"
}
}
}
```
- fts.json
```json
{
"ワールド名": {
"浮き文字名(一意)": {
"Xvec": 128,
"Yvec": 90,
"Zvec": 128,
"TITLE": "タイトル",
"TEXT": "テキスト(改行は #)",
"OWNER": "Steve"
}
}
}
```

こう書くことで以下のように出力されます。
<img src="/assets/Example.jpg" width="320px">
<!-- for poggit
<img src="https://raw.githubusercontent.com/fuyutsuki/Texter/master/assets/Example.jpg" width="320px">
-->
Binary file removed assets/Example.jpg
Binary file not shown.

0 comments on commit 1744eb4

Please sign in to comment.