/stonecutter-electron

A text editor for mcfunction

Primary LanguageJavaScriptMIT LicenseMIT

Stonecutter

A text editor for creating Minecraft datapacks.

What?

Stonecutter is an all-in-one .json and .mcfunction editor. Our goal is for it to include syntax highlighting, formatting, linting and debugging for both formats. It is also built with tinkering in mind, so that you could build the environment that suits you best.

Why?

The current state of datapack development is not good. Most novice to mid-level programmers use Notepad++ which, while not bad, is very rudimentary. We aim to fix that by creating an extensible, yet user-friendly and lightweight IDE which include tools you need as a datapack creator.

Installation

GitHub Release

To install Stonecutter, simply download the latest release package from our releases page.

Note: Stonecutter is still in very, very early development. Usage is likely to be lackluster and buggy at times.

Building from Source

Prerequisites:


# Clone the repository
$ git clone https://github.com/3174N/stonecutter-electron.git
$ cd stonecutter-electron
# Install dependencies
$ npm ci
# Build the app
$ npm run make
# Open your app
## macOS:
$ open out/Stonecutter-<version>.dmg
## Windows:
$ "out\Stonecutter Setup <version>.exe"
## Linux:
$ tar -xvzf out/stonecutter-electron-<version>.tar.gz
$ out/stonecutter-electron-<version>/stonecutter-electron

Getting Help

Got stuck? Need help? The official documentation for Stonecutter is hosted hereNot yet implemented. If you've encountered a bug, please check the issues page to see if we know of it, and if not, file a bug report!

License

Copyright (c) 2021 3174N & SFR

We strongly believe in and endorse the open source community, and as such, Stonecutter is licensed under the MIT permissive license. Simply put, we grant you the right to freely mod, fork, change, give, sell and repackage this application, as long as you provide proper credit. Go nuts.