crmod-api

Version:

A dynamic mod/asset generator for Cosmic Reach

9 lines • 21.7 kB

HTML

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>crmod-api</title><meta name="description" content="Documentation for crmod-api"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">crmod-api</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>crmod-api</h2></div><div class="tsd-panel tsd-typography"><a id="md:cosmic-reach-modding-api" class="tsd-anchor"></a><h1><a href="#md:cosmic-reach-modding-api">Cosmic Reach Modding API</a></h1><a id="md:dynamic-asset-generation-for-cosmic-reach" class="tsd-anchor"></a><h3><a href="#md:dynamic-asset-generation-for-cosmic-reach">Dynamic asset generation for <a href="https://finalforeach.itch.io/cosmic-reach">Cosmic Reach</a></a></h3>This library creates a pipeline for creating and compiling mods using only JavaScript. It can create blocks (with many different states), block events (referred to as "trigger sheets"), block models, and even procedural textures. <a id="md:examples" class="tsd-anchor"></a><h1><a href="#md:examples">Examples</a></h1><a id="md:basic-stone-block" class="tsd-anchor"></a><h3><a href="#md:basic-stone-block">Basic Stone Block</a></h3>The following is an example script for a mod that adds a stone block that does, well, nothing. <pre><code class="language-js">import { Mod, BlockModel, ModelCuboid, Material, Writer } from "crmod-api"; import { Box3, Vector3 } from "three"; const writer = new Writer("./build"); // Output directory of the mod const mod = new Mod("examplemod", writer); // Create a mod with the prefix "examplemod" const block = mod.createBlock("stone"); // Will write to "./build/blocks/block_examplemod_stone.json const model = new BlockModel("stone"); // Will write to "./build/models/blocks/model_examplemod_stone.json /* ===================== Create the block model ======================== */ // Create a cuboid that spans a whole block (each "unit" is one sixteenth of a block: one pixel in a texture) const cube = new ModelCuboid(new Box3( new Vector3(0, 0, 0), new Vector3(16, 16, 16) )); // Make sure the block will respond to ambient occlusion (the default is `false`) cube.setAmbientOcclusionEnabled(true); // Use the default stone texture ("materials" are different texture entries usually found at the top of the // model; they're called "textures" in the game, but they behave more like materials with texture maps) cube.setAllMaterials(new Material("stone.png")); // Models are made up of cuboids with different materials and properties model.addCuboid(cube); const state = block.createBlockState(model); // Create a default block state with our new model /* ============== Compile the mod ================= */ // Gets the folders ready for a mod to write to (deletes existing files!) // TIP: this leaves `blocks/textures/` intact. // (This is a separate function in case multiple mods should be compiled at once) await writer.createOutputDir(); // Compiles the mod and writes it to the directory await mod.write(); </code><button>Copy</button></pre> <hr> <a id="md:glowing-cheese" class="tsd-anchor"></a><h3><a href="#md:glowing-cheese">Glowing Cheese</a></h3>The following is an example script for a mod that adds a glowing cheese block that, when interacted with, disappears. No cheese for you! <pre><code class="language-js">import { Mod, BlockModel, ModelCuboid, Material, TriggerSheet, BlockAction, Writer } from "crmod-api"; import { Box3, Vector3 } from "three"; const writer = new Writer("./build"); const mod = new Mod("examplemod", writer); const myBlockId = "magic_cheese"; // So we don't have to type it multiple times const block = mod.createBlock(myBlockId); // Will write to "./build/blocks/block_examplemod_magic_cheese.json const model = new BlockModel(myBlockId); // Will write to "./build/models/blocks/model_examplemod_magic_cheese.json /* ===================== Create the block model ======================== */ const cube = new ModelCuboid(new Box3( new Vector3(0, 0, 0), new Vector3(16, 16, 16) )); cube.setAmbientOcclusionEnabled(true); cube.setAllMaterials(new Material("cheese.png")); model.addCuboid(cube); /* ============================================= Create the block's trigger sheet (block event) ================================================ */ // Trigger sheets (called "block events" by the game) are usually unique per block state const triggerSheet = new TriggerSheet(myBlockId); triggerSheet.addAction("onInteract", BlockAction.replaceBlock(0, 0, 0, "base:air[default]")); /* State parameters are added after a block state is created. It cannot be passed while constructing. The second parameter specifies custom options. You can change the block's state parameters by calling `state.id.set("param", "value")` Only parameters added by `block.defaultState.add("param", "defaultValue")` can be changed. */ const state = block.createBlockState(model, { triggerSheet: triggerSheet, lightLevelRed: 15, lightLevelGreen: 13, lightLevelBlue: 2 }); /* ============== Compile the mod ================= */ await writer.createOutputDir(); await mod.write(); </code><button>Copy</button></pre> </div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>Protected</label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>Private</label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>Inherited</label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>External</label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:cosmic-reach-modding-api">Cosmic Reach Modding API</a><ul><li><ul><li><a href="#md:dynamic-asset-generation-for-cosmic-reach">Dynamic asset generation for Cosmic Reach</a></li></ul></li></ul><a href="#md:examples">Examples</a><ul><li><a href="#md:basic-stone-block">Basic Stone Block</a></li><li><a href="#md:glowing-cheese">Glowing Cheese</a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg>crmod-api</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><div class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></div><div class="overlay"></div></body></html>