Skip to content

Commit

Permalink
Merge pull request cyberbotics#6169 from cyberbotics/doc-update-webot…
Browse files Browse the repository at this point in the history
…s-cloud

Doc update webots cloud
  • Loading branch information
Benjamin Délèze authored Jun 6, 2023
2 parents 774bd6a + 989fee9 commit f6d2355
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/blog/Webots-2022-b-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ This tool could be used to publish open-science results where both reviewers and

#### Simulations

- [OroBOT Simulation](https://webots.cloud/run?version=R2022b&url=https://github.com/cyberbotics/orobot/blob/main/worlds/OroBOT_uneven.wbt)
- [Spot Simulation](https://webots.cloud/run?version=R2022b&url=https://github.com/cyberbotics/webots-cloud-simulation-examples/blob/main/2_compile_controller/worlds/spot.wbt)
- [OroBOT Simulation](https://webots.cloud/run?version=R2022b&url=https://github.com/cyberbotics/orobot/blob/main/worlds/OroBOT_uneven.wbt&type=demo)
- [Spot Simulation](https://webots.cloud/run?version=R2022b&url=https://github.com/cyberbotics/webots-cloud-simulation-examples/blob/main/2_compile_controller/worlds/spot.wbt&type=demo)

---

Expand Down
27 changes: 25 additions & 2 deletions docs/guide/webots-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[webots.cloud](https://webots.cloud) is an open-source webservice to share simulations online.
You can share 3D scenes and animations recorded from a simulation, but also fully interactive simulations.
This is also the place where you can see the complete library of protos available in Webots and add your own.

### Publish 3D Scenes and Animations

Expand All @@ -11,6 +12,24 @@ Once your scene or animation is uploaded, you get a link (web URL) pointing to y
Anyone with this link can view your 3D scene or animation with a simple mouse click.
Scenes and animations can also be uploaded on webots.cloud by clicking the "Add a new scene/animation" button, and uploading locally saved `X3D`, `JSON`, thumbnail and texture files.

### Share and Use Your Proto

The [protos section](https://webots.cloud/proto) of webots.cloud is the place where you can see the protos available in Webots, read about them and play with their parameters.
Anyone can add its own proto to the library. To do that, your proto files (`.proto` files, textures, meshes,...) shoud be hosted on a GitHub repository.
The proto folder must also have a `webots.yaml` file which should contain: `publish: true`.
To classify the proto correctly, webots.cloud needs to know what are the `keywords` of the proto. Please refer to [this section](../reference/proto-design-guidelines.md#keywords) to learn more about `keywords` and how to set them.
You can then add your proto by clicking the `Add a new proto` button at the bottom of the [proto page](https://webots.cloud/proto).

To add a proto from the library to a world, copy the github url of the proto and convert it to `raw.githubusercontent.com`. To to that, change `github.com` into `raw.githubusercontent.com` and remove the `/blob`. Then paste it at the top of the world file like this:
```
#VRML_SIM R2023b utf8
IMPORTABLE EXTERNPROTO "https://raw.githubusercontent.com/cyberbotics/webots/develop/projects/appearances/protos/RoughOak.proto"
WorldInfo {
```


### Publish Cloud-Based Simulations

It is also possible to run a Webots simulation in webots.cloud interactively.
Expand Down Expand Up @@ -94,7 +113,11 @@ The server tab on webots.cloud contains information on the [Simulation Servers](
- [PR2](https://webots.cloud/AcpeTj6)
- [Nao room](https://webots.cloud/AcTNYs0)

**Proto**
- [NAO](https://webots.cloud/run?version=R2023b&url=https://github.com/cyberbotics/webots/blob/develop/projects/robots/softbank/nao/protos/Nao.proto)
- [WoodenPalletStack](https://webots.cloud/run?version=R2023b&url=https://github.com/cyberbotics/webots/blob/develop/projects/objects/factory/pallet/protos/WoodenPalletStack.proto)

**Simulation**:

- [OroBOT Simulation](https://webots.cloud/run?version=R2022b&url=https://github.com/cyberbotics/orobot/blob/main/worlds/OroBOT_uneven.wbt)
- [Spot Simulation](https://webots.cloud/run?version=R2022b&url=https://github.com/cyberbotics/webots-cloud-simulation-examples/blob/main/2_compile_controller/worlds/spot.wbt)
- [OroBOT Simulation](https://webots.cloud/run?version=R2022b&url=https://github.com/cyberbotics/orobot/blob/main/worlds/OroBOT_uneven.wbt&type=demo)
- [Spot Simulation](https://webots.cloud/run?version=R2022b&url=https://github.com/cyberbotics/webots-cloud-simulation-examples/blob/main/2_compile_controller/worlds/spot.wbt&type=demo)

0 comments on commit f6d2355

Please sign in to comment.