npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

mcil-mcedit

v0.1.0

Published

Converts MCIL to an MCEdit schematic

Downloads

8

Readme

MCEdit Exporter

Converts MCIL code to an MCEdit-style schematic, which can then be imported into Minecraft tools such as MCEdit and WorldEdit.

Installation

The compiler is available from NPM

Install for command-line usage:

$ npm install mca-compiler -g

Install for Node-based usage:

$ npm install mca-compiler --save

Command-line Usage

The exporter provides one command, named mcil-mcedit, which accepts a JSON-formatted MCIL object, and outputs an NBT schematic file.

Usage:

mcil-mcedit [file] <schematic> [--help] [-w <width>] [--width <width>] [-h <height>]
            [--height <height>] [-d <depth>] [--depth <depth>] [-c <input>]
            [--code <input>]

mcil-mcedit takes MCIL code from --code (-c for short), [file] (a file path), or stdin (in that order), and converts it to an MCEdit schematic. The --width, --height, and --depth flags (-w, -h and -d for short) allow the maximum schematic size of (100, 100, 100) to be changed.

The exported schematic file will be saved to the path specified in the <schematic> argument.

Node Usage

Three functions are provided: export, exportToFile, and exportToFileSync.

.export(code, dimensions)

Arguments:

  • code - A Javascript object (not a JSON string), containing the MCIL instructions.
  • dimensions - A Javascript object with three numeric properties: width, height, and depth. Specifies the maximum dimensions for the resulting schematic (note: the schematic could be smaller)

Returns: a Buffer object with the NBT binary data.

Creates an NBT-formatted schematic Buffer from the provided MCIL code. The dimensions of the schematic are determined based on the positions of blocks (i.e the schematic will be as small as possible without excluding blocks), however will never be larger than the dimensions provided.

Example:

var mceditExporter = require('mcil-mcedit');

var code = [
  [
    {
      type: "command",
      command: "say",
      params: "Ready?"
    },
    {
      type: "wait",
      duration: 10
    },
    {
      type: "command",
      command: "say",
      params: "GO!"
    }
  ]
];

var buffer = mceditExporter.export(code, {
  width: 50,
  height: 50,
  depth: 50
});

.exportToFile(file, code, dimensions, cb)

  • file - The location of the file to save the schematic as.
  • code - See .export.
  • dimensions - See .export.
  • cb - A function to be called when saving is completed. Called with one argument, error which is defined if a write error occurred.

Exports a schematic and asynchronously saves to a file. See .export for more information.

Example:

var mceditExporter = require('mcil-mcedit');

var code = [
  [
    {
      type: "command",
      command: "say",
      params: "Ready?"
    },
    {
      type: "wait",
      duration: 10
    },
    {
      type: "command",
      command: "say",
      params: "GO!"
    }
  ]
];

mceditExporter.exportToFile("countdown.schematic", code, {
  width: 50,
  height: 50,
  depth: 50
}, function(err) {
  if (err) console.error(err);
  else console.log("Saved the schematic!");
});

.exportToFileSync(file, code, dimensions)

  • file - The location of the file to save the schematic as.
  • code - See .export.
  • dimensions - See .export.

Exports a schematic and synchronously saves to a file. See .export for more information.

Example:

var mceditExporter = require('mcil-mcedit');

var code = [
  [
    {
      type: "command",
      command: "say",
      params: "Ready?"
    },
    {
      type: "wait",
      duration: 10
    },
    {
      type: "command",
      command: "say",
      params: "GO!"
    }
  ]
];

try {
  mceditExporter.exportToFileSync("countdown.schematic", code, {
    width: 50,
    height: 50,
    depth: 50
  });
  console.log("Saved the schematic!");
} catch (ex) {
  console.error(ex);
}