|
|
||
|---|---|---|
| .github/workflows | ||
| build | ||
| dist | ||
| docs | ||
| src | ||
| .gitattributes | ||
| .gitignore | ||
| LICENSE.txt | ||
| package-lock.json | ||
| package.json | ||
| Blue Marble |  |
| Overview | |
| Script Settings | |
| Template Settings | |
| How Versioning Works | |
| Licenses | |
| FAQ | |
| How do I hide the overlay? | |
| Why do game notifications appear on top of the overlay? |
Blue Marble
Overview
Welcome to Blue Marble! Blue Marble is a userscript for the website wplace.live. If you like this userscript, please ⭐ the repository!
Installation Instructions
Blue Marble has been verified to work on mobile devices. Blue Marble was designed on Chrome, but Blue Marble might work on "unsupported" browsers not listed above.
Here is how you install the Blue Marble userscript:
- Install TamperMonkey.
- Enable Developer Mode & Userscripts (on Chrome).
- Download the BlueMarble.user.js file.
- Put the
BlueMarble.user.jsfile inside the dashboard of TamperMonkey. - Enable BlueMarble inside TamperMonkey
Script Settings
There are many settings available for the Blue Marble userscript! Through these settings, you can control how the script behaves.
Stealth Mode
Stealth Mode, when enabled, requires the game to make a request to the server instead of Blue Marble making its own requests. However, this means Blue Marble will wait indefinitely until the request is made. This should be used with Possessed Mode so Blue Marble can "suggest" the game make certain requests instead of waiting for the requests to naturally occur.
Possessed Mode
In Possessed Mode, Blue Marble will prioritize controling the game over directly interacting with the server. For example, assume a situation where Blue Marble is trying to place a pixel. However, the tile is not loaded. Typically, Blue Marble would make a request to the server to fetch the tile. When Possessed Mode is enabled, Blue Marble will teleport the game to the tile, which causes the game to fetch the tile. The difference lies in who sends the request to the server. When Stealth Mode and Possessed Mode are both enabled, it is harder to detect the userscript since most actions are made through the game, not the userscript.
Template Settings
Transparent Pixels
Templates for Blue Marble work slightly different from normal. Since there is a "Transparent" color, and transparent pixels in templates are typically ignored, your template should have a custom color to signify "Transparent" colored pixels. If a specific pixel can be any color, it should be transparent in the template. If a specific pixel should be "Transparent" color, it should have the #deface hex color. Any #deface colored pixel in your template will be interpereted as the "Transparent" color. Any transparent colored pixel in your template will be interpereted as ignored.
Coordinates
The coordinate system for wplace.live is unique. Instead of all pixels having a global coordinate number (x, y), the coordinate number is relative to the tile. This means you need to know the tile number and the coordinate number to do anything.
The template is aligned from the top left corner. You can auto-fill this position using the "pin" icon next to the coordinate input boxes.
How Versioning Works
The versioning system for this userscript follows the Semantic Versioning rules. As such, it is formatted in an X.Y.Z format where:
- X is the major version. This is incremented when a non-backward compatible update is pushed. This is for new features that break previous versions of the userscript. Additionally, if wplace.live breaks the userscript, this will be incremented.
- Y is the minor version. This is incremented whenever I push to GitHub. This is for stable bug-fixes and new (non-breaking) features.
- Z is the patch version. This is incremented whenever I launch a development version of the userscript to test a patch. This is for unstable bug-fixes/features.
Licenses
(Below, all mentions of the "userscript" refer to the "Blue Marble" userscript made by SwingTheVine)
Most of this userscript is licensed under the Mozilla Public License Version 2.0 (MPL-2.0). All software, code, and libraries in this repository are licensed under the MPL-2.0 license. However, the "Blue Marble" image in this userscript is owned by NASA and is licensed under the Creative Commons 0 1.0 Universal (CC0 1.0) license.
FAQ
How do I hide the overlay?
A: Turn the userscript off and refresh the page.
Why do game notifications appear on top of the overlay?
A: Game notifications only appear when they need immediate attention. Therefore, they have priority over the overlay (which typically needs no attention).