From c60c6ff9b0a589691b4ebf443b4a2efd83ea9ca2 Mon Sep 17 00:00:00 2001 From: SwingTheVine Date: Thu, 24 Jul 2025 21:08:21 -0400 Subject: [PATCH] Updated documentation --- docs/CREDITS.md | 3 ++- docs/README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++-- src/overlay.css | 1 + src/overlay.js | 10 +++++----- 4 files changed, 53 insertions(+), 8 deletions(-) diff --git a/docs/CREDITS.md b/docs/CREDITS.md index 263c1da..af107f7 100644 --- a/docs/CREDITS.md +++ b/docs/CREDITS.md @@ -1,3 +1,4 @@ +``` ██████╗ ██╗ ██╗ ██╗███████╗ ██╔══██╗██║ ██║ ██║██╔════╝ ██████╔╝██║ ██║ ██║█████╗ @@ -12,7 +13,7 @@ ██║╚██╔╝██║██╔══██║██╔══██╗██╔══██╗██║ ██╔══╝ ██║ ╚═╝ ██║██║ ██║██║ ██║██████╔╝███████╗███████╗ ╚═╝ ╚═╝╚═╝ ╚═╝╚═╝ ╚═╝╚═════╝ ╚══════╝╚══════╝ - +``` --------------------------------------------------- diff --git a/docs/README.md b/docs/README.md index 467b6ce..d2ec140 100644 --- a/docs/README.md +++ b/docs/README.md @@ -6,6 +6,9 @@  Overview + +   Bot Settings +  How Versioning Works @@ -31,7 +34,43 @@

Overview

- TBA + Welcome to Blue Marble! Blue Marble is a userscript for the website wplace.live. Blue Marble contains a userbot, which can place pixels for you! You can control the Blue Marble bot from the custom overlay. + +

Bot Settings

+

+ There are many settings available for the Blue Marble userbot! Through these settings, you can control how the bot behaves. +

Stealth Mode

+ Default: Enabled +

+ 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

+ Default: Enabled +

+ 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 userbot since most actions are made through the game, not the userbot. +

+

Panic Mode

+ Default: Disabled +

+ When Panic Mode is enabled, Blue Marble will avoid placing pixels if another user placed there within the last few minutes. Griefers might see resistance as a "challenge" they have to overcome, so Blue Marble will wait for them to get bored and move on before resuming placement. +
+ Note: Panic Mode will trigger for any user, including your allies. +

+

+ +

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

@@ -52,5 +91,9 @@

FAQ

- TBA +

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).

\ No newline at end of file diff --git a/src/overlay.css b/src/overlay.css index e9b6424..e279dd7 100644 --- a/src/overlay.css +++ b/src/overlay.css @@ -85,4 +85,5 @@ div#bm-overlay { padding: 0 0.5ch; height: 3.75em; width: 100%; + margin-top: 0.5em; } \ No newline at end of file diff --git a/src/overlay.js b/src/overlay.js index a3706ec..0d9b01e 100644 --- a/src/overlay.js +++ b/src/overlay.js @@ -66,7 +66,7 @@ export class Overlay { // Stealth Mode checkbox containerAutomation.appendChild(this.createLineCheckbox( - 'Stealth Mode', + 'Stealth', 'bm-input-stealth', true )); @@ -80,9 +80,9 @@ export class Overlay { containerAutomation.appendChild(document.createElement('br')); // Line break - // Possessed Mode + // Possessed Mode checkbox containerAutomation.appendChild(this.createLineCheckbox( - 'Possessed Mode', + 'Possessed', 'bm-input-possessed', true )); @@ -96,13 +96,13 @@ export class Overlay { containerAutomation.appendChild(document.createElement('br')); // Line break - // Panic option + // Panic mode checkbox containerAutomation.appendChild(this.createLineCheckbox( 'Panic', 'bm-input-panic' )); - // Adds the help icon for panic + // Adds the help icon for panic mode containerAutomation.appendChild(this.createQuestionBox( 'bm-help-panic', 'Help: Stops placing for a while if it detects a user nearby.',