Skip to content

Commit

Permalink
[fix]READMEを更新
Browse files Browse the repository at this point in the history
  • Loading branch information
nova-27 committed Sep 25, 2022
1 parent b6712d0 commit e89f2e0
Showing 1 changed file with 26 additions and 10 deletions.
36 changes: 26 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,36 +2,52 @@
[![license](https://img.shields.io/github/license/nova-27/CrafterePostPlugin?color=b8b8b8)](https://github.com/nova-27/CrafterePostPlugin/blob/main/LICENSE)

# CrafterePostPlugin
このプラグインは、[CrafterePost](https://crafterepost.netlify.app/)公式のSpigotプラグインです。
選択した範囲をSchematic([Sponge Schematic Specification Version 2](https://github.com/SpongePowered/Schematic-Specification/blob/master/versions/schematic-2.md))建築形式やMCSR(Minecraft Schematic based Recording)録画形式のファイルに出力します。
出力したデータを[CrafterePost](https://crafterepost.netlify.app/)に投稿できます。

このプラグインは、[CrafterePost](https://crafterepost.netlify.app/)公式のSpigotプラグインです。

選択した範囲をSchematic([Sponge Schematic Specification Version 2](https://github.com/SpongePowered/Schematic-Specification/blob/master/versions/schematic-2.md))
建築形式やMCSR(Minecraft Schematic based Recording)録画形式のファイルに出力します。

出力したデータを[CrafterePost](https://crafterepost.netlify.app/)に投稿できます。

## 導入

現時点では**Spigot 1.18.x**でのみ動作確認済みです。

1. [Releases](https://github.com/nova-27/CrafterePostPlugin/releases)から最新のプラグインをダウンロードします。
2. 依存プラグインである[WorldEdit](https://dev.bukkit.org/projects/worldedit/files)[ProtocolLib](https://www.spigotmc.org/resources/protocollib.1997/)をダウンロードします。
2. 依存プラグインである[WorldEdit](https://dev.bukkit.org/projects/worldedit/files)
[ProtocolLib](https://www.spigotmc.org/resources/protocollib.1997/)をダウンロードします。
3. ダウンロードした3つのプラグインを、Spigotサーバーの`plugins`フォルダに移動します。

## コマンド一覧
- `/crapos schem`
- WorldEditのwandで選択した範囲をSchematic形式で出力します。
- 出力ファイル: `plugins/CrafterePost/test.schem`
- `/crapos record`
- WorldEditのwandで選択した範囲をMCSR形式で録画開始・停止します。
- 出力ファイル: `plugins/CrafterePost/test.mcsr`

- `/crapos schem ファイル名`
- WorldEditのwandで選択した範囲をSchematic建築形式で出力します。
- 出力ファイル: `plugins/CrafterePost/ファイル名.schem`
- `/crapos record start ファイル名`
- WorldEditのwandで選択した範囲をMCSR録画形式で録画開始します。
- 出力ファイル: `plugins/CrafterePost/ファイル名.mcsr`
- `/crapos record stop`
- MCSRの録画を停止します。
- 録画中にプレイヤーがサーバーを退出した場合、その時点で自動的に録画を停止します。

## ビルド

1. ソースコードをダウンロードします。

```shell
git clone https://github.com/nova-27/CrafterePostPlugin.git
```

2. ビルドします。

```shell
cd CrafterePostPlugin
./gradlew shadowJar
```

3. `build/libs`ディレクトリにプラグインjarが生成されます。

## ライセンス

当リポジトリは [CC0 1.0 Universal](https://creativecommons.org/publicdomain/zero/1.0/deed) のもとで公開されています。

0 comments on commit e89f2e0

Please sign in to comment.