Hackmud Scripting Environment

Features

Minification

This is the main feature of this project and works with JavaScript or TypeScript. All scripts are automatically minified before being written into the hackmud folder. This means you can focus less on getting your character count down, and more on writing readable scripts.

Autocompletes/Intellisense

In modern editors like Visual Studio Code, as you're typing the names of subscripts or filling the args of subscripts, drop-down menus of relevant autocompletes will appear. Hovering over a script also tells you info like its security level.

TypeScript Support

Using TypeScript in this environment is completely optional, but using it means warnings when you use the wrong type in a subscript's args or use an unsupported type in a DB query.

First Time Setup

1. Install NodeJS and PNPM.
2. Run pnpm dlx tiged samualtnorman/hackmud-environment.
3. Run pnpm install.
4. Tell the script manager where the hackmud directory is with pnpm hsm config set hackmudPath <hackmud directory>
   • Replace <hackmud directory> with the path to the hackmud directory.
   • You can find your hackmud directory by running #dir in hackmud and going up two directories.

Guide

Writing scripts

You can create scripts in the src directory directly, and you can create a folder with the name of one of your users, and create scripts in that folder too.

Pushing Your Scripts

Use pnpm push to push all your scripts to all your users. To automatically push scripts as you edit them, leave pnpm dev running.

Scripts directly in the src folder are pushed to all your users. To have a script be pushed to only a specific user, create a folder in the src folder and create your scripts in that new folder.

Useful links

• Scripting Reference
• The Trust Scripts
• Color Reference

Optional Features

This is only for if you're using TypeScript.

Alternative Preprocessor Format

To take advantage of the type definitions written for subscripts and preprocessor functions, you'll need to replace the # characters with $ characters. For example instead of writing #fs.scripts.trust(), you'll need to write $fs.scripts.trust(). A big change, I know.

Inter-script Type Checking

To gain type checking for the other scripts you've written in the environment, instead of starting your scripts with function (..., start them with export default function(....

Contributing

Contributing is appreciated, especially if you have an API to add to the type definitions.

Credit

This project was originally a fork of Snazzah's hackmud_env.

Related Projects

Hackmud Color

If you want to see your strings coloured to how they'd appear in the game, check out Hackmud Color, my VS Code extension.

Hackmud Script Manager

This is the script manager that this environment relies on. Visit the NPM page, or the repo.