Skip to content

Commit

Permalink
Update cloud-variables.md
Browse files Browse the repository at this point in the history
  • Loading branch information
GarboMuffin authored Apr 10, 2024
1 parent 0a31f82 commit f0fe1f6
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/website/cloud-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ Some things to keep in mind:

We allow using bots and custom clients. However, due to persistent abuse, we have some requirements and expectations. Remember that **this is a free service operated by volunteers.** The CPU to parse messages and the bandwidth to send messages to other users is not free. The information below is applicable to both users and authors of cloud variable libraries.

Nothing here is hard to follow. Largely just standard internet bot etiquette and some other tips.

### User-Agent is required {#user-agent}

Bots must provide a valid [User-Agent](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent) header in their connection. That includes contact information (such as a Scratch profile link, email address, GitHub issue page, etc.) and, ideally, the name and version of the library being used. Some examples of good User-Agents:
Expand Down Expand Up @@ -118,7 +120,7 @@ It is possible to offer an API like `get_var` as long as the implementation is e

### Updates are buffered {#buffering}

For performance, the server will buffer up several cloud variable updates to send out as one group. Updates are not guaranteed to be sent in the same order they are received, and some updates may be skipped entirely. As a result of this buffering, updating variables more than 10 times per second is redundant and will just cause updates to be skipped.
For performance, the server will buffer up several cloud variable updates to send out as one group. Updates are not guaranteed to be sent in the same order they are received, and some updates may be skipped entirely. Because of this buffering, sending updated variables more than 10 times per second is completely redundant.

### Important debug information {#debug}

Expand Down

0 comments on commit f0fe1f6

Please sign in to comment.