Skip to content

xcape-io/PySkeletonPlugin

Repository files navigation

PySkeletonPlugin

Plugin to quickly create a plugin for xcape.io Room.

Smiley face Discontinued, prefer PyRoomPlugin in PyPropControl library

In the area of ​​Escape Room creation, we need to code quickly and reliably, and we need to streamline and reuse our code.

With this plugin skeleton you can write a plugin for xcape.io Room software in minutes.

To write your very first Room plugin, we recommend you follow the Plugin tutorial in the Room manual.

Installation

Create your new plugin folder in you room Plugins folder, example for a plugin we want named as Echo :

C:\Users\jm_de\Documents\Xcape\Room\My room\Room\Plugins\PyEchoPlugin

Download PySkeletonPlugin-master.zip from this GitHub repository and unflate it in your plugin folder (not in PySkeletonPlugin-master folder).

Run install.bat with a double-click to create the Python virtual environment (venv).

Run test.bat to test you new Echo plugin.

You are now ready to hack a new plugin :

Author

Faure Systems (Mar 17th, 2020)