Skip to content

pixelkat5/Wplace-Red-planet

 
 

Repository files navigation

Red Planet
Quick Guide
Overview
  Installation Instructions
  Script Settings
  Template Settings
How Versioning Works
FAQ
  Is Red Planet malware?
  How can Red Planet place pixels for me?
  How do I hide the overlay?
  Why do game notifications appear on top of the overlay?

Red Planet

Contact Me WakaTime Total Patches Total Lines of Code Total Comments Compression Repo Size Visitors Downloads Build Pages CodeQL OpenSSF Best Practices

Quick Guide

Press the arrows to reveal the option you want.

I want to download Red Planet. (Click to Expand) Click here to view the installation instructions.
I want to ask questions about Red Planet. (Click to Expand) Click here for the Discord server invite to the Red Planet support server.
Click here for the GitHub help & question page for Red Planet.
I want to report a bug. (Click to Expand) Click here to report a bug, then choose the "Bug Report" option.
I want to suggest a feature. (Click to Expand) Click here to suggest a feature, then choose the Feature Request" option.
I want to contribute. (Click to Expand) Click here to read the contributing guidelines.
I want to report a vulnerability. (Click to Expand) Click here to submit a vulnerability report.

Overview

Welcome to Red Planet! Red Planet is a userscript for the website wplace.live. The purpose of Red Planet is to allow you to take an image, and layer it onto the canvas! That way, you can easily trace the image of your art, without having to look back and forth between multiple tabs/monitors. In addition, Red Planet supports some neat extra features such as:

  • Displaying the number of pixels you need to level up
  • Displaying a simple coordinate system (tile coordinats & pixel coordinates)
  • Allowing you to move the color palette to the top of the screen when placing pixels
  • Allowing you to use the eyedropper on the template image, provided the colors are correct
  • ...and more!
If you like this userscript, please ⭐ the repository! For more information and updates, visit the Red Planet website. If you wish to contribute to Red Planet, check out the CONTRIBUTING.md file in docs/.

Showcase image of Red Planet template

Installation Instructions

Supported Browsers Unupported Browsers

Red Planet has been verified to work on mobile devices. Red Planet was designed on Chrome, but Red Planet might work on "unsupported" browsers not listed above. Some versions/forks of Firefox work. Some versions/forks of Firefox do not work.
Installation instructions for Red Planet are below. Click the arrows to expand the instructions you want to see. Blue text is a link.

Install Chrome (Click to expand) Install Tutorial
  1. Install the TamperMonkey extension for Chrome.
    Click the 'Add extension' button
  2. Right-click the extension.
    Enter the 'Manage Extension' menu
  3. Left-click "Manage Extension."
  4. Enable "Developer Mode."
    Enable 'Developer Mode' and 'Allow user scripts'
  5. Enable "Allow user scripts."
  6. One-click install: Click this link to Install Red Planet directly: Install Red Planet
    TamperMonkey will automatically detect the userscript and prompt you to Install it.
  7. Refresh the wplace.live webpage.
Install on Microsoft Edge (Click to expand)
  1. Install the TamperMonkey plugin for Microsoft Edge.
    Click the 'Get' button
  2. Right-click the extension.
    Enter the 'Manage Extension' menu
  3. Left-click "Manage Extension."
  4. Enable "Developer Mode."
    Enable 'Developer Mode'
  5. Download the BlueMarble.user.js file in the "Assets" of the latest release.
  6. Open the TamperMonkey Dashboard.
    Enter the TamperMonkey 'Dashboard'
  7. Drag the BlueMarble.user.js file inside the dashboard of TamperMonkey.
    Drag the userscript into the dashboard
  8. Click the "Install" button to Install Red Planet.
    Click the 'Install' button
  9. Enable Red Planet inside the TamperMonkey dashboard.
    Enable Red Planet
  10. Refresh the wplace.live webpage.
Install on Firefox (Click to expand)
  1. Install the TamperMonkey plugin for Firefox.
    Click the 'Add to Firefox' button
  2. One-click install: Click this link to Install Red Planet directly: Install Red Planet
    TamperMonkey will automatically detect the userscript and prompt you to install it.
  3. Refresh the wplace.live webpage.

Template Instructions

Red Planet 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:

  1. Find the pixel of the top left corner. Fill in Tl X, Tl Y, Px X, and Px Y with the coordinates. You can use the "Pin" icon to auto-fill the coordinates after clicking the pixel.
    Find template coordinates
  2. Upload a PNG or WEBP image.
  3. Click the "Enable" button.

Script Settings

There are many settings available for the Red Planet userscript! Through these settings, you can control how the script behaves.

Template Settings

Transparent Pixels

Templates for Red Planet 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

Tile 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. In Red Planet, 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.
Where to find tile coordinates

Template Coordinates

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.

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.

FAQ

Is Red Planet malware?

A: Red Planet does not contain malicious code. The Red Planet code can be found in the src/ folder. If you worry about Red Planet being malware, you can read the code, then bundle it yourself using the tools in build/.

How can Red Planet place pixels for me?

A: Unfortunately, Red Planet will not support the automatic placement of pixels without user interaction because it is not allowed by Wplace.

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

About

A versatile template overlay for wplace.live

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 95.5%
  • CSS 4.5%