diff --git a/.gitignore b/.gitignore index 55d26a7..9445b57 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,4 @@ /oscServer/node_modules +/node_modules +.release-it.json diff --git a/README.md b/README.md index 95f7ac8..b2a326e 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,23 @@ This is a helper library that allows generative art project to provide a UI to p OP Configurator communicates with the UI elements via postMessage() in browsers. This also allows configurator to be implemented across frames, making it suitable for use with iframes in code editors. Library can also be overridden to use the same mapping to other interfaces, such as physical buttons, knobs, sliders, etc. -OPC also supports OSC [Open Sound Control](https://en.wikipedia.org/wiki/Open_Sound_Control) protocol and can connect to a websocket server to send/receive OSC data. See [OSC Support](#osc). +OPC also supports OSC [Open Sound Control](https://en.wikipedia.org/wiki/Open_Sound_Control) protocol and can connect to a websocket server to send/receive OSC data. See [OSC Support](#osc-support). + +## Installation +On OpenProcessing, just toggle on the "OP Configurator 3000" in the default libraries list. On an HTML project, you can manually load it as below: +```html + +``` +This will automatically enable the OPC interface on OpenProcessing. + +If you are creating a project outside of OpenProcessing, you can also use example client files to create a similar basic interface on your HTML document. (Check out [example/index.html](https://github.com/msawired/OPC/blob/master/example/index.html)) +```html + + +``` + +Remember to replace the "latest" in the URLs above with the most recent release version to prevent future updates break your project. + ## Example diff --git a/example/index.html b/example/index.html index 6554b3e..b9c3530 100644 --- a/example/index.html +++ b/example/index.html @@ -2,10 +2,10 @@
- + - + diff --git a/opc-client.css b/opc_client.css similarity index 100% rename from opc-client.css rename to opc_client.css diff --git a/opc-client.js b/opc_client.js similarity index 100% rename from opc-client.js rename to opc_client.js diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000..672cfe6 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,13 @@ +{ + "name": "op-configurator", + "version": "0.5.2", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "op-configurator", + "version": "0.5.2", + "license": "MIT" + } + } +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..1e2e157 --- /dev/null +++ b/package.json @@ -0,0 +1,27 @@ +{ + "name": "op-configurator", + "version": "0.5.2", + "description": "A parameter controller allowing easy creation of dynamic variables that can be controlled with standard UI (HTML form elements).", + "main": "opc.js", + "directories": { + "example": "example" + }, + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/msawired/OPC.git" + }, + "keywords": [ + "p5js", + "openprocessing", + "generative" + ], + "author": "https://github.com/msawired", + "license": "MIT", + "bugs": { + "url": "https://github.com/msawired/OPC/issues" + }, + "homepage": "https://github.com/msawired/OPC#readme" +}