beta
cables is under heavy development.
There might be one or another bug, please let us know about it!
cables DocumentationHow To UseWorking with filesKeyboard ShortcutsUser Interface WalkthroughBeginner TutorialBeginner 1: Drawing A CircleBeginner 2: TransformationsBeginner 3: ColorMore TransformationsintermediateImage CompositionsPost-Processing 3D Scenescommunicationcables APICommunication with an Arduino via SerialCommunicating with Arduino over MQTTExporting 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 patchescoding opsCreating AttachmentsGeneral op/Port CallbacksPortsDynamic PortsArray PortsBoolean portsInteger Number PortsObject PortsString portsTrigger PortsFloating Point Number PortsGUI/UI attributesHello Op - Part 1LibrariesDeveloping OpsGuidelinesObject PortsWriting ShadersWeb Audio Op DevelopmentHTML and CSS in cablesLightingLightsShadowsWorking with audioBasic Audio SetupWorking with EffectsReal-Time Audio Analyzation & Audio VisualizationOffline Audio Visualization & AnalyzationFAQEmbeddingHow to integrate my cables patch into my CMS (webflow/wix/squarespace/...)?getting a warning when running the patch in electronHow to remove grey rectangles on touch (mobile)?Why doesn't the DownloadTexture op work on iOS?How to disable page scrolling on mobile?Mobile tippsTransparent CanvasFeatures and SupportHow to contribute code to cablesWill there be support for (animated) GIFs?How to report a bug in cablesGeneral questionsLicences and paymentWhat licence do i need to use cables?Will I have to pay for it in the future?How is my work licenced when using cables?Does cables support midi and OSC?ShadertoyTechnical questionsUI / EditorGuide to VR in cablesWebGL1 and WebGL2

Export to github (pages)

Select the "GITHUB" option in the export dialog:

Button

Prerequisites

  • an account on github
  • any repository, create one here if needed
  • an access token for your github-user with at least "repo" permissions
  • (if wanted) activate github pages for your repository in the repositories settings on github
    • your repository needs to be made public for this to be free
    • you need to pick a branch when activating pages, remember this for the settings below

Parameters

All these parameters can only be changed/entered by the owner of the patch. Exports can be done to configured deployments
by all collaborators added to the patch.

Repository Owner

Put in the name of the repository owner, most of the time this is your github username.

If your repository URL is https://github.com/cables-gl/cables-cli/ your ownername will be cables-gl

Repository Name

Put in the name of the repository, if your repository URL is https://github.com/cables-gl/cables-cli/
the name of the repository will be cables-cli

Branch

This can be left blank, set to master for older repositories or pick any branch you want the changes to be pushed to.

Subdirectory

If you want your patches to reside in a subdirectory of your repository, put the name of that directory here.
This is a good way to have multiple patches in the same repository but in different directories (patch1/, patch2/, ...)

Access Token

Enter your generated access token that has at least "repo" permissions in github.

WALKTHOUGH

  • enter the above information
  • click on button
  • wait for the two buttons to appear
  • click on "View Deployment" to visit your website on github
  • click on "Deploments overview" to see your repository on github

CAVEATS

  • this will not work if there are any merge conflicts, do not change any cables files from outside cables
  • this will overwrite any patch that has been exported to the same repo/subdir-combination before
  • use git commit history to roll-back any mishaps

Export Options

You can choose how the contents of your export should look, the defaults should be fine for almost everything.

Include assets

If your patch uses uploaded files (textures, audio, data, ...) choose one of the following options to have
these files included in the export.

  • Automatic: Tries to guess which files are used in the patch and includes only used assets.
  • All: Includes all the assets uploaded to the patch or referenced in there, this is the safe option.
  • None: Does not include any assets in the export, smaller download but some things might not work in the export

Package

  • Single Javascript File: packages and minifies everything into one single javascript file to include
  • Multiple Files: will keep the patch configuration, your code, and core code in seperate files

Compatibility

  • Modern browsers: does nothing to make sure your patch runs in every browser
  • Old browsers: uses babel to try make your patch run on older browsers, in general should not be needed anymore

help cables get better and edit this file on github