From eb5198a653d869ad05bb965b352ee450f467b650 Mon Sep 17 00:00:00 2001 From: SwingTheVine Date: Fri, 6 Feb 2026 15:16:13 -0500 Subject: [PATCH] Updated contribution documentation & fixed some typos --- docs/CONTRIBUTING.md | 27 ++++++++++++++------------- docs/README.md | 8 -------- 2 files changed, 14 insertions(+), 21 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 93b79c9..ea03672 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -54,7 +54,7 @@
Note: If you are using AI, and you want to tell the AI how the codebase files are related to each-other, go to the Class diagram of relationships for Blue Marble diagram in the chart section of this file. Copy the chart, and give it to the AI.
- Note: If you are contributing to the documentation of this project, make your fork from the documentation branch. If you are contributing to the code/programming of this project, make your fork from the code branch. If you fork main, and make a PR from main -> main your PR might be rejected. This is because main is not up-to-date, and your changes might conflict with up-to-date changes. + Note: If you are contributing to this project, make your fork from the latest release branch. The latest release branch number should be one MINOR version higher than the current. E.g. if the latest release is 1.2.3, you should fork release/v1.3.0. If you fork main, and make a PR from main -> main your PR might be rejected. This is because main is not up-to-date, and your changes might conflict with the bleeding-edge.

Summary

@@ -62,10 +62,10 @@

@@ -83,14 +83,15 @@

What Can I Contribute?

Programming

- Most of the work to be done in this userscript is related to programming. It is helpful to have a background in programming, but not required. If you are looking to learn JavaScript and its syntax, check out this roadmap for learning JavaScript. We strongly recommend that you understand functions, methods, classes, and Object-Oriented-Programming if you plan to implement a brand new feature. More technical knowledge like method chaining and lambda expressions are useful but not required. You can find the documentation for Blue Marble here. Make your code modular when possible. In other words, you should "blackbox" your code by putting it in a function when possible. For example, if you are adding a color filter to remove colors from being displayed on the template, the function should pass in the template information and tile information, and output the filtered template/tile information. This way, other people's code can't interfere with the color filter. For example: + Most of the work to be done in this userscript is related to programming. It is helpful to have a background in programming, but not required. If you are looking to learn JavaScript and its syntax, check out this roadmap for learning JavaScript. We strongly recommend that you understand functions, methods, classes, and Object-Oriented-Programming if you plan to implement a brand new feature. More technical knowledge like method chaining and lambda expressions are useful but not required. You can find the documentation for Blue Marble here. Make your code modular whenever possible. In other words, you should "blackbox" your code by putting it in a function when possible. For example, if you are adding a color filter to remove colors from being displayed on the template, the function should pass in the template information and tile information, and output the filtered template/tile information. This way, other people's code can't interfere with the color filter. For example:

  1. The template image is generated and the tile information is retrieved.
    2. -
  2. The color filter function is passed in the template image and the tile information. The color filter overrides the template image with the filtered colors, and outputs that as the template image.
    3. -
  3. The pixel counter function is passed in the modified template image and the tile information, and outputs the pixel count.
    4. +
  4. The template image and the tile information is passed into the color filter function. The color filter overrides the template image with the filtered colors, and outputs that as the template image.
    5. +
  5. The modified template image and the tile information is passed into the pixel counter function, and it outputs the pixel count.
  6. The modified template image and the tile information is used to render the template.
+ In the example above, modifying the pixel count code will not modify the color filter. If a PR is made for the pixel count code, and another PR is made for the color filter, both PR's can be merged without conflicts.

Translation

@@ -332,17 +333,17 @@ classDiagram

IDE

Visual Studio Code
- Version: 1.102.3
+ Version: 1.109.0

Browser

Google Chrome
- Version: 138.0.7204.184 (Official Build) (64-bit)
- TamperMonkey Version: 5.3.3 + Version: 144.0.7559.133 (Official Build) (64-bit)
+ TamperMonkey Version: 5.4.1

Operating System

- Windows 10 Home
- Version: 22H2
- OS Build: 19045.6093
+ Windows 11 Home
+ Version: 25H2
+ OS Build: 26200.7705
Processor: Intel Core i7-9750H CPU @ 2.60GHz
RAM: 16.0 GB
Storage: 932 GB SSD Samsung SSD 970 EVO Plus 1TB, 238 GB SSD HFM256GDJTNG-8310A
diff --git a/docs/README.md b/docs/README.md index a51efd6..69a968a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -45,7 +45,6 @@

Blue Marble

-Wplace Status Latest Version Latest Release Software License: MPL-2.0 @@ -57,7 +56,6 @@ Total Comments Compression Repo Size -Visitors Downloads Build Pages @@ -288,12 +286,6 @@

How do get the color of a pixel?

A: Use the eyedropper in the palette menu of wplace. If your template colors match the wplace palette, you can select the template pixel dot to get the template's color for that pixel.

-

How do I tell colors apart?

-

A: Find the color in the color filter list. Click the checkbox to turn the color on or off. If you want to work on only one color at a time (recommended), then click "Disable All" in the color filter. Finally, enable the checkbox next to the color you want to place. This way, only one color on your template will appear at a time.

- -

How do get the color of a pixel?

-

A: Use the eyedropper in the palette menu of wplace. If your template colors match the wplace palette, you can select the template pixel dot to get the template's color for that pixel.

-

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