mirror of
https://github.com/maubot/maubot
synced 2025-08-29 20:10:39 +00:00
Add full example plugin
Also switch to yaml plugin metadata in example file (ref #33)
This commit is contained in:
parent
5704b3e53b
commit
55685dfd6e
4 changed files with 64 additions and 9 deletions
37
example-plugin/maubot.yaml
Normal file
37
example-plugin/maubot.yaml
Normal file
|
@ -0,0 +1,37 @@
|
|||
# This is an example maubot plugin definition file.
|
||||
# All plugins must include a file like this named "maubot.yaml" in their root directory.
|
||||
|
||||
# The unique ID for the plugin. Java package naming style. (i.e. use your own domain, not xyz.maubot)
|
||||
id: xyz.maubot.example
|
||||
|
||||
# A PEP 440 compliant version string.
|
||||
version: 1.0.0
|
||||
|
||||
# The SPDX license identifier for the plugin. https://spdx.org/licenses/
|
||||
# Optional, assumes all rights reserved if omitted.
|
||||
license: MIT
|
||||
|
||||
# The list of modules to load from the plugin archive.
|
||||
# Modules can be directories with an __init__.py file or simply python files.
|
||||
# Submodules that are imported by modules listed here don't need to be listed separately.
|
||||
# However, top-level modules must always be listed even if they're imported by other modules.
|
||||
modules:
|
||||
- helloworld
|
||||
|
||||
# The main class of the plugin. Format: module/Class
|
||||
# If `module` is omitted, will default to last module specified in the module list.
|
||||
# Even if `module` is not omitted here, it must be included in the modules list.
|
||||
# The main class must extend maubot.Plugin
|
||||
main_class: HelloWorldBot
|
||||
|
||||
# Extra files that the upcoming build tool should include in the mbp file.
|
||||
#extra_files:
|
||||
#- base-config.yaml
|
||||
#- LICENSE
|
||||
|
||||
# List of dependencies
|
||||
#dependencies:
|
||||
#- foo
|
||||
|
||||
#soft_dependencies:
|
||||
#- bar>=0.1
|
Loading…
Add table
Add a link
Reference in a new issue