summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSho Sakuma <me@m1sk9.dev>2026-06-12 14:00:44 +0900
committerSho Sakuma <me@m1sk9.dev>2026-06-12 14:00:44 +0900
commitced9a217c4a50d070f9b5100463f5c6d870ba844 (patch)
treee979fa580b4d723467f1d11e7c735e14e31fca53
parentf6edb632b0fa45b5eeeca61c006d4d2e74794cbb (diff)
downloadLunaticChat-ced9a217c4a50d070f9b5100463f5c6d870ba844.tar.gz
LunaticChat-ced9a217c4a50d070f9b5100463f5c6d870ba844.tar.bz2
LunaticChat-ced9a217c4a50d070f9b5100463f5c6d870ba844.zip
docs: add Japanese README and revise Velocity, download, license info
- Add README.ja.md (Japanese translation) with language picker - Add language picker to README.md - Add Velocity integration overview focusing on protocol compatibility - Unify download link to lc.m1sk9.dev/download - Fix broken license badge with a static GPL-3.0 badge Co-Authored-By: Claude <noreply@anthropic.com>
-rw-r--r--README.ja.md64
-rw-r--r--README.md19
2 files changed, 77 insertions, 6 deletions
diff --git a/README.ja.md b/README.ja.md
new file mode 100644
index 0000000..518ab7e
--- /dev/null
+++ b/README.ja.md
@@ -0,0 +1,64 @@
+# LunaticChat
+
+[![CI](https://github.com/m1sk9/LunaticChat/actions/workflows/ci.yaml/badge.svg)](https://github.com/m1sk9/LunaticChat/actions/workflows/ci.yaml)
+[![Release](https://github.com/m1sk9/LunaticChat/actions/workflows/release.yaml/badge.svg)](https://github.com/m1sk9/LunaticChat/actions/workflows/release.yaml)
+[![GNU General Public License v3.0](https://img.shields.io/badge/license-GPL--3.0-9944ee)](https://github.com/m1sk9/LunaticChat/blob/main/LICENSE)
+![Modrinth Downloads](https://img.shields.io/modrinth/dt/MBeAdO4L)
+[![codecov](https://codecov.io/github/m1sk9/LunaticChat/graph/badge.svg?token=M3CJYTADYD)](https://codecov.io/github/m1sk9/LunaticChat)
+
+[English](./README.md)
+
+Paper・Folia・Velocity 向けの次世代チャットプラグイン.
+
+- [ドキュメント](https://lc.m1sk9.dev)
+- [API ドキュメント](https://lc.api.m1sk9.dev)
+
+```shell
+git clone git@github.com:m1sk9/LunaticChat.git
+cd LunaticChat
+
+./gradlew shadowJar
+```
+
+_[Supports Minecraft 26.1.2](https://ja.minecraft.wiki/w/Java_Edition_26.1.2) | [Requires Java 25+ and Gradle 9+](.github/CONTRIBUTING.md)_
+
+## インストール
+
+LunaticChat は以下のプラットフォームに対応しています.
+
+- Paper
+- Velocity
+- Folia
+
+ビルド済みのプラグインを [ダウンロードページ](https://lc.m1sk9.dev/download) から入手し,ファイルをサーバーの `plugins` フォルダに配置してサーバーを再起動してください.
+
+詳しくは [ドキュメント](https://lc.m1sk9.dev/docs/getting-started) を参照してください.
+
+> [!WARNING]
+> LunaticChat は Paper / Folia サーバーのみをサポートしています.Spigot および BungeeCord はサポートしておらず,今後サポートする予定もありません.Spigot 環境では [LunaChat の fork](https://github.com/f1w3/LunaChat) の利用を推奨します.
+
+## 機能
+
+- 1 対 1 のダイレクトメッセージ機能 (`/tell`,`/msg`)
+- クイックリプライ機能 (`/reply`)
+- ローマ字から日本語への変換
+- チャンネルチャット機能
+- マルチプラットフォーム対応 (Paper,Folia,Velocity)
+
+## Velocity 連携
+
+LunaticChat は Velocity プロキシ配下の複数の Paper / Folia サーバー間でグローバルチャットを中継できます.Velocity プロキシと各バックエンドサーバーの両方にプラグインを導入することで,サーバーをまたいだチャットが可能になります.
+
+Paper と Velocity の互換性は,プラグインのバージョンではなく内部の **プロトコルバージョン** のみで判定されます.プロトコルバージョンが非互換な Paper / Velocity ビルドはチャットの中継を拒否するため,両者は常に揃えて更新してください.
+
+対応する組み合わせや設定の詳細は [ドキュメント](https://lc.m1sk9.dev) を参照してください.
+
+## ライセンス
+
+LunaticChat は [GNU General Public License v3.0](./LICENSE) のもとで公開されています.
+
+<sub>
+ ® 2026 m1sk9
+ <br/>
+ LunaticChat は Mojang Studios または Microsoft とは関係ありません.
+</sub>
diff --git a/README.md b/README.md
index c2fe88f..d51e532 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,10 @@
# LunaticChat
+[日本語](./README.ja.md)
+
[![CI](https://github.com/m1sk9/LunaticChat/actions/workflows/ci.yaml/badge.svg)](https://github.com/m1sk9/LunaticChat/actions/workflows/ci.yaml)
[![Release](https://github.com/m1sk9/LunaticChat/actions/workflows/release.yaml/badge.svg)](https://github.com/m1sk9/LunaticChat/actions/workflows/release.yaml)
-[![GNU General Public License v3.0](https://img.shields.io/github/license/m1sk9/LunaticChat?color=%239944ee)](https://github.com/m1sk9/LunaticChat/blob/main/LICENSE)
+[![GNU General Public License v3.0](https://img.shields.io/badge/license-GPL--3.0-9944ee)](https://github.com/m1sk9/LunaticChat/blob/main/LICENSE)
![Modrinth Downloads](https://img.shields.io/modrinth/dt/MBeAdO4L)
[![codecov](https://codecov.io/github/m1sk9/LunaticChat/graph/badge.svg?token=M3CJYTADYD)](https://codecov.io/github/m1sk9/LunaticChat)
@@ -18,7 +20,7 @@ cd LunaticChat
./gradlew shadowJar
```
-_[Supports Minecraft 26.1](https://minecraft.wiki/w/Java_Edition_26.1) | [Requires Java 25+ and Gradle 9+](.github/CONTRIBUTING.md)_
+_[Supports Minecraft 26.1.2](https://minecraft.wiki/w/Java_Edition_26.1.2) | [Requires Java 25+ and Gradle 9+](.github/CONTRIBUTING.md)_
## Installation
@@ -28,10 +30,7 @@ LunaticChat is compatible with the following platforms:
- Velocity
- Folia
-Pre-built artifacts can be installed from the following locations. Place the downloaded plugin file in your server's `plugins` folder and restart the server.
-
-- [GitHub](https://github.com/m1sk9/LunaticChat/releases)
-- [Modrinth](https://modrinth.com/project/lunaticchat)
+Download the pre-built plugin from the [Download page](https://lc.m1sk9.dev/download), place the file in your server's `plugins` folder, and restart the server.
See the [Documentation](https://lc.m1sk9.dev/docs/getting-started).
@@ -46,6 +45,14 @@ See the [Documentation](https://lc.m1sk9.dev/docs/getting-started).
- Channel Chat System
- Multi-platform support (Paper, Folia, Velocity)
+## Velocity Integration
+
+LunaticChat can relay global chat across multiple Paper / Folia servers behind a Velocity proxy. Installing the plugin on both the Velocity proxy and each backend server lets players chat across servers.
+
+Paper–Velocity compatibility is determined solely by an internal **protocol version**, not by the plugin version. Paper and Velocity builds with incompatible protocol versions will refuse to relay chat, so keep both sides updated together.
+
+For supported combinations and setup details, see the [Documentation](https://lc.m1sk9.dev).
+
## License
LunaticChat is published under [GNU General Public License v3.0](./LICENSE).