Skip to content

Latest commit

 

History

History
35 lines (21 loc) · 2.26 KB

README.md

File metadata and controls

35 lines (21 loc) · 2.26 KB

Magikcraft

Test

Docker Image

Magikcraft is a patched version of ScriptCraft that adds a few things that we missed:

  • Support for installing ScriptCraft-compatible packages from NPM, and publishing your code there to share with other developers.
  • Polyfills for modern JS like Promises, Array.filter, Array.from, Array.includes, EventEmitter, Object.assign, and String.includes.
  • Jasmine for unit-testing your code in Minecraft.
  • Test Docker containers with various MC server / JVM combinations for testing ScriptCraft and identifying and fixing issues.

See the README in this repo for some more details.

You can install Magikcraft in your own Bukkit-compatible Minecraft server (see INSTALL.md), run a server using the magikcraft/scriptcraft Docker image, or use our hosted instance with a web-based code editor at magikcraft.io.

When used with the smac command-line utility, you can run a dockerised Magikcraft server with a TypeScript / JavaScript REPL at the console.

You can create your own Magikcraft-compatible NPM packages using our Yeoman generator.

Relationship with ScriptCraft

MagikCraft is downstream from ScriptCraft. We maintain our own patch set and testing in Magikcraft, and contribute fixes to ScriptCraft code upstream to the ScriptCraft project, so that the wider ScriptCraft community benefits from them.

Building from source

Pre-requisites:

  • Java JDK
  • ant
  • Node.JS
  • NPM

Run the command npm run build:dist. This will build the distribution in the build directory.