Added some install instructions
|
|
@ -30,41 +30,79 @@
|
|||
</table>
|
||||
|
||||
<h1>Blue Marble</h1>
|
||||
<a href="" target="_blank"><img alt="Latest Version" src="https://img.shields.io/badge/Latest_Version-0.68.0-lightblue?style=flat"></a>
|
||||
<a href="https://github.com/SwingTheVine/Wplace-BlueMarble/releases" target="_blank"><img alt="Latest Release" src="https://img.shields.io/github/v/release/SwingTheVine/Wplace-BlueMarble?sort=semver&style=flat&label=Latest%20Release&color=blue"></a>
|
||||
<a href="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/LICENSE.txt" target="_blank"><img alt="Software License: MPL-2.0" src="https://img.shields.io/badge/Software_License-MPL--2.0-slateblue?style=flat"></a>
|
||||
<a href="https://discord.gg/tpeBPy46hf" target="_blank"><img alt="Contact Me" src="https://img.shields.io/badge/Contact_Me-gray?style=flat&logo=Discord&logoColor=white&logoSize=auto&labelColor=cornflowerblue"></a>
|
||||
<a href="" target="_blank"><img alt="WakaTime" src="https://img.shields.io/badge/Coding_Time-87hrs_0mins-blue?style=flat&logo=wakatime&logoColor=black&logoSize=auto&labelColor=white"></a>
|
||||
<a href="" target="_blank"><img alt="Total Patches" src="https://img.shields.io/badge/Total_Patches-450-black?style=flat"></a>
|
||||
<a href="" target="_blank"><img alt="Total Lines of Code" src="https://tokei.rs/b1/github/SwingTheVine/Wplace-BlueMarble?category=code"></a>
|
||||
<a href="" target="_blank"><img alt="Total Comments" src="https://tokei.rs/b1/github/SwingTheVine/Wplace-BlueMarble?category=comments"></a>
|
||||
<a href="" target="_blank"><img alt="Compression" src="https://img.shields.io/badge/Compression-73.04%25-blue"></a>
|
||||
<a href="" target="_blank"><img alt="Build" src="https://github.com/SwingTheVine/Wplace-BlueMarble/actions/workflows/build.yml/badge.svg"></a>
|
||||
<a href="" target="_blank"><img alt="CodeQL" src="https://github.com/SwingTheVine/Wplace-BlueMarble/actions/workflows/github-code-scanning/codeql/badge.svg"></a>
|
||||
<a href="" target="_blank" rel="noopener noreferrer"><img alt="Latest Version" src="https://img.shields.io/badge/Latest_Version-0.68.0-lightblue?style=flat"></a>
|
||||
<a href="https://github.com/SwingTheVine/Wplace-BlueMarble/releases" target="_blank" rel="noopener noreferrer"><img alt="Latest Release" src="https://img.shields.io/github/v/release/SwingTheVine/Wplace-BlueMarble?sort=semver&style=flat&label=Latest%20Release&color=blue"></a>
|
||||
<a href="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/LICENSE.txt" target="_blank" rel="noopener noreferrer"><img alt="Software License: MPL-2.0" src="https://img.shields.io/badge/Software_License-MPL--2.0-slateblue?style=flat"></a>
|
||||
<a href="https://discord.gg/tpeBPy46hf" target="_blank" rel="noopener noreferrer"><img alt="Contact Me" src="https://img.shields.io/badge/Contact_Me-gray?style=flat&logo=Discord&logoColor=white&logoSize=auto&labelColor=cornflowerblue"></a>
|
||||
<a href="" target="_blank" rel="noopener noreferrer"><img alt="WakaTime" src="https://img.shields.io/badge/Coding_Time-87hrs_0mins-blue?style=flat&logo=wakatime&logoColor=black&logoSize=auto&labelColor=white"></a>
|
||||
<a href="" target="_blank" rel="noopener noreferrer"><img alt="Total Patches" src="https://img.shields.io/badge/Total_Patches-450-black?style=flat"></a>
|
||||
<a href="" target="_blank" rel="noopener noreferrer"><img alt="Total Lines of Code" src="https://tokei.rs/b1/github/SwingTheVine/Wplace-BlueMarble?category=code"></a>
|
||||
<a href="" target="_blank" rel="noopener noreferrer"><img alt="Total Comments" src="https://tokei.rs/b1/github/SwingTheVine/Wplace-BlueMarble?category=comments"></a>
|
||||
<a href="" target="_blank" rel="noopener noreferrer"><img alt="Compression" src="https://img.shields.io/badge/Compression-73.04%25-blue"></a>
|
||||
<a href="" target="_blank" rel="noopener noreferrer"><img alt="Build" src="https://github.com/SwingTheVine/Wplace-BlueMarble/actions/workflows/build.yml/badge.svg"></a>
|
||||
<a href="" target="_blank" rel="noopener noreferrer"><img alt="CodeQL" src="https://github.com/SwingTheVine/Wplace-BlueMarble/actions/workflows/github-code-scanning/codeql/badge.svg"></a>
|
||||
|
||||
<h2>Overview</h2>
|
||||
<p>
|
||||
Welcome to Blue Marble! Blue Marble is a userscript for the website <a href="https://wplace.live/" target="_blank">wplace.live</a>. If you like this userscript, please ⭐ the repository!
|
||||
Welcome to Blue Marble! Blue Marble is a userscript for the website <a href="https://wplace.live/" target="_blank" rel="noopener noreferrer">wplace.live</a>. If you like this userscript, please ⭐ the repository!
|
||||
|
||||
<h3>Installation Instructions</h3>
|
||||
<a href="" target="_blank"><img alt="Supported Browsers" src="https://img.shields.io/badge/Supported%20Browsers-Chrome%20%7C%20Some%20Firefox%20%7C%20Safari%20%7C%20Edge-orange?style=flat"></a>
|
||||
<a href="" target="_blank"><img alt="Unupported Browsers" src="https://img.shields.io/badge/Unsupported%20Browsers-Brave%20%7C%20Some%20FireFox%20%7C%20Kiwi-red?style=flat"></a>
|
||||
<a href="" target="_blank" rel="noopener noreferrer"><img alt="Supported Browsers" src="https://img.shields.io/badge/Supported%20Browsers-Chrome%20%7C%20Firefox%2A%20%7C%20Safari%20%7C%20Edge%20%7C%20Brave-orange?style=flat"></a>
|
||||
<a href="" target="_blank" rel="noopener noreferrer"><img alt="Unupported Browsers" src="https://img.shields.io/badge/Unsupported%20Browsers-FireFox%2A%20%7C%20Kiwi%20%7C%20Vivaldi-red?style=flat"></a>
|
||||
<p>
|
||||
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.
|
||||
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. Some versions/forks of FireFox work. Some versions/forks of FireFox do not work.
|
||||
<br>
|
||||
Here is how you install the Blue Marble userscript:
|
||||
Installation instructions for Blue Marble are below. Click the arrows to expand the instructions you want to see. Blue text is a link.
|
||||
<details>
|
||||
<summary>
|
||||
<b>Computer - Chrome</b> <sup>(Click to Expand)</sup>
|
||||
</summary>
|
||||
<ol>
|
||||
<li>Install the <a href="https://chromewebstore.google.com/detail/tampermonkey/dhdgffkkebhmkfjojejmpbldmpobfkfo" target="_blank" rel="noopener noreferrer">TamperMonkey</a> plugin for Chrome.
|
||||
<br>
|
||||
<img alt="Click the 'Add extention' button" src="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/assets/ComputerChromeInstall1.png"></li>
|
||||
<li>Right-click the extention.
|
||||
<br>
|
||||
<img alt="Enter the 'Manage Extention' menu" src="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/assets/ComputerChromeInstall2.png"></li>
|
||||
<li>Left-click "Manage Extension."</li>
|
||||
<li>Enable "Developer Mode."
|
||||
<br>
|
||||
<img alt="Enable 'Developer Mode' and 'Allow user scripts'" src="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/assets/ComputerChromeInstall3.png"></li>
|
||||
<li>Enable "Allow user scripts."</li>
|
||||
<li>Download the <a href="https://github.com/SwingTheVine/Wplace-BlueMarble/releases" target="_blank" rel="noopener noreferrer">BlueMarble.user.js</a> file.</li>
|
||||
<li>Open the TamperMonkey Dashboard.
|
||||
<br>
|
||||
<img alt="Enter the TamperMonkey 'Dashboard'" src="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/assets/ComputerChromeInstall4.png"></li>
|
||||
<li>Drag the <code>BlueMarble.user.js</code> file inside the dashboard of TamperMonkey.
|
||||
<br>
|
||||
<img alt="Drag the userscript into the dashboard" src="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/assets/ComputerChromeInstall5.png"></li>
|
||||
<li>Click the "Install" button to install Blue Marble.
|
||||
<br>
|
||||
<img alt="Click the 'Install' button" src="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/assets/ComputerChromeInstall6.png"></li>
|
||||
<li>Enable Blue Marble inside the TamperMonkey dashboard.
|
||||
<br>
|
||||
<img alt="Enable Blue Marble" src="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/assets/ComputerChromeInstall7.png"></li>
|
||||
<li>Refresh the <a href="https://wplace.live/" target="_blank" rel="noopener noreferrer">wplace.live</a> webpage.</li>
|
||||
</ol>
|
||||
</details>
|
||||
</p>
|
||||
|
||||
<h3>Template Instructions</h3>
|
||||
<p>
|
||||
Blue Marble will display your template as the same size. If your image is 500 pixels tall and 300 pixels wide, the template will be 500 pixels tall and 300 pixels wide. Here is the instructions to display a template image on the canvas:
|
||||
<ol>
|
||||
<li>Install <a href="https://www.tampermonkey.net/index.php" target="_blank">TamperMonkey</a>.</li>
|
||||
<li>Enable Developer Mode & Userscripts (on Chrome).</li>
|
||||
<li>Download the <a href="https://github.com/SwingTheVine/Wplace-BlueMarble/releases" target="_blank">BlueMarble.user.js</a> file.</li>
|
||||
<li>Put the <code>BlueMarble.user.js</code> file inside the dashboard of TamperMonkey.</li>
|
||||
<li>Enable BlueMarble inside TamperMonkey</li>
|
||||
<li>Find the pixel of the top left corner. Fill in <code>Tl X</code>, <code>Tl Y</code>, <code>Px X</code>, and <code>Px Y</code> with the coordinates. You can use the "Pin" icon to auto-fill the coordinates after clicking the pixel.
|
||||
<br>
|
||||
<img alt="Find template coordinates" src="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/assets/TemplateCoordinates1.png"></li>
|
||||
<li>Upload a PNG or WEBP image.</li>
|
||||
<li>Click the "Enable" button.</li>
|
||||
</ol>
|
||||
</p>
|
||||
|
||||
<h3>Script Settings</h3>
|
||||
<p>
|
||||
There are many settings available for the Blue Marble userscript! Through these settings, you can control how the script behaves.
|
||||
<!--
|
||||
<h4>Stealth Mode</h4>
|
||||
<a href="" target="_blank"><img alt="Default: Enabled" src="https://img.shields.io/badge/Default-Enabled-lightgreen?style=flat"></a>
|
||||
<p>
|
||||
|
|
@ -75,6 +113,7 @@
|
|||
<p>
|
||||
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 <b>Possessed Mode</b> is enabled, Blue Marble will teleport the game to the tile, which causes the game to fetch the tile. The difference lies in <i>who</i> sends the request to the server. When <b>Stealth Mode</b> and <b>Possessed Mode</b> are both enabled, it is harder to detect the userscript since most actions are made through the game, not the userscript.
|
||||
</p>
|
||||
-->
|
||||
</p>
|
||||
|
||||
<h3>Template Settings</h3>
|
||||
|
|
@ -85,9 +124,16 @@
|
|||
</p>
|
||||
<h4>Coordinates</h4>
|
||||
<p>
|
||||
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.
|
||||
<br>
|
||||
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.
|
||||
<h5>Tile Coordinates</h5>
|
||||
<p>
|
||||
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. In Blue Marble, the tile coordinates and the pixel coordinates are displayed when you click on a pixel. These are the coordinates you should use for aligning a template.
|
||||
<br>
|
||||
<img alt="Where to find tile coordinates" src="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/assets/TemplateCoordinatesDisplay.png">
|
||||
</p>
|
||||
<h5>Template Coordinates</h5>
|
||||
<p>
|
||||
The template is aligned from the top left corner of the template. You can auto-fill this position using the "pin" icon next to the coordinate input boxes.
|
||||
</p>
|
||||
</p>
|
||||
</p>
|
||||
</p>
|
||||
|
|
|
|||
BIN
docs/assets/ComputerChromeInstall1.png
Normal file
|
After Width: | Height: | Size: 404 KiB |
BIN
docs/assets/ComputerChromeInstall2.png
Normal file
|
After Width: | Height: | Size: 30 KiB |
BIN
docs/assets/ComputerChromeInstall3.png
Normal file
|
After Width: | Height: | Size: 96 KiB |
BIN
docs/assets/ComputerChromeInstall4.png
Normal file
|
After Width: | Height: | Size: 50 KiB |
BIN
docs/assets/ComputerChromeInstall5.png
Normal file
|
After Width: | Height: | Size: 152 KiB |
BIN
docs/assets/ComputerChromeInstall6.png
Normal file
|
After Width: | Height: | Size: 165 KiB |
BIN
docs/assets/ComputerChromeInstall7.png
Normal file
|
After Width: | Height: | Size: 24 KiB |
BIN
docs/assets/TemplateCoordinates1.png
Normal file
|
After Width: | Height: | Size: 215 KiB |
BIN
docs/assets/TemplateCoordinatesDisplay.png
Normal file
|
After Width: | Height: | Size: 63 KiB |