From 8e9c88ada8e4ec4e9f625ccccd006506acefcd1a Mon Sep 17 00:00:00 2001 From: IrosTheBeggar Date: Mon, 27 Feb 2017 01:57:35 -0500 Subject: [PATCH] Remove outadted docs --- docs/SKININNG.md | 103 --------------------------- docs/exampleJSON/allOptions.json | 28 -------- docs/exampleJSON/exampleNewJSON.json | 56 --------------- docs/exampleJSON/remote.json | 1 - docs/exampleJSON/skeleton.json | 4 -- 5 files changed, 192 deletions(-) delete mode 100644 docs/SKININNG.md delete mode 100644 docs/exampleJSON/allOptions.json delete mode 100644 docs/exampleJSON/exampleNewJSON.json delete mode 100644 docs/exampleJSON/remote.json delete mode 100644 docs/exampleJSON/skeleton.json diff --git a/docs/SKININNG.md b/docs/SKININNG.md deleted file mode 100644 index 8801729..0000000 --- a/docs/SKININNG.md +++ /dev/null @@ -1,103 +0,0 @@ -## Skinning - -#### Step 1: Download and Setup the Stack -- mstream.player.js and mstream.api.js -- VueJS -- Sortable JS & Vue Draggable -- Aurora and Flac JS -- Howler JS - - -There's a lot in that stack: -- mstream.player.js creates a global MSTREAM module that contains a fully functional media player and playlist - - Howler, Aurora, and Flac JS are all dependencies of mstream.player.js - - You can read the API for this module here: ['TODO: PUT URL HERE'] -- mstream.api.js creates a global MSTREAMAPI module that is used to manage and query mStream servers -- VueJS is what we will use to bind the MSTREAM module the HTML -- SortableJS and Vue Draggable add drag and drop functionality to the playlist - - -Now make an html file with the following -``` - - - - - - - - - - - - - - - - - - - - - -``` - - -#### Step 2: Make a Playlist -Add the playlist HTML -``` - -
- -
-
- -
-``` - -There's a lot going on here. The draggable element is used by Sortable JS to make a the list inside it have drag and drop capability. The rest of the bizare syntax is used by VueJS - -``` -// Highlight currently playing song -Vue.component('playlist-item', { - template: '\ -
\ - {{ text }} X
\ - \ - ', - props: ['text', 'active', 'index', 'current', 'drag'], - data: function(){ - return { - active2: MSTREAM.positionCache, - index2: this.index, - } - }, - methods: { - goToSong: function(event){ - MSTREAM.goToSongAtPosition(this.index); - }, - removeSong: function(event){ - MSTREAM.removeSongAtPosition(this.index, false); - } - } -}); - -// Code to update playlist -var playlistElement = new Vue({ - el: '#playlist', - data: { - playlist: MSTREAM.playlist, - current: MSTREAM.positionCache, - }, - methods: { - checkMove: function (event) { - MSTREAM.resetPositionCache(); - } - } -}); - -``` diff --git a/docs/exampleJSON/allOptions.json b/docs/exampleJSON/allOptions.json deleted file mode 100644 index 518a7d3..0000000 --- a/docs/exampleJSON/allOptions.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "port":3031, - "users":{ - "paul":{ - "password":"glassjar98", - "email":"paul@wall.com", - "musicDir":"/path/to/music", - }, - "paul2":{ - "password":"glassjar98", - "email":"paul@wall2.com", - "musicDir":"/path/to/music2", - }, - "paul2-guest":{ - "password":"glassjar98", - "guestTo":"paul2", - } - }, - "userinterface":"public", - "database_plugin":{ - "type":"sqlite", - "dbPath":"/path/to/db", - }, - "tunnel":{ - "refreshInterval":10000, - "protocol":"upnp" - } -} diff --git a/docs/exampleJSON/exampleNewJSON.json b/docs/exampleJSON/exampleNewJSON.json deleted file mode 100644 index 02fa797..0000000 --- a/docs/exampleJSON/exampleNewJSON.json +++ /dev/null @@ -1,56 +0,0 @@ -{ - "port":3031, - "users":{ - "paul":{ - "password":"glassjar98", - "email":"paul@wall.com", - "musicDir":"/path/to/music", - "privateDBOptions":{ - "privateDB":"BEETS", - "importDB":"path/to/sqlite3.db", - "beetsCommand":"Run This Command Update Call", - "quickSync": true, - }, - "bannedGuestFunctions":"todo. make this optional", - "vPath":"UUID-GOES-HERE" - }, - "paul2":{ - "password":"glassjar98", - "email":"paul@wall2.com", - "musicDir":"/path/to/music2", - }, - "paul2-guest":{ - "password":"glassjar98", - "guestTo":"paul2", - } - }, - "userinterface":"public", - "database_plugin":{ - "type":"sqlite", - "dbPath":"/path/to/db", - }, - "database_plugin-BEETS":{ - "type":"beets", - "dbPath":"/path/to/db", - "beetsCommand":"" - }, - "database_plugin-MYSQL":{ - "type":"mysql", - "username":"lol", - "password":"lol", - "db-name":"lolDB" - }, - "database_plugin-LOKI":{ - "comming":"soon", - }, - "secret":"Secret for JSON web token", - "tunnel":{ - "gateway":"1.1.1.1", - "refreshInterval":10000, - "protocol":"upnp" - }, - "salt":"Salt for passwords. optional. Necessarry forthe noHash function which allows hashed passwords to be stored in users array", - "noHash":true, - "ssl":"SSL OPTIONS" - -} diff --git a/docs/exampleJSON/remote.json b/docs/exampleJSON/remote.json deleted file mode 100644 index a0aa28d..0000000 --- a/docs/exampleJSON/remote.json +++ /dev/null @@ -1 +0,0 @@ -"{'code':55414, "command":{"action":"next"}}" diff --git a/docs/exampleJSON/skeleton.json b/docs/exampleJSON/skeleton.json deleted file mode 100644 index 17b8c65..0000000 --- a/docs/exampleJSON/skeleton.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "port":5060, - "userinterface":"public", -}