Initial commit

Author: haganbmj

.gitignore

@@ -0,0 +1,35 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+# https://docs.npmjs.com/misc/faq#should-i-check-my-node-modules-folder-into-git
+node_modules
+
+# IntelliJ
+.idea/
+*.ipr
+*.iws
+*.iml
+.idea_modules

Gruntfile.js

@@ -0,0 +1,41 @@
+module.exports = function(grunt) {
+  'use strict';
+
+  grunt.util.linefeed = '\n';
+  grunt.initConfig({
+    pkg: grunt.file.readJSON('package.json'),
+    banner: '/*!\n' +
+    ' * OBS WebSocket Javascript API (<%= pkg.name %>) v<%= pkg.version %>\n' +
+    ' * Author: <%= pkg.author %>\n' +
+    ' * Repo: <%= pkg.repository.url %>\n' +
+    ' */\n\n' +
+    '\'use strict\';\n\n',
+
+    jsdoc2md: {
+      docs: {
+        src: ['src/obs-source.js', 'src/obs-scene.js', 'src/obs-websocket.js', 'src/obs-events.js', 'src/obs-requests.js'],
+        dest: 'dist/DOCUMENTATION.md'
+      }
+    },
+    clean: {
+      dist: 'dist'
+    },
+    concat: {
+      options: {
+        banner: '<%= banner %>',
+        stripBanners: false
+      },
+      obswebsocket: {
+        // src: ['src/*.js'],
+        //dest: 'dist/<%= pkg.name %>.js'
+        src: ['src/obs-source.js', 'src/obs-scene.js', 'src/obs-websocket.js', 'src/obs-crypto.js', 'src/obs-events.js', 'src/obs-requests.js'],
+        dest: 'dist/obs-websocket.js'
+      }
+    }
+  });
+
+  require('load-grunt-tasks')(grunt, { scope: 'devDependencies' });
+
+  grunt.registerTask('build', ['clean:dist', 'concat']);
+  grunt.registerTask('default', ['build', 'jsdoc2md']);
+};

LICENSE.md

@@ -0,0 +1,22 @@
+
+The MIT License (MIT)
+
+Copyright (c) 2016 Brendan Hagan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,59 @@
+# obs-websocket-js
+OBSWebSocket.JS allows Javascript-based connections to [obs-websocket](https://github.com/Palakis/obs-websocket).  
+Based heavily on [obs-remote](https://github.com/nodecg/obs-remote-js), which is built for the older, obs-classic compatible plugin.
+
+# [API Documentation](dist/documentation.md)
+
+## Usage
+
+### Plain Javascript
+Include the distributable file in the header of your HTML.
+```html
+<script type='text/javascript' src='dist/obs-websocket.js'></script>
+```
+
+Then make use of it.
+```html
+<script>
+  var ws = new OBSWebSocket();
+
+  // Bind some listeners.
+  ws.onConnectionOpened = function() {
+    console.log('Connection Opened');
+
+    // Send some requests.
+    ws.getCurrentScene(function(message) {
+      console.log(message);
+    });
+  };
+
+  // Open the connection and Authenticate if needed. URL defaults to localhost:4444
+  ws.connect(); // ws.connect('url', 'password');
+</script>
+```
+
+
+### NodeJS
+```sh
+npm install obs-websocket-js --save
+```
+
+Add the library to your application.
+```js
+var OBSWebSocket = require('obs-websocket-js');
+var obsWS = new OBSWebSocket();
+
+obsWS.connect('url', 'password');
+```
+
+# Contributing
+- Install [node.js](http://nodejs.org).
+- Clone the repo.
+- Go nuts.
+- Generate the concatenated Javascript file and API documentation by running the following...
+```sh
+npm run build
+```
+
+## Formatting Guidelines
+- 2 spaces rather than tabs.