File tree 1 file changed +15
-8
lines changed
1 file changed +15
-8
lines changed Original file line number Diff line number Diff line change 1
1
2
2
var plugin = module . exports = { } ;
3
3
4
+ // Do we need this? Are there other plugin-y config things?
4
5
plugin . config = {
5
6
platform : 'rpi'
6
7
} ;
7
8
8
- plugin . formats = [ {
9
- "name" : "Shader (glslViewer)" ,
10
- "download" : true ,
11
- "start_command" : "glslViewer $filename" ,
12
- "end_command" : "sudo pkill glslViewer" ,
13
- "category" : "shader"
14
- } ] ;
9
+ // OPTIONAL - an array of Format objects
10
+ //
11
+ // TODO - how will these get handled in terms of adding artwork?
12
+ plugin . formats = [ ] ;
15
13
14
+ // TODO - Do we want this? Or can we rely on the deps from package.json?
16
15
plugin . dependencies = {
17
16
// "openframe-gpio": "git+https://git@github.com/OpenframeProject/Openframe-PluginExample.git"
18
17
} ;
19
18
20
- // Must return a Promise that resolves on successful intialization
19
+ /**
20
+ * Plugin initialization method.
21
+ *
22
+ * Called when the plugin (and its dependencies) have been installed.
23
+ *
24
+ * TODO: This will likely get passed a sandboxed API object rather than the full frame controller...
25
+ *
26
+ * @param {object } fc A reference to the frame controller
27
+ */
21
28
plugin . init = function ( fc ) {
22
29
// do your plugin thing
23
30
console . log ( '=======> PluginExample initialized! <=======' ) ;
You can’t perform that action at this time.
0 commit comments