Skip to content
This repository has been archived by the owner on Jul 24, 2020. It is now read-only.

Plugin Layout

Kyle Martin edited this page Jun 7, 2017 · 2 revisions

A plugin can have whatever files and folders that it wants inside of its own master folder, which will have the same name as the plugin itself. This master folder will be placed in the "Plugins" folder in the main directory, and needs to contain a couple things (respectively replacing <pluginName>):

A file named "<pluginName>Types.h"

  • This file should list all types that the API needs to know about (ie, if you're using templated function calls to the API such as API.getAllOfType<Flower>(), then the API needs to know about the Flower type ahead of time and thereby needs to be in the <pluginName>Types.h file.
  • Note, this file could just include other .h files.

A file named "depend.txt"

  • This file needs to list all the source files that need to be compiled (for example, perhaps a "<pluginName>Types.cpp").

Finally, and this is not yet implemented, a plugin can have a "<pluginName>.cpp" that, if discovered, the compiler will offer to use as the main program.. This could be useful for overhauling the game to your desires, or for testing your own plugin.