参加勢向け開発ルール¶

概要¶

プラグインやMODを作成する際のルールです
プラグインやMODはみんなの遊んでいるサーバーの挙動を改変し影響を与える技術です
以下の事柄が守れる方の成果物のみサーバにデプロイします

基本ルール¶

1. 単発企画用の物を作成してください。(hub鯖、攻城戦鯖、サバイバル企画などの重要な長期鯖に導入するものは避けてください)
2. Util系、長期運用を想定する物は避けてください。
3. 鯖準備は、バグ確認・動作確認を自分で責任をもって終えてからお願いしてください。
4. 開発前に企画の簡単な内容だけ教えてもらえると、Labで開発済みの物や開発被りを避けることができます
5. 開発やバグの原因特定は自分で行ってください

Labにデプロイ依頼するまでに準備しておくこと¶

1. 成果物は必ずGitHubにリポジトリを作り、jarファイル等導入に必要なファイルをすべてリリースに上げてください
2. 適切なLICENSEファイルを配置してください。(特にこだわりがなければMIT、ただしPaperプラグインの場合はGNUである必要がある)
3. READMEに仕様、操作方法、コンフィグ系の説明等を詳細に記述してください。(MarkDown記法を使い、見やすくしてください)
   (参考: http://redmine.lab.kunmc.net/redmine/projects/sanka-kids/wiki/%E4%BA%BA%E7%8B%BC%E3%83%97%E3%83%A9%E3%82%B0%E3%82%A4%E3%83%B3)
4. リポジトリのissueに後述のテスト仕様書を記載してください。

コマンド実装時に守ってほしいこと¶

1. コマンドの入力に対して適切なフィードバックを送信者または全体に表示すること
2. 適切なTab補完を実装すること

テスト仕様書の例¶

以下の例を参考にテスト仕様書を作成し、すべての項目に問題がないことをチェックしたうえで提出してください。
下記はあくまで例です。
テストケースの粒度は任せますが実際のユースケースに基づいたテストシナリオを作ってください。
特にゲーム系のプラグインは予期しないサーバーダウン時に状態を復旧できることを確認することを推奨します。

例) 正常系シナリオ１ 通常実行

1. /hoge start を入力じゲームを実行する
2. 〇○であることを確認
3. ××が表示されていることを確認
4. /hoge stop を 確認
5. 〇○でにないことを確認
6. ××が表示されていないことを確認
7. △△が出来なくなっていることを確認

例) 異常系シナリオ1 予期しないサーバーダウン

1. /hoge start を入力じゲームを実行する
2. コンソールからサーバーを再起動
3. 状態を保持していることを確認