This repository has been archived by the owner on Nov 7, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #59 from MikeDev101/cloudlink-4
Early CloudLink 4
- Loading branch information
Showing
19 changed files
with
2,919 additions
and
2,552 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,49 +1,62 @@ | ||
| # NOTICE | ||
|  | ||
|
|
||
| CloudLink is being rewritten as there are several security vulnerabilities that have been found, as well as improve performance and functionality. | ||
| # Cloudlink | ||
| Cloudlink is a free and open-source, websocket-powered API optimized for Scratch 3.0. Cloudlink comes with several powerful utilities and features: | ||
| * Multicast and unicasting messages - Perfect for high-speed projects | ||
| * Friendly software suite for implementing project-specific features - Multi-project save files and more | ||
| * Advanced packet queuing system - Messages are handled browser-level so your Scratch code doesn't need to do extra work | ||
| * Support for sandboxed/unsandboxed extension modes | ||
| * Proven reliability - Extensively tested and utilized in [The Meower Project](https://github.com/meower-media-co/) | ||
| * Unique project identifiers to allow frictionless communication between projects and app servers over a single Cloudlink Server | ||
|
|
||
| # CloudLink | ||
| ## Get started with Cloudlink | ||
| For full documentation of Cloudlink, please visit Cloudlink's [Documentation](https://hackmd.io/G9q1kPqvQT6NrPobjjxSgg) page. | ||
|
|
||
| CloudLink is a high-speed, reliable, and custom websocket extension for Scratch 3.0, with server code that runs on Python. | ||
| It permits cross-project (as well as cross-program) cloud variables. | ||
| It also enables full-duplex networking and limitless possibilities for Scratch 3.0 projects. | ||
| There are several publically-hosted Cloudlink instances available, which can be found in [serverlist.json](https://github.com/MikeDev101/cloudlink/blob/master/serverlist.json) or through the Server List block. | ||
|
|
||
| ## Links | ||
| Cloudlink was originally created for Scratch 3.0. You can view the latest version of Cloudlink in any of these Scratch editors: | ||
| - [TurboWarp](https://turbowarp.org/editor?extension=https://mikedev101.github.io/cloudlink/B3-0.js) | ||
| - [SheepTester's E 羊 icques](https://sheeptester.github.io/scratch-gui/?url=https://mikedev101.github.io/cloudlink/B3-0.js) | ||
| - [Ogadaki's Adacraft](https://adacraft.org/studio/) | ||
| - [Ogadaki's Adacraft (Beta)](https://beta.adacraft.org/studio/) | ||
|
|
||
| ### [Discussion Forum (Archive)](https://scratch.mit.edu/discuss/topic/398473) | ||
| Cloudlink is also available as a Python module, which comes bundled with the Cloudlink Server. | ||
| There is even a web-friendly version of Cloudlink available as CLJS. | ||
|
|
||
| ### [HackMD Documentation](https://hackmd.io/G9q1kPqvQT6NrPobjjxSgg) | ||
| ### [Discussion Forum (Archive)](https://scratch.mit.edu/discuss/topic/398473) | ||
| ### [Cloudlink JS "cljs" (discontinued)](https://github.com/wgyt/cljs) | ||
|
|
||
| ### [CloudLink JS "cljs" (discontinued)](https://github.com/wgyt/cljs) | ||
| ## FAQ | ||
| > Will my Cloudlink 3.0/TURBO projects support Cloudlink 4.0 Servers? | ||
| ## Example code | ||
| Yes, there will be no compatibility-breaking changes to how Cloudlink 4.0 handles messages. However, the new custom command handler will bind all custom commands to use: `{"cmd": "(custom command here)"}` instead of using the Direct command, `{"cmd": "direct", "val": {"cmd": "(custom command here)"}}` | ||
|
|
||
| Example code can be downloaded in the GitHub repository. | ||
| > Will my Server (v0.1.7.x and older) need to be rewritten entirely to support Cloudlink 4.0? | ||
| #### Server: https://github.com/MikeDev101/cloudlink/blob/master/server_example.py | ||
| No, you will only need to rewrite your custom packet handlers as Cloudlink 4.0 will reimplement custom commands. | ||
|
|
||
| #### Client: https://github.com/MikeDev101/cloudlink/blob/master/client_example.py | ||
| > Where can I find old versions of Cloudlink? | ||
| Please report any bugs you find to the official [GitHub repository](https://github.com/MikeDev101/cloudlink/issues). | ||
| You can check the releases tab in Github for older versions, or you can download a complete archive of all old versions here (LINK TBD). | ||
|
|
||
| # Scratch Extension | ||
| > Will Cloudlink 4.0 work with my project made for Cloudlink TURBO? | ||
| You can view the client-side extension using one of the following modded Scratch editors: | ||
| No, Cloudlink 4.0 serves as a replacement of Cloudlink TURBO. While Cloudlink 4.0 is built upon Cloudlink TURBO, it does not have the same blocks as Cloudlink 3.0. In favor or retaining compatibility with Cloudlink 3.0, Cloudlink TURBO should not be used and will be retired. | ||
|
|
||
| - [TurboWarp](https://turbowarp.org/editor?extension=https://mikedev101.github.io/cloudlink/B3-0.js) | ||
| - [SheepTester's E 羊 icques](https://sheeptester.github.io/scratch-gui/?url=https://mikedev101.github.io/cloudlink/B3-0.js) | ||
| - [Ogadaki's Adacraft (Manual load required)](https://adacraft.org/studio/) | ||
| > Will my older projects (prior to Cloudlink 3.0) work with Cloudlink 4.0? | ||
| # Installing CloudLink | ||
| No, only projects built with Cloudlink 3.0 will work with Cloudlink 4.0. | ||
|
|
||
| > Does Cloudlink 4.0 have the Cloudlink Suite? | ||
| ## PIP HAS NOT BEEN UPDATED, PLEASE MANUALLY DOWNLOAD THE SOURCE CODE | ||
| ### Method 1: using pip | ||
| `pip install cloudlink` | ||
| Yes. Cloudlink 4.0 will be a complete reimplementation of the original Cloudlink Suite. | ||
|
|
||
| ## Method 2: Directly downloading cloudlink.py | ||
| > What is the Cloudlink Suite? | ||
| Simply download the [source code](https://github.com/MikeDev101/cloudlink/archive/refs/heads/master.zip), extract cloudlink.py, and import it as shown above. However, the following dependencies are required in order to take advantage of full functionality: | ||
| The Cloudlink Suite is a set of extra features built into the Cloudlink Extension. It provides extra features for Scratch developers to implement in projects that would normally add extra bloat, but can be implemented in a few blocks. These features include: | ||
| * CloudDisk: Completely free cloud storage (Up to 10 KB, or 10^4 Bytes, per account), and a cross-project, cross-platform save file system (Up to 1 KB, or 10^3 Bytes, per save file with a maximum of 10 save files). | ||
| * CloudCoin: Simple per-project, per-user currency system and supports cross-project trading. | ||
| * CloudAccount: Extremely easy-to-use username/password system as an alternative to the username block for user identification, and protects your CloudCoin and CloudDisk data from unwanted users. | ||
|
|
||
| - websocket-server `pip install websocket-server` | ||
| - websocket-client `pip install websocket-client` | ||
| ## Found an issue? | ||
| Please report any bugs, glitches, and/or security vulnerabilities [here](https://github.com/MikeDev101/cloudlink/issues). |
Oops, something went wrong.