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  ⟩  Exporting And Embedding  ⟩  Exporting Patches  ⟩  Export to github (pages)

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 (add at least one file, otherwise the repo doesnt exists for github)
  • an access token for your github-user with at least "repo" permissions
    • if you use github's "fine grained permissions", make sure your token has "read and write" permission to the "contents" of your created repo
  • (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.

Video Tutorial

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.

Use "All" if you are generating filenames on the fly (iterators, arrays, ...) to make sure all files are available 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

Skip Backups

  • When deselecting this option, the export will include JSON-files for all the versions of your patch that can be re-imported into cables later.

Export without subdirectories

  • Should you need the directory structure of your patch to be "flat" (no js/ or assets/ subdirectory) you can select this option.
    • This will ususally not be needed, some platforms do not allow for accessing subdirectories tough, and some setups of frameworks like react/vue also behave weirdly with subdirectories.

Minify Code

  • Deselecting this option will make your code bigger, but more readable, might be useful in debugging situations, you usually don't want this in "production".

Add Source Maps

  • When minifying code, this option will add source maps to your javascript files. This will make the code readable in dev-tools and may help in debugging situations, but will have and additional download for people opening the dev-tools of their browser.

Minify GLSL

  • Minify shadercode. Same as "Minify Code", but for GLSL-Shadercode
Found a problem? Edit this file on github and contribute to cables!