Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 1.86 KB

README.md

File metadata and controls

54 lines (37 loc) · 1.86 KB
Raw

ZenScript Mode

License: MIT MELPA MELPA Stable

zenscript-mode is an Emacs major mode for editing ZenScript code.

It provides font-lock, indentation, syntax checking and, currently primitive, code completion.

Installing

zenscript-mode can currently be installed in the following ways:

package.el

The recommended way to install zenscript-mode is with package.el, the built-in package manager for Emacs.

Zenscript Mode is available on both MELPA and MELPA stable.

With MELPA or MELPA stable set up, and having run M-x package-refresh-contents RET install with the command:

M-x package-install RET zenscript-mode RET

Manual Installation

To install zenscript-mode manually:

  1. Clone this repo into your ~/.emacs.d/ folder.
  2. Add the following to your ~/.emacs.d/init.el or ~/.emacs file: 
    (add-to-list 'load-path "~/.emacs.d/zenscript-mode")
(require 'zenscript-mode)

Usage

To make the most of zenscript-mode, it is important to provide it ZenScript dumps. To do this, in game, run the commands: /ct dumpzs json and /ct dumpzs html.

Then, when editing scripts from the scripts/ folder of that instance, zenscript-mode will be able to provide code completion.

If zenscript-mode cannot find these files, it will ask where they are. If you do not have these files, C-g will quit, and zenscript-mode won't provide code completion.