/ScriptableMC-TypeScript

Typescript plugin example for Minecraft 1.15

Primary LanguageTypeScriptGNU General Public License v3.0GPL-3.0

ScriptableMC-TypeScript Example & Libraries

docs docs

Getting Started

  • Install NodeJS/NPM or if you're on linux/macos you can install GraalVM-CE which includes a NodeJS runtime
  • Clone or download and extract this repo git clone https://github.com/astorks/ScriptableMC-TypeScript.git and open the folder cd ScriptableMC-TypeScript
  • Install the required NPM packages npm install

How To Compile The Source

  • Run the TypeScript compiler script npm run compile or npm run watch
  • The compiled scripts will be placed in the dist folder
  • Upload the compiled scripts to your minecraft server scripts folder and execute the /jsrl command ingame or restart the server to load the new scripts

How To Generate Documentation

  • Run the TypeDoc generator script npm run docs
  • The generated documentation will be placed in the docs folder