https://github.com/necnion8/craftswitcher-2
Minecraft Javaサーバー 操作管理システム
https://github.com/necnion8/craftswitcher-2
craftswitcher discord-bot discord-py dncore dncore-plugin python3
Last synced: 2 months ago
JSON representation
Minecraft Javaサーバー 操作管理システム
- Host: GitHub
- URL: https://github.com/necnion8/craftswitcher-2
- Owner: Necnion8
- Created: 2024-08-12T08:47:27.000Z (10 months ago)
- Default Branch: develop
- Last Pushed: 2025-01-11T06:32:41.000Z (5 months ago)
- Last Synced: 2025-03-18T22:27:19.428Z (3 months ago)
- Topics: craftswitcher, discord-bot, discord-py, dncore, dncore-plugin, python3
- Language: Python
- Homepage:
- Size: 6.99 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
---
## 開発中
- [x] DNC6プラグイン化
- [x] サーバープロセスの操作ラッパー
- [x] REST API + WebSocketイベント
- [x] ファイル管理
- [x] アーカイブファイルの対応
- [x] サーバーのインストール
- [x] バックアップ機能
- [ ] スケジューラ機能
- [ ] データベース
- [ ] タスク
- [ ] 細かいとこ
- [ ] サーバー内連携モジュール
- [x] 旧版の連携機能を一時的に移植実装
- [ ] v2 連携機能の実装と旧版実装を削除
- [ ] Discordコマンド
- [ ] リリース！
---
## 主な機能
- すぐできる導入
- [Webフロントエンド](https://github.com/Myoko1110/CraftSwitcher2-Client) (Myoko1110さん ありがとう！😆)
- ファイル操作
- パフォーマンスモニター
- スナップショットとバックアップ
- スケジュール再起動
- サーバー連携API
- サーバー本体のダウンロードとビルドツール
- 操作用 Discord ボット (オプション)
- [DNC6](https://github.com/Necnion8/dnCoreV6)プラグイン拡張機能
## 環境
- Python 3.10
- Linux (推奨)
- Windows
※ macOSは未確認。おそらく動作？
## 対応サーバー
| サーバー | 基本操作 | 鯖内連携※2 | ダウンロード | 開発元 |
|:-------------------|:----:|:-----------------:|:-----------------------------------------:|:------------------------------------------------------------------:|
| Vanilla | 〇 | ✕ | 〇 | [Minecraft](https://www.minecraft.net/ja-jp/download/server) |
| Spigot | 〇 | 1.8 ~ 1.17 | 〇※1 | [SpigotMC](https://www.spigotmc.org/wiki/buildtools/) |
| Paper | 〇 | 1.8 ~ 1.17 | 〇 | [PaperMC](https://papermc.io/software/paper) |
| Purpur | 〇 | 1.8 ~ 1.17 | 〇 | [PurpurMC](https://purpurmc.org/) |
| Folia | 〇 | ✕ | 〇 | [PaperMC](https://papermc.io/software/folia) |
| SpongeVanilla | 〇 | ✕ | 〇 | [SpongePowered](https://spongepowered.org/downloads/spongevanilla) |
| # ***mod*** |
| Forge | 〇 | ✕ | 〇※1 | [Minecraft Forge](https://files.minecraftforge.net/) |
| Mohist | 〇 | ✕ | 〇 | [MohistMC](https://mohistmc.com/software/mohist) |
| NeoForge | 〇 | ✕ | 〇※1 | [NeoForged](https://neoforged.net/) |
| Youer※3 | ? | ✕ | ? | [MohistMC](https://mohistmc.com/software/youer) |
| Fabric | 〇 | ✕ | 〇 | [FabricMC](https://fabricmc.net/) |
| Quilt | 〇 | ✕ | 〇※1 | [QuiltMC](https://quiltmc.org/) |
| Banner | 〇 | ✕ | 〇 | [MohistMC](https://mohistmc.com/software/banner) |
| # ***proxy*** |
| BungeeCord | 〇 | 〇 | 〇 | [SpigotMC](https://www.spigotmc.org/wiki/bungeecord/) |
| Waterfall | 〇 | 〇 | 〇 | [PaperMC](https://papermc.io/software/waterfall) |
| Velocity | 〇 | ✕ | 〇 | [PaperMC](https://papermc.io/software/velocity) |
※1ビルドが必要ですが、自動でセットアップします
※2[旧版連携モジュール](https://github.com/Necnion8/CraftSwitcher-ReportModule)で仮対応
※3正式リリースされてないため未確認
## 導入と起動
```bash
# Install
python3 -m pip install -r requirements.txt
# Launch
python3 -m dncore
```
初回の起動時に以下のファイルが生成されます。
- `./config/config.yml` - dnCore設定
- `./plugins/CraftSwitcher/config.yml` - メイン設定
### Discord
Discord機能を利用しない場合は[無効にする方法](https://github.com/Necnion8/dnCoreV6/wiki/No-Connect-Discord)を参照ください。
### REST API
REST API は初期設定で [`http://0.0.0.0:8080/docs`](http://localhost:8080/docs) に公開されています。
## WebSocket
WebSocket クライアントを `http://0.0.0.0:8080/api/ws` に接続することで、サーバーイベント等を JSON フォーマットで受信できます。
### WS 受信
> [craftswitcher.py](dncore%2Fextensions%2Fcraftswitcher%2Fcraftswitcher.py)
> `# events ws broadcast` このコメント行の以下に実装があります
### WS 送信
> サーバープロセスへのテキストの書き込み
> ```json
> {
> "type": "server_process_write",
> "server": "lobby",
> "data": "say Hello\r\n"
> }
> ```
