mirror of
https://github.com/SwingTheVine/Wplace-BlueMarble.git
synced 2026-01-11 22:40:18 +00:00
Update to Wiki Docs
This commit is contained in:
parent
428278f8af
commit
70eb0a26fa
10 changed files with 19 additions and 5 deletions
|
|
@ -28,7 +28,7 @@ console.log(`${consoleStyle.BLUE}Starting build...${consoleStyle.RESET}`);
|
|||
if (isGitHub) {
|
||||
try {
|
||||
console.log(`Generating JSDoc...`);
|
||||
execSync(`npx jsdoc src/ -r -d docs`, { stdio: "inherit" });
|
||||
execSync(`npx jsdoc src/ -r -d docs -t node_modules/minami`, { stdio: "inherit" });
|
||||
console.log(`JSDoc built ${consoleStyle.GREEN}successfully${consoleStyle.RESET}`);
|
||||
} catch (error) {
|
||||
console.error(`${consoleStyle.RED + consoleStyle.BOLD}Failed to generate JSDoc${consoleStyle.RESET}:`, error);
|
||||
|
|
|
|||
|
|
@ -61,6 +61,7 @@
|
|||
<li>I don't want to waste your time, so double check with me before starting a big change like adding a new feature. For example, imagine you spend 50 hours making a bot that automatically places pixels, then your pull request was rejected because a bot that automatically places pixles does not align with the "Mission" of Blue Marble. That would be sad :(</li>
|
||||
<li>Follow the style of the project. E.g., if all overlays are made by calling `Overlay()`, and you want to make a new overlay, you should probably call `Overlay()` as well.</li>
|
||||
<li>Low quality code will be rejected.</li>
|
||||
<li>You can find documentation for Blue Marble <a href="https://swingthevine.github.io/Wplace-BlueMarble/index.html" target="_blank" rel="noopener noreferrer">here</a>.</li>
|
||||
</ul>
|
||||
</p>
|
||||
|
||||
|
|
@ -78,7 +79,7 @@
|
|||
<h2>What Can I Contribute?</h2>
|
||||
<h3>Programming</h3>
|
||||
<p>
|
||||
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 <a href="https://roadmap.sh/javascript" target="_blank" rel="noopener noreferrer">roadmap for learning JavaScript</a>. 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.
|
||||
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 <a href="https://roadmap.sh/javascript" target="_blank" rel="noopener noreferrer">roadmap for learning JavaScript</a>. 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 <a href="https://swingthevine.github.io/Wplace-BlueMarble/index.html" target="_blank" rel="noopener noreferrer">here</a>.
|
||||
</p>
|
||||
<h3>Translation</h3>
|
||||
<p>
|
||||
|
|
|
|||
11
package-lock.json
generated
11
package-lock.json
generated
|
|
@ -1,15 +1,16 @@
|
|||
{
|
||||
"name": "wplace-bluemarble",
|
||||
"version": "0.75.1",
|
||||
"version": "0.76.0",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "wplace-bluemarble",
|
||||
"version": "0.75.1",
|
||||
"version": "0.76.0",
|
||||
"devDependencies": {
|
||||
"esbuild": "^0.25.0",
|
||||
"jsdoc": "^4.0.4",
|
||||
"minami": "^1.2.3",
|
||||
"terser": "^5.43.1"
|
||||
}
|
||||
},
|
||||
|
|
@ -777,6 +778,12 @@
|
|||
"integrity": "sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w==",
|
||||
"dev": true
|
||||
},
|
||||
"node_modules/minami": {
|
||||
"version": "1.2.3",
|
||||
"resolved": "https://registry.npmjs.org/minami/-/minami-1.2.3.tgz",
|
||||
"integrity": "sha512-3f2QqqbUC1usVux0FkQMFYB73yd9JIxmHSn1dWQacizL6hOUaNu6mA3KxZ9SfiCc4qgcgq+5XP59+hP7URa1Dw==",
|
||||
"dev": true
|
||||
},
|
||||
"node_modules/mkdirp": {
|
||||
"version": "1.0.4",
|
||||
"resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz",
|
||||
|
|
|
|||
|
|
@ -9,6 +9,7 @@
|
|||
"devDependencies": {
|
||||
"esbuild": "^0.25.0",
|
||||
"jsdoc": "^4.0.4",
|
||||
"minami": "^1.2.3",
|
||||
"terser": "^5.43.1"
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
/** The overlay builder for the Blue Marble script.
|
||||
* @description This class handles the overlay UI for the Blue Marble script.
|
||||
* @class Overlay
|
||||
* @since 0.0.2
|
||||
* @example
|
||||
* const overlay = new Overlay();
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@ import { uint8ToBase64 } from "./utils";
|
|||
|
||||
/** An instance of a template.
|
||||
* Handles all mathematics, manipulation, and analysis regarding a single template.
|
||||
* @class Template
|
||||
* @since 0.65.2
|
||||
*/
|
||||
export default class Template {
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
/** ApiManager class for handling API requests, responses, and interactions.
|
||||
* Note: Fetch spying is done in main.js, not here.
|
||||
* @class ApiManager
|
||||
* @since 0.11.1
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
/** The main file. Everything in the userscript is executed from here.
|
||||
/** @file The main file. Everything in the userscript is executed from here.
|
||||
* @since 0.0.0
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
/** This class contains all MutationObservers used (which is 1 probably).
|
||||
* This is not an object, but rather a "collection" of functions (in a class).
|
||||
* @class Observers
|
||||
* @since 0.43.2
|
||||
*/
|
||||
export default class Observers {
|
||||
|
|
|
|||
|
|
@ -4,6 +4,7 @@ import { base64ToUint8, numberToEncoded } from "./utils";
|
|||
/** Manages the template system.
|
||||
* This class handles all external requests for template modification, creation, and analysis.
|
||||
* It serves as the central coordinator between template instances and the user interface.
|
||||
* @class TemplateManager
|
||||
* @since 0.55.8
|
||||
* @example
|
||||
* // JSON structure for a template
|
||||
|
|
|
|||
Loading…
Reference in a new issue