Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
steam0r committed Sep 24, 2024
2 parents f812c84 + b1ecfe5 commit c4e66ef
Show file tree
Hide file tree
Showing 14 changed files with 59 additions and 61 deletions.
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Export for Cables Standalone Version
# Export full Patch

Select the "Standalone" option in the export dialog on [dev.cables.gl](https://dev.cables.gl). Download the latest version of ["cables standalone"](https://dev.cables.gl/downloads).
Select the "Patch" option in the export dialog on [dev.cables.gl](https://dev.cables.gl). This export will contain
all the assets, any custom ops of the patch (patch, team, subpatch) and can be run in cables standalone.

Install and/or open the standalone version, select "Open Patch" from the menu or the welcome screen, select
the `.json` file you just downloaded. Start patching!
## Run in cables standalone

Be aware, that there is currently no way to re-import patches that you worked on in "cables standalone"
to cables.gl. This will be in one of the next releases!
Download the latest version of ["cables standalone"](https://dev.cables.gl/downloads).

Have a look at [our roadmap](https://github.com/cables-gl/cables_electron/milestones?direction=desc&sort=due_date&state=open) for future versions and [report bugs](https://github.com/cables-gl/cables_electron/issues) or submit [feature requests](https://github.com/cables-gl/cables_electron/issues). Any feedback is greatly appreciated!
Install and/or open the standalone version, select "Open Patch" from the menu or the welcome screen, select
the `.cables` file you just downloaded. Start patching!
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This page will explain how to create an input and output port of the type 'Array
![Button](../img/creating_ports_array_port_color.png) <br>


Click this [link](https://cables.gl/ui/#/project/5b9f692e671e52e512ab3af3) to see an example of all port types and code examples
Click this [link](https://cables.gl/edit/5b9f692e671e52e512ab3af3) to see an example of all port types and code examples

A Javascript array can contain either simple values, arrays or objects<br>
Arrays are used to store multiple values in a single variable.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This page will explain how to create an input and output port of the type 'Boolean'<br>
![Button](../img/creating_ports_boolean_port_color.png) <br>
Click this [link](https://cables.gl/ui/#/project/5b9f692e671e52e512ab3af3) to see an example of all port types and code examples
Click this [link](https://cables.gl/edit/5b9f692e671e52e512ab3af3) to see an example of all port types and code examples

A JavaScript Boolean represents one of two values: true or false

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This page will explain how to create an input and ouput port of the type `Integer`

Click this [link](https://cables.gl/ui/#/project/5b9f692e671e52e512ab3af3) to see an example of all port types and code examples
Click this [link](https://cables.gl/edit/5b9f692e671e52e512ab3af3) to see an example of all port types and code examples

Integer ports can hold a single integer like `-2 0 10 101`
They're useful when you want to have a parameter to access an array by index or don't want to have to use `Math.floor` on the numerical input.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
This page will explain how to create an input and ouput port of the type `Object`<br>
![Button](../img/creating_ports_object_port_color.png) <br>

Click this [link](https://cables.gl/ui/#/project/5b9f692e671e52e512ab3af3) to see an example of all port types and code examples
Click this [link](https://cables.gl/edit/5b9f692e671e52e512ab3af3) to see an example of all port types and code examples

Object ports can accept any kind of object, e.g.:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This page will explain how to create an input and output port of the type 'Strin

![Button](../img/creating_ports_string_port_color.png)<br>

Click this [link](https://cables.gl/ui/#/project/5b9f692e671e52e512ab3af3) to see an example of all port types and code examples
Click this [link](https://cables.gl/edit/5b9f692e671e52e512ab3af3) to see an example of all port types and code examples

JavaScript strings are used for storing and manipulating text
A string is zero or more characters written inside quotes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
This page will explain how to create an input and output port of the type`Trigger`and how to make a `Button` in the UI pane of the op which can be clicked with the mouse to trigger an event<br>
![Button](../img/creating_ports_trigger_port_color.png) <br>

Click this [link](https://cables.gl/ui/#/project/5b9f692e671e52e512ab3af3) to see an example of all port types and code examples
Click this [link](https://cables.gl/edit/5b9f692e671e52e512ab3af3) to see an example of all port types and code examples

Trigger ports are used to trigger another op. If you have a patch that creates visuals then you need to add the`MainLoop op`which has a `trigger port`. This updates all connected ports 60 times a second.
Trigger ports can also be triggered under certain conditions <br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This page will explain how to create an input and ouput port of the type `Number`<br>
![Button](../img/creating_ports_value_port_color.png)<br>
Click this [link](https://cables.gl/ui/#/project/5b9f692e671e52e512ab3af3) to see an example of all port types and code examples
Click this [link](https://cables.gl/edit/5b9f692e671e52e512ab3af3) to see an example of all port types and code examples

JavaScript does not define different types of numbers, like integers, short, long, floating-point etc <br>
JavaScript numbers are always stored as double precision floating point numbers
Expand Down
2 changes: 1 addition & 1 deletion md/5_writing_ops/dev_hello_op/dev_hello_op.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ const multiplyValueIn = op.inFloat("Multiply amount");
This creates a second port and a new part on the object pane which allows us to set the multiplication amount.
Your op should now look like this

![](img/b-port_in_multiply_amount.png)
![](img/b-port_in_multiply_amount2.png)


Your code should look like this
Expand Down
Binary file not shown.
2 changes: 1 addition & 1 deletion md/6_1_developing_cables/1_setup_dev_env/setup_dev_env.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ But let's get started:

## Mac/Linux
- install [git](https://github.com/git-guides/install-git)
- clone [this repository](https://github.com/cables-gl/cables_dev)
- clone the [cables dev repository](https://github.com/cables-gl/cables_dev): `git clone [email protected]:cables-gl/cables_dev.git`
- change into the checked out directory (`cd cables_dev/`)
- continue [below](#common)

Expand Down
84 changes: 42 additions & 42 deletions md/faq/features/reports/reports.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,42 @@
# How to report a bug in cables

As cables is in constant development, there will be bugs here and there. We also try to keep our documentation and examples up-to-date but when you notice things not working the way they are described or you expected - Please submit an issue for us following the guidelines below!


## Where to report bugs?

Please keep all bugreports to the [Discussions forum](https://github.com/cables-gl/cables_docs/discussions/categories/bug-reports) .
Check out previously submitted bugs first and if you find a related report, vote it up and post about your findings too. That way we have more details and can see how frequently this bug happens!

## What information to include in my post to GitHub Discussions?

### Description of your environment

First and foremost - tell us what operating system and browser your are using.
Send us the generated link provided on [cables.gl/browser](https://cables.gl/browser) - it will be on top of the page.

Tell us more about your project and how it is running - on mobile? on WordPress? inside the cables.gl editor?

### A simple step by step explanation that is reproducible

Please include a simple explanation that is showing your issue as isolated as possible.

Attaching a video and screenshot illustrating your issue is great too.

### A small and simple example patch

Please try to isolate the problem and provide a simple example patch that displays what
is going wrong. Provide us with a link in your issue post!

### A screenshot of your browsers dev-console

For most browsers you can open the dev-console by rightclicking anywhere on the page, selecting "inspect element"
and then switching to the console tab. Keep the console open and reproduce the error in your patch. Please provide a screenshot of the errors reported in the console.

This is a bit harder to do on a mobile-phone, but if you are used to remote-debugging android/ios-devices
a glimpse into your dev-console would help here also.


## I have code that fixes the issue!

Awesome! Please post your findings on our [Discussions forum](https://github.com/cables-gl/cables_docs/discussions/categories/bug-reports) and provide your proposed fixes and solutions. We highly appreciate contributors and community members that go above and beyond. Thanks for contributing and expect a token of our thanks in the mail!
# How to report a bug in cables

As cables is in constant development, there will be bugs here and there. We also try to keep our documentation and examples up-to-date but when you notice things not working the way they are described or you expected - Please submit an issue for us following the guidelines below!


## Where to report bugs?

Please keep all bugreports to the [Discussions forum](https://github.com/cables-gl/cables_docs/discussions/categories/bug-reports) .
Check out previously submitted bugs first and if you find a related report, vote it up and post about your findings too. That way we have more details and can see how frequently this bug happens!

## What information to include in my post to GitHub Discussions?

### Description of your environment

First and foremost - tell us what operating system and browser your are using.
Send us the generated link provided on [cables.gl/browser](https://cables.gl/browser) - it will be on top of the page.

Tell us more about your project and how it is running - on mobile? on WordPress? inside the cables.gl editor?

### A simple step by step explanation that is reproducible

Please include a simple explanation that is showing your issue as isolated as possible.

Attaching a video and screenshot illustrating your issue is great too.

### A small and simple example patch

Please try to isolate the problem and provide a simple example patch that displays what
is going wrong. Provide us with a link in your issue post!

### A screenshot of your browsers dev-console

For most browsers you can open the dev-console by rightclicking anywhere on the page, selecting "inspect element"
and then switching to the console tab. Keep the console open and reproduce the error in your patch. Please provide a screenshot of the errors reported in the console.

This is a bit harder to do on a mobile-phone, but if you are used to remote-debugging android/ios-devices
a glimpse into your dev-console would help here also.


## I have code that fixes the issue!

Awesome! Please post your findings on our [Discussions forum](https://github.com/cables-gl/cables_docs/discussions/categories/bug-reports) and provide your proposed fixes and solutions. We highly appreciate contributors and community members that go above and beyond. Thanks for contributing and expect a token of our thanks in the mail!
4 changes: 1 addition & 3 deletions md/faq/technical/technical.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,7 @@ Then again a lot of amazing patches run on mobile devices so it's all down to th

#### Is there a standalone version of cables that doesn’t require an internet connection?

- Yes and no. To make and and edit patches you need an internet connection so you can use the cables editor.
If you have a finished patch you can run it without an internet connection straight from a USB stick.
It's called Daplaya, you can download it and get started [here](https://github.com/cables-gl/cables-daplaya)
- Yes! You can download the latest version [here](https://cables.gl/standalone)

#### Can I embed a cables patch in a wordpress page?

Expand Down

0 comments on commit c4e66ef

Please sign in to comment.