How to Create a Shuffler Plugin

Creating a Shuffler Plugin

Download the empty base plugin. (Right click and Save As to download the file)

Events

All methods are sent (1) a data table that can be used to maintain persistent information, even across reloads, and (2) a settings table that contains key-value pairs with settings names as keys and their associated values. Both of these tables are unique to the plugin, so collisions will not happen with other plugins, even if they use the same keys. All methods are optional and any methods that are unused can be safely deleted.

• function plugin.on_setup(data, settings)
  • called once when a shuffler session is started
• function plugin.on_frame(data, settings)
  • called once per frame
• function plugin.on_game_load(data, settings)
  • called when a new game is loaded
• function plugin.on_game_save(data, settings)
  • called when a shuffle is about to happen, before the current game is unloaded
• function plugin.on_complete(data, settings)
  • called when a game is marked as complete, before it is unloaded