Extensions:Plugins/Template

提供: wiki
移動先: 案内検索

Plugin Name

Script name
tooltip text
UI location Menu → Group → menu name
Version version - YYYY.MM.DD Author(s) Author name (AKA nickname)
Blender 2.XX, 2.XX* License GPL
Note(s) Additional information text.


Executable information
File name script_name.py
Python modules module1_name.py, module2_name.py
Data config files, etc


Links Link title at Blender Artists.


Source and Executables

Use above formats for local storing of scripts on BlenderWiki. Use current date "(YYYY.MM.DD)" in description. (current = upload time on blenderWiki)

Support


Manual


Plugin description

Explain what the script does, where the idea came from, what it is related to, why it is useful, etc.

Use the script's UI tooltip. We need to allow multi-line tips (popups) in Blender, the current limit is not enough and we end up with ugly long lines.

Usage

How to use the script

Shortcuts

List of shortcuts used by the script, if any. Mostly relevant for scripts with guis. We should of course standardize basic ones: ESC to cancel, ESC and q to quit, etc. Follow the rules in Meta/Templates.

Configuration

Config options available in the script's GUI or via the Scripts Config Editor.

option <option name>
type <return type>
default value <default value>
explanation <short explanation>

Notes

Usage notes, there is also a section for general notes at the end.

Miscellaneous Notes

Miscellaneous notes on the script.

Compatibility

Relevant for I/O scripts, note how complete they are in regards to the file format specification and/or compatibility with other programs that can read the same format.

Known Issues

What doesn't work but should.

Additional Information

Placeholder for additional information.

To-Do list

  • the first
  • the ..

Credits

Thanks go to:

  • Name (AKA nickname) for what...
  • Name ...

History

v1.00 - YYYY.MM.DD by Author_name
- add/fix
v0.99 - YYYY.MM.DD by Author_name
- add/fix