Musikcube

In order to use Musikcube configure it to accept websocket connections in server setup:

• Enable the Metadata Server
• Set a Password

Both of these settings are found in Musikcube -> (s)ettings -> server setup

The URL used by MS has the syntax:

[ws|wss]://HOST:[PORT]

The port is the same as shown in the server setup screenshot from above, under metadata server enabled. If no port is provided to MS it will default to 7905.

If no URL is provided to MS it will try to use ws://localhost:7905

Configuration

ENV

Configuration Type

This is configuration for the ENV Config Type.

Environmental Variable	Type	Default	Description
MC_ID	string		A globally unique ID EX myComponentId
MC_NAME	string	Value of MC_ID	A vanity name EX My Cool Component
MC_ENABLE	boolean	true	Should this component be used?
MC_URL	string	ws://localhost:7905	URL of the Musikcube Websocket (Metadata) server to connect to
MC_PASSWORD	string		Password set in Musikcube https://github.com/clangen/musikcube/wiki/remote-api-documentation

Bold/Italic = Required

File

Config Structure

This displays the structure of the File Configuration for a musikcube type Source with all possible properties, their shape, and descriptions/types. Use this to understand how to write a valid config.

Config Example

This displays an example config file of a musikcube Source File Configuration that adheres to the shown Config Structure.

• text mode lets you edit the JSON directly.
• tree mode gives you a guided point-and-click editing experience that always keeps the JSON syntax valid.

Both modes validate that the configuration is correct. Any errors show up as squiggly lines.

Important

Only source musikcube configs will validate correctly in the editor but both source and client musikcube configs are allowed in the real CONFIG/musikcube.json

After you finish editing, switch to text and then copy all text to get a completed config.

Config Example Mobile Experience

This displays an example config file of a musikcube Source File Configuration that adheres to the shown Config Structure.

The example config file editor is meant for a larger screen experience so only the read-only example is shown. Please use this site on a tablet/laptop/desktop to enable file editor features.

CONFIG/musikcube.json

[
  {
    "id": "myMusikcube",
    "name": "Desktop",
    "data": {
      "password": "MY_PASSWORD",
      "url": "ws://localhost:7905"
    },
    "enable": true
  }
]

AIO

Config Structure

This displays the structure of the all-in-one (config.json) configuration with all possible properties, their shape, and descriptions/types. Use this to understand how to write a valid config.

Select the musikcube type from the respective sources node below, then expand it.

Config Example

This displays an example config file of a all-in-one (config.json) configuration that includes a musikcube Source that adheres to the shown Config Structure.

• text mode lets you edit the JSON directly.
• tree mode gives you a guided point-and-click editing experience that always keeps the JSON syntax valid.

Both modes validate that the configuraion is correct. Any errors show up as squiggly lines.

After you finish editing, switch to text and then copy all text to get a completed config.

Config Example Mobile Experience

This displays an example config file of a all-in-one (config.json) configuration that includes a musikcube Source that adheres to the shown Config Structure.

The example config file editor is meant for a larger screen experience so only the read-only example is shown. Please use this site on a tablet/laptop/desktop to enable file editor features.

CONFIG/config.json

{
  "sources": [
    {
      "type": "musikcube",
      "id": "myMusikcube",
      "name": "Desktop",
      "data": {
        "password": "MY_PASSWORD",
        "url": "ws://localhost:7905"
      },
      "enable": true
    }
  ]
}