@projectsophon/df-plugin-dev-server

@projectsophon/df-plugin-dev-server

An ESBuild server for Dark Forest plugin development.

Installation

You can install the command globally using:

npm i -g @projectsophon/df-plugin-dev-server

Usage

Once installed, you should have access to the command:

df-plugin-dev-server

You can see the supported flags by running:

df-plugin-dev-server

Start a Dark Forest plugin development server.

Options:
  --help     Show help                                                 [boolean]
  --version  Show version number                                       [boolean]
  --dir      The directory where plugins exist     [string] [default: "plugins"]
  --ext      Extensions to process              [array] [default: [".js",".ts"]]

And then run the server:

df-plugin-dev-server
ESBuild for /Users/user/sophon-plugins/plugins on port 2221
Development server started on http://127.0.0.1:2222/

Plugins

The easiest way to load plugins while developing would be to use something like this in the Dark Forest UI:

// This maps to ./plugins/MyAwesomePlugin.js or ./plugins/MyAwesomePlugin.ts by default
import Plugin from "http://127.0.0.1:2222/MyAwesomePlugin.js"

export default Plugin;

However, Dark Forest plugins are cached, so you'd need to do some sort of cache busting each time you make a change. Luckily, we've taken care of that for you! To get free cache busting, you can add ?dev to the end of your plugin URL.

// Notice the ?dev
import Plugin from "http://127.0.0.1:2222/MyAwesomePlugin.js?dev"

export default Plugin;

Doing the above will proxy your plugin through a cache busting plugin!

License

MIT