はじめに
MoripaFishing の概要と、Core / Integration / Addon の 3 層構成を説明します。
このプラグインは、Minecraftサーバーで魚釣りを楽しむためのプラグインです。 主な機能として、ランダムな魚の釣り上げを提供します。
釣り大会などのイベント機能は、Addonとして提供されることを想定しています。
以下に記載する対応範囲は本プラグインで実装されるべき機能です。 しかし、アドオン側として対応すべきとしている機能については、実装を行うということではありません。
対応範囲
当プラグインで対応すべき部分
基本機能
- ワールドの管理
- 天候・時刻の決定と参照（ワールドへの実際の適用は Integration が担当します）
- 魚釣りの基本システム
- 表示文言の国際化（ロケールごとの翻訳ファイルによる切り替え）
魚関連
- 魚のサイズなどの記録
- 魚の種類とレアリティの管理
システム関連
- 釣り上げまでの速度変化のインターフェース提供
- 釣果のイベント通知（釣果の記録・集計はイベントを購読するアドオンで行います）
アドオン側で対応すべき部分
イベント関連
- 特別な魚のイベント
- 釣り大会の開催
システム拡張
- 魚の売却
- スキルシステム
- 釣りスポットのランキング
- 釣りスポットの設定
- 釣り関連の実績
- 釣り竿のカスタマイズ
- 釣り竿の強化システム
- 釣り上げまでの時間調整
- 魚釣りクエスト
MoripaFishing は Core / Integration / Addon の 3 層で構成されます。
- Core: 魚抽選・釣りイベントなどの最小機能を提供する本体プラグイン
- Integration: Core に必須依存し、Core が決めた値を Bukkit ワールドへ適用するプラグイン。導入したときにだけ適用が有効になります
- Addon: Core に依存して Core の API を使い機能を拡張するプラグイン
公式 Integration は次の 2 つです。
- WorldLifecycle: 時刻・ワールドボーダー・スポーンの適用、ジェネレーターによるワールドの作成・アンロード、参加時テレポート
- Weather: Core が決定した天候のワールドへの適用と、
CLOUDYにおけるクライアント側バリア天井の送信
Integration を導入しない限り、Core 単体ではワールドの実体を書き換えません。 Addon は外部プラグインとして開発できるほか、本リポジトリにも CatchAnnounce が同梱されています。
詳細は Integration とは を参照してください。
サポート
このプラグインは Paper (paper-plugin.yml) 専用です。Purpur など Paper 互換のサーバーでも動作しますが、Spigot には対応していません。
対応する Minecraft バージョンや Java、依存プラグインなどの動作要件は セットアップガイド を参照してください。
導入後の使い方は次のページに続きます。
- セットアップガイド: 導入手順と初期設定
- コマンド: ゲーム内から利用できるコマンドの一覧
- フォーマット: 魚・レアリティ・ワールドなどの定義ファイルの書式
注意
注意
現在MoripaFishingは開発中のため、 バージョンアップ等によって破壊的な仕様変更が行われる可能性があります。