cables DocumentationHow To UseWorking with filesKeyboard ShortcutsUser Interface WalkthroughBeginner TutorialBeginner 1: Drawing A CircleBeginner 2: TransformationsBeginner 3: ColorMore TransformationsIntermediateImage CompositionsPost-Processing 3D ScenesCommunicationcables APIExporting 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 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 DevelopmentHTML And CSS In CablesLightingLightsShadowsWorking With AudioBasic Audio SetupWorking with EffectsReal-Time Audio Analyzation & Audio VisualizationOffline Audio Visualization & AnalyzationOptimizing 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.glJavascript 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 WebGL2cables DocumentationHow To UseWorking with filesKeyboard ShortcutsUser Interface WalkthroughBeginner TutorialBeginner 1: Drawing A CircleBeginner 2: TransformationsBeginner 3: ColorMore TransformationsIntermediateImage CompositionsPost-Processing 3D ScenesCommunicationcables APIExporting 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 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 DevelopmentHTML And CSS In CablesLightingLightsShadowsWorking With AudioBasic Audio SetupWorking with EffectsReal-Time Audio Analyzation & Audio VisualizationOffline Audio Visualization & AnalyzationOptimizing 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.glJavascript 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  ⟩  Coding Ops  ⟩  Renaming / Creating a new version

Renaming / Creating a new version

In cables all ops are sorted into namespaces that make up the first part of any op's name (i.e. Ops.Gl.MainLoop lives in the Ops.Gl. namespace).
There are a few special namespaces that are bound to permission or op visibility To move ops around or to create a new version, rename them.

Renaming ops

Button

You can access the op rename page via the op page ("view documentation" from the editor). If you have the proper permissions,
you will see a "manage op" section a bit down the page and a "rename" button. This will take you to a page with a form that
will guide you through the renaming process.

Renaming any op will update ALL the patches using that op to the new name (exceptions, see below).
There can be no two ops with the same name in the same namespace, there should be no "gap" in version numbers, there
are a few rules about valid opnames. The rename form should help with all of these constraints.

There are a few special namespaces, see their use:

Permission namespaces

  • Ops starting with Ops.Patch. are ...ops, check here for implications
  • Ops starting with Ops.User. are ...ops, check here for implications
  • Ops starting with Ops.Team. are ...ops, check here for implications
  • Ops starting with Ops.Extension. are ...ops, check here for implications
    • renaming and op into an extension op will COPY the code, NOT update existing projects and make the op READ ONLY

Special namespaces

  • Any op that has .Dev. as any part of it's namespace will only be usable on https://dev.cables.gl
  • Any op that has .Deprecated. as any part of it's namespace will not be visible in new patches and show a warning in old ones

Creating a new version

If you do not want to improve any of your ops but fear an update might not be backwards compatible, cables offers an easy
way to create a new version.

The op's version is kept in the name of the op: Ops.Gl.Texture_v2 is a newer version of Ops.Gl.Texture. Whenever
cables sees that old versions of ops are used, it will show a hint and offer an update mechanism in the editor. Old versions
of ops will also not appear in the op selection dialog.

The basic workflow to create a new version of Ops.Team.Cables.NeedsUpdate would be this:

  • Clone the code of Ops.Team.Cables.NeedsUpdate into any other op (preferably a patchop, as this will be temporary), say Ops.Patch.Patch_5711.NeedsUpdate
  • Make your changes, fixed and improvements to that op
  • Rename Ops.Patch.Patch_5711.NeedsUpdate to Ops.Team.Cables.NeedsUpdate_v2 (notice the _v2, cables will warn you about existing versions or "gaps" in the version number)
  • Open any patch that uses the old version and press the "update" button
Found a problem? Edit this file on github and contribute to cables!