Since 0.12.0, Haxegon has a simple plugin system to extend it’s functionality. Generally, you install a plugin by copying a single .hx file into your
plugins folder. If you do not have a
plugins folder, make sure you are using the latest blank Haxegon project template.
As of 0.12.0, there are three plugins for Haxegon:
- Layers: A simplified display list.
- Filters: A fullscreen post-processing shader plugin.
- imGui: A simple imgui library.
More plugins will be coming as we approach 1.0!
If you are interested in making your own Haxegon plugin, please read the following developer guidelines:
- Haxegon plugins should ideally be completely contained in a single .hx file.
- Haxegon plugins should ideally work for all current Haxegon targets (right now that’s Native, HTML5 and Flash).
- Haxegon plugins should ideally not require any external dependancies. If you are wrapping another library, consider embedding it, if possible.
- Part of Haxegon’s core design is to avoid creating unnecessary objects. Assets are handled with internal dictionaries, for example. Consider whether or not it makes sense for your plugin to take care of it’s own objects.
- Try not to expose any variables that the end user does not need to see. If you mark a class or variable as
privatein Haxe, you can still access it with your own class if you use Haxe’s “access metadata” feature. For example, to access private functions from
@:access(haxegon.Gfx)before the class you want to have access from.
These are all just guidelines, so feel free to break them where it makes sense.
Some technical details:
- All Haxegon plugins should have an
enablefunction which sets everything up. This function should be optional - all functions in our plugins start with the line
if (!enabled) enable();.
- If you include
@:access(haxegon.Core)before your plugin class, you will have access to some useful
- To tell Haxegon that your plugin is ready, you can call
- On that note, Haxegon and its plugins uses Semantic Versioning.
- You can check for a particular version of Haxegon with the
Core.checkrequirement("yourpluginname", "haxegon", "0.12.0");
- You can also use this to check for the presence of other plugins that you might depend on:
Core.checkrequirement("yourpluginname", "layers", "0.1.0");
- You can tell Haxegon to run a function at the start of every frame with the function
Core.extend_startframe(prepareplugin);. This will call the function
prepareplugin()in your class.
- Similarly, there is also
- If it doubt, check out the source code for the Layers filter for reference.
- If you have questions about any of this, feel free to ask! We are happy to help!