Melonity Docs

Project Description ​

The Melonity API allows you to create custom scripts for both standard and custom game modes.

With it, you can build scripts that work with game entities, callbacks, rendering, menu options, and other runtime systems exposed by Melonity.

Melonity loads JavaScript at runtime, but scripts are best developed with a TypeScript-based workflow and then compiled to JavaScript.

This approach gives you:

  • type checking
  • autocomplete
  • better editor support
  • clearer API usage

TIP

If you are starting from scratch, use the project template and follow Preparing the environment.

Declarations ​

The most up-to-date TypeScript declarations are maintained in the GitHub template repository.

When the API declarations are updated, the declarations folder in the template project is updated first. If you need the latest declaration files, use the version from the template repository rather than relying on an older local copy.

Who this documentation is for ​

This documentation is intended for users who already understand the basics of JavaScript or TypeScript and want to build Melonity scripts in a structured way.

It is not only an API reference. It also includes practical setup and workflow guides.

CAUTION

The API is intended for individuals who are familiar with the basics of JavaScript and have minimal practical experience. Please refrain from asking documentation-related questions to Melonity's technical support, as they will be ignored.

Documentation structure ​

The documentation is divided into several main parts:

Developer tools ​

TIP

While in-game, you can press F11 to access the developer tools.

If you are new to the documentation, the best next step is Preparing the environment.