Voxel Globe Plugins

Adding a new plugin

1. Add your app to ./external/voxel_globe_plugins, and don't forget an __init__.py file.
2. Run git submodule add external/voxel_globe_plugins/{app_name} to add the submodule
3. git config -f .gitmodules external/voxel_globe_plugins/{app_name}.update none

The update none is important, or else it will not be an optional submodule.

Enabling a plugin

Simply run

./plugins enable

and follow the prompts

Disabling a plugin

Simply run

./plugins disable

and follow the prompts

Plugin directory

All plugins exist in ./external/voxel_globe_plugins. These directories should mimic current Voxel Globe app directories. While Voxel Globe apps can reference these plugins, they should always be able to be imported without failure. For example:

try:
  import voxel_globe_plugin.my_awesome_plugin
except ImportError:
  pass