Make module.yaml

NeoBotに制作したモジュールを読み込ませるにはmodule.yamlファイルをリソースフォルダに配置する必要があります。

name: "SampleModule"
version: 1.0.0
authors: [NAFU_at]
website: "https://toybox.nafuchoco.page/"
main: "page.nafuchoco.samplemodule.Main"
additionalIntents:
  - GUILD_VOICE_STATES
  - GUILD_MEMBERS

対応している項目と内容は以下の通りです。

項目名	必須	説明	設定例	備考
name	必須	モジュール名	name:SampleModule	モジュールのデータフォルダは、このname設定により決定されます。例 : ./modules/(name) モジュールのjarファイルのファイル名は、name設定と同一にすることが 推奨されます。例 : 'SampleModule.jar"
version	必須	バーション	version: 1.0.0	バージョン情報を記載してください。 Semantic Versioning 2.0.0の形式に準拠している必要があります。 モジュール情報として返されます。
description		説明	description: サンプル	モジュールが提供している機能の概要を記載してください。 モジュール情報として返されます。
authors		開発者名	authors: [NAFU_at, hoge]	開発者名を記載してください。 モジュール情報として返されます。
website		ウェブサイト	website: https://example.com	モジュール情報として返されます。
main	必須	メインクラス	main: com.example.sample.Main	NeoModuleクラスを拡張(extends)したモジュールのメインクラスを記載してください。 パッケージ名を含めた、メインクラスのフルネームで記載してください。 例えば、パッケージ名がcom.example.sample で、クラス名がMainなら、com.example.sample.Mainと記載してください。
dependency		依存モジュール	dependency: [HogeHoge, fugafuga]	自分のモジュールを起動するために必要となる、他のモジュールの一覧を記載します。 他モジュールの“name"設定名で、記載してください。 ここに設定されたモジュールが見つからない場合は、モジュールの起動でエラーになります。
loadBefore		先に起動すべきモジュール	loadBefore: [HogeHoge, fugafuga]	他モジュールの“name"設定名で、記載してください。 ここに記載されているモジュールが、自分のモジュールよりも後にロードされるようになります。 複数のモジュールがloadBefore設定で互いに依存していたとしても、モジュールを起動することができます。
requiredVersion		必須バージョン	required Version: 2.0.0	モジュールを起動するために必要となる、NeoBotCoreのバージョンを指定します。 Semantic Versioning 2.0.0の形式に準拠している必要があります。 プレリリースバージョンは判定しません。
additionalIntents		追加インテント	additionalIntents: [ GUILD_VOICE_STATES ]	モジュールが必要となる追加インテントを指定します。