cables DocumentationHow To UseWorking with filesKeyboard ShortcutsUser Interface WalkthroughBeginner TutorialBeginner 1: Drawing A CircleBeginner 2: TransformationsBeginner 3: ColorMore TransformationsIntermediateImage CompositionsPost-Processing 3D ScenesExporting And EmbeddingHow to serve files externally and fix CORS headersExporting PatchesExport using the cables command line interfaceExport via IframeExport creating a standalone executableExport to github (pages)Export and deploy to netlifyExport full PatchExport a ZIP fileExternal triggers / functionsUsing variablesPreviewing / uploading exported cables patchesExamples for EmbeddingPermissionsUsersPatchesTeamsOpsMultiplayerPatchlistsCoding OpsCreating AttachmentsGeneral op/Port CallbacksPortsMultiPortsArray PortsBoolean portsInteger Number PortsObject PortsString portsTrigger PortsFloating Point Number PortsGUI/UI attributesHello Op - Part 1LibrariesDeveloping OpsRenaming / Creating a new versionCreating Viz OpsGuidelinesObject PortsPatching Ops / SubPatchOpsWriting ShadersWeb Audio Op DevelopmentDeveloping CablesRepositoriesSet up local environmentScriptsHow to work with forksGenerated DocumentationUsing standalone to develop cablesCables StandaloneGeneralCoding OpsSharing opsUsing NPMImport/ExportStandalone - FAQLightingLightsShadowsWorking With AudioBasic Audio SetupWorking with EffectsReal-Time Audio Analyzation & Audio VisualizationOffline Audio Visualization & AnalyzationCommunicationcables APIOptimizing Performance In PatchesTools for debugging your patchHow to optimize cables patches with the Performance opHow to optimize cables patches with the ProfilerCommon pitfalls with the "usual suspects"Optimizing arraysDebugging Shaders with ShaderInfoFAQAudio in web browsersHow to make demoscene demos with cables.glEmbeddingHow to integrate my cables patch into my CMS (webflow/wix/squarespace/...)?How to remove grey rectangles on touch (mobile)?Why doesn't the DownloadTexture op work on iOS?How to disable page scrolling on mobile?Mobile tippsHow to run exported patches on your local machineTransparent CanvasFeatures and SupportHow to contribute code to cablesWill there be support for (animated) GIFs?Can i use a website as a texture?Screenshots and Video recordingHow to report a bug in cablesHow can I share a patch to get help?How can I support cables?Video playback in cablesGeneral questionsWhat is dev.cables.glHTML And CSS In CablesJavascript Frameworkscordova / phonegapelectronreactvuejsLicenses and paymentWhat license do i need to use cables?Will I have to pay for it in the future?How is my work licensed when using cables?Does cables support midi and OSC?Patch PermissionsMy User Profile & Social MediaShadertoyCables at schools and universitiesTechnical questionsWebGL1 and WebGL2
cables Documentation  ⟩  Developing Cables  ⟩  Set up local environment

Set up local environment

This quick start will install the cables dev environment for you, and all that is needed to start making changes to cables. The setup relies on the bash shell, which should be present on osx and linux, and we will install it on windows. You should be somewhat familiar with working with nodejs, but we will guide you as much as possible.

In these steps we will clone the cables default repositories, once that is done, you can start working with your fork, if you created one.

The scripts included in these steps and this repository are described in a separate document.

But let's get started:

Mac/Linux

  • install git
  • clone the cables dev repository: git clone git@github.com:cables-gl/cables_dev.git
  • change into the checked out directory (cd cables_dev/)
  • continue below

Windows 10/11

  • install and start Visual Studio Code
  • install git (Ctrl-Shift-G, Download Git for Windows), download, install (make sure to install Git Bash as well), restart Visual Studio Code
  • clone this repository from GitHub (Ctrl-Shift-G, Clone Repository, Clone from GitHub)
  • open new terminal (Ctrl-Shift-` ), make sure it's Git Bash, not PowerShell
  • make sure you have a profile file for your shell touch ~/.bash_profile
  • continue below

Common

  • install Node Version Manager
  • close and reopen your terminal, make sure nvm is installed properly, nvm --version should output some version number
  • run ./install_local.sh (if you prefer https over public-key auth, run ./install_local.sh https)
    • this will:
      • install the required node version (and set it as default in nvm)
      • check out all needed repositories into subdirectories
      • npm install all dependencies
      • npm run build in all repositories
  • IMPORTANT: make sure your current shell has the proper node version by running node --version before the next step
    • if not, open a new terminal before you start the server, and check again
  • change directory to cables_electron/

Start Cables Standalone

  • change to the electron/standalone directory cd cables_electron
  • enter npm run start to start cables electron!

Next steps

Found a problem? Edit this file on github and contribute to cables!