Skip to content

Commit 1744eb4

Browse files
author
yuko fuyutsuki
committed
Update README.md
1 parent 4ef0540 commit 1744eb4

File tree

2 files changed

+83
-46
lines changed

2 files changed

+83
-46
lines changed

README.md

+83-46
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@
44
-->
55

66
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/fuyutsuki/Texter/blob/master/LICENSE)
7-
[![Github All Releases](https://img.shields.io/github/downloads/fuyutsuki/Texter/total.svg)](https://github.com/fuyutsuki/Texter/releases)
7+
[![](https://poggit.pmmp.io/shield.state/Texter)](https://poggit.pmmp.io/p/Texter)
8+
[![](https://poggit.pmmp.io/shield.api/Texter)](https://poggit.pmmp.io/p/Texter)
9+
10+
[![](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)
811

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

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

21+
<!--
1822
## !! Caution !!
1923
This branch is under development.
2024
It may have many bugs.
25+
-->
2126

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

2631
### Supporting
32+
- [x] Minecraft(Bedrock) v1.2.x
2733
- [x] Multi-language (eng, jpn)
2834
- [x] Multi-world display
29-
- [x] Minecraft(Bedrock) v1.2.x
3035

3136
### Download
3237
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).
3338

3439
### Commands
3540
#### General command
36-
| \ |command|argument|alias|
41+
| \ |command|alias|
3742
|:--:|:--:|:--:|:--:|
38-
|Add text|`/txt add`|`<title> [text]`|`/txt a`|
39-
|Remove text|`/txt remove`|`<ID>`|`/txt r`|
40-
|Update text|`/txt update`|`<title, text> <ID> <message>`|`/txt u`|
41-
|Help|`/txt or /txt help`|`none`|`/txt ?`|
43+
|Add text|`/txt add`|`/txt a`|
44+
|Edit text|`/txt edit`|`/txt e`|
45+
|Move text|`/txt move`|`/txt m`|
46+
|Remove text|`/txt remove`|`/txt r`|
47+
|Help|`/txt or /txt help`|`/txt ?`|
4248

4349
#### Management command
4450
| \ |command|argument|alias|
4551
|:--:|:--:|:--:|:--:|
4652
|Remove all|`/txtadm allremove`|`none`|`/tadm ar`|
47-
|Remove texts/user|`/txtadm userremove`|`<username>`|`/tadm ur`|
53+
|Remove texts/user|`/txtadm userremove`|`<userName>`|`/tadm ur`|
54+
|Remove texts/level|`/txtadm levelremove`|`<worldName>`|`/tadm lr`|
4855
|Info|`/txtadm info`|`none`|`/tadm i`|
4956
|Help|`/txtadm or /txtadm help`|`none`|`/tadm ?`|
5057

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

5360
### json notation
61+
- crfts.json
62+
```json
63+
{
64+
"LevelName": {
65+
"TextName(Unique)": {
66+
"Xvec": 128,
67+
"Yvec": 90,
68+
"Zvec": 128,
69+
"TITLE": "Title",
70+
"TEXT": "Text(New line with #)"
71+
}
72+
}
73+
}
74+
```
75+
- fts.json
5476
```json
55-
anythingUniqueValue: {
56-
"WORLD" : "worldName",
57-
"Xvec" : 128,
58-
"Yvec" : 90,
59-
"Zvec" : 128,
60-
"TITLE" : "title",
61-
"TEXT" : "1st Line#2nd Line..."
77+
{
78+
"LevelName": {
79+
"TextName1(Unique)": {
80+
"Xvec": 128,
81+
"Yvec": 90,
82+
"Zvec": 128,
83+
"TITLE": "Title",
84+
"TEXT": "Text(New line with #)",
85+
"OWNER": "Steve"
86+
}
87+
}
6288
}
6389
```
64-
It is output as follows.
65-
<img src="/assets/Example.jpg" width="320px">
66-
<!-- for poggit
67-
<img src="https://raw.githubusercontent.com/fuyutsuki/Texter/master/assets/Example.jpg" width="320px">
68-
-->
90+
6991
***
7092
<a name="jpn"></a>
7193
# 日本語
7294

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

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

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

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

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

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

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

108-
### json記法
134+
### json 記法
135+
- crfts.json
109136
```json
110137
{
111-
"一意な文字列": {
112-
"WORLD" : "world",
113-
"Xvec" : 128,
114-
"Yvec" : 90,
115-
"Zvec" : 128,
116-
"TITLE" : "title",
117-
"TEXT" : "1st Line#2nd Line"
138+
"ワールド名": {
139+
"浮き文字名(一意)": {
140+
"Xvec": 128,
141+
"Yvec": 90,
142+
"Zvec": 128,
143+
"TITLE": "タイトル",
144+
"TEXT": "テキスト(改行は #)"
145+
}
146+
}
147+
}
148+
```
149+
- fts.json
150+
```json
151+
{
152+
"ワールド名": {
153+
"浮き文字名(一意)": {
154+
"Xvec": 128,
155+
"Yvec": 90,
156+
"Zvec": 128,
157+
"TITLE": "タイトル",
158+
"TEXT": "テキスト(改行は #)",
159+
"OWNER": "Steve"
160+
}
118161
}
119162
}
120163
```
121-
122-
こう書くことで以下のように出力されます。
123-
<img src="/assets/Example.jpg" width="320px">
124-
<!-- for poggit
125-
<img src="https://raw.githubusercontent.com/fuyutsuki/Texter/master/assets/Example.jpg" width="320px">
126-
-->

assets/Example.jpg

-131 KB
Binary file not shown.

0 commit comments

Comments
 (0)