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 CallbacksPortsDynamic PortsArray 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  ⟩  Using standalone to develop cables

Using standalone to develop cables

Set Up

  • the preferred way of developing cables locally is using the cables_dev repository: https://github.com/cables-gl/cables_dev
  • that repo contains scripts that will set up everything for you to get started
  • Read up about setting up everything for you to start contributing to cables in the section on how to "Set up local environment" of the official cables documentation.

Build / Dev

Once the above steps are done, continue below, deciding beforehand if you want to improve your local version of cables standalone, develop on cables core or editor, or would like to build and package a finished executable.

Local Build

  • set up your local environment (see above)
  • change to cables_electron directory (cd cables_electron)
  • run npm install --no-save
  • run npm run build to build the standalone version
  • run npm run start to start the standalone from the checked out sources

Local Development

  • set up your local environment (see above)
  • change to cables_electron directory (cd cables_electron)
  • run npm install --no-save
  • run npm run build
  • use npm run start to start the app
    • this will start watchers for changes in client-side javascript dirs (e.g. src_client and ../shared/client/
    • when making changes to files in these directories, a reload of the electron app is enough to see the changes (Cmd/Ctrl+R)
  • if you want to develop on ops and/or the ui, change to cables_dev (cd ..) and run npm run watch:standalone
    • this will create watchers on files in cables and cables_ui that trigger a rebuild on change
    • when making changes to files in these directories, a reload of the electron app is enough to see the changes (Cmd/Ctrl+R)

Building an executable

  • take the steps that are described in "Local Build" above
  • use npm run pack or npm run dist (will try to sign the exe) - add :mac, :win, :linux to only build one architecture
  • find the executable in dist/
Found a problem? Edit this file on github and contribute to cables!