Mod Creation/Essentials: Difference between revisions

== Creating a Mod ==

A mod in Melvor Idle is simply composed of two parts: metadata and resources.

The '''metadata''' is defined in your mod's mod.io profile page (name, version, previews, etc.) and in a <code>manifest.json</code> file that '''''must''' be located at the root of your mod's directory'' (this holds metadata that tells the Mod Manager how to load your mod).

=== The Manifest ===

Before you begin writing code, it's a good idea to start by defining some metadata in the manifest.json file. A complete manifest.json might look like the following:

   "icon": "assets/icon.png",

   "setup": "src/setup.mjs",

   "load": ["assets/style.css"]

A few important modding APIs (tools) available from JavaScript require a namespace to be defined. This helps the game to keep your mod's data organized - think of this as an id for your mod that will be used by other mods and the game itself to access stored data that you've defined. As such, it's best to choose a namespace that easily identifies your mod in case another mod wants to interact with it.

The namespace can only contain alphanumeric characters and underscores and cannot start with the word "melvor".

|-

| <code>helloWorld</code> || ✔️

While this property is optional, it's good practice to include it to avoid future troubleshooting if you end up using an API that requires a namespace.

An optional icon to be displayed alongside your mod in a number of places, like the My Mods list in the Mod Manager. The value should be the path to the image file relative to the root of your mod (where your manifest is located). Accepted file types for an icon are <code>.png</code> or <code>.svg</code>, and the icon is typically displayed at a maximum of 38px in-game.

''This property is '''required''' only if the <code>"load"</code> property is not present in the manifest''.

This value should be a file path pointing to a JavaScript module to act as the entry-point to your mod; this concept will be covered more in the following section.

''This property is '''required''' only if the <code>"setup"</code> property is not present in the manifest.''

It's also important to note that while <code>.js</code> is considered a valid extension for JavaScript module files for the "setup" property, modules loaded through "load" must end with <code>.mjs</code> or they will be treated as regular script files.

=== Structuring Your Code ===

==== Using Modules (Recommended) ====

There are a number of ways to structure your code to be loaded, whether it's scripts or modules, <code>"setup"</code> or <code>"load"</code>. Each might have a good use case but the recommended approach for most mods is to write your code using [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules JavaScript modules] and to have a single entry-point (defined as <code>"setup"</code> in <code>manifest.json</code>), while leaving the "load" property exclusively for loading your CSS.

Let's start with what a module that's defined as your mod's <code>"setup"</code> entry-point should look like:

export function setup(ctx) {

   console.log('Hello World!');

We export a function named <code>setup</code> here because that is what the Mod Manager looks for when loading a <code>"setup"</code> module. Without one, an error would be thrown when loading this mod. This <code>setup</code> function is called and receives the mod's context object as soon as the mod is loaded, which happens just before the character select screen is visible. Therefore, this mod would write 'Hello World!' to the console at that time.

If we define a helper module helper.mjs:

export function greet(name) {

   console.log(`Hello, ${name}!`);

We can then use code we export in our setup function:

export async function setup({ loadModule }) {

   const { greet } = await loadModule('helper.mjs');

   greet('Melvor'); // > Hello, Melvor!

If you need to access the context object from your helper module, there are two approaches:

1. Pass the context object from the setup function to the loaded module:

export function init(ctx) {

   // Perform actions using the context object here...

   const configService = await ctx.loadModule('configService.mjs');

   configService.init(ctx);

2. Use the <code>getContext</code> method on the global <code>mod</code> object:

const ctx = mod.getContext(import.meta);

export function init() {

   // Perform actions using the context object here...

==== Using Scripts ====

If you choose to include plain scripts in your mod, whether it's out of familiarity or a special use case, you can load (inject) scripts into the game either through the context object (perhaps received from a <code>"setup"</code> module) or the <code>"load"</code> property of the manifest.

Loading a script through the context object is very similar to loading a module but you will not receive back a value.

   // Make sure you await the call to loadScript if your code beyond relies on it

   await loadScript('hello-melvor-script.js');

   // But don't bother awaiting it if it's not time-sensitive

   loadScript('some-independent-script.js');

From inside your script, you can still access the context object:

   // Use the context object here

Note that the mod.register method will only work on scripts injected through either loadScript or the "load" property of the manifest.

== The Context Object ==

Your mod's context object is the central point used for setting up your mod and making modifications to the game. The majority of the other sections in this guide will cover the concepts enabled through the APIs available on the object. For a more in-depth look at the documentation for the context object, refer to the [[Mod Creation/Mod Context API Reference]] guide.

== Accessing Your Mod's Resources ==

Chances are you will package some resources in your mod that aren't covered by the loading options defined in the manifest and instead need to rely on loading these resources through your code. Your mod's context object provides methods for retrieving these resources. Keep in mind that all file path references to your resources should be ''relative to the root of your mod''. Some common scenarios are below.

=== Load (Import) a Module ===

export function greet(name) {

   console.log(`Hello, ${name}!`);

}

export async function setup({ loadModule }) {

   const myModule = await loadModule('my-module.mjs');

   myModule.greet('Melvor'); // Hello, Melvor!

   console.log(myModule.importantData.reverse().join('')); // hello there

=== Load (Inject) a Script ===

export await function setup({ loadScript }) {

   // Wait for script to run

   // Or not

   loadScript('my-independent-script.js');

=== Load (Inject) HTML Templates ===

export function setup({ loadTemplates }) {

   loadTemplates('my-templates.html');

=== Load (Inject) a Stylesheet ===

export function setup({ loadStylesheet }) {

   loadStylesheet('my-styles.css');

=== Load Data from JSON ===

{

   "coolThings": [

     "rocks"

   ]

export async function setup({ loadData }) {

   const data = await loadData('my-data.json');

   console.log(data.coolThings[0]); // ['rocks']  

=== Images, Sounds, and Anything Else ===

export function setup({ getResourceUrl }) {

   const url = getResourceUrl('sea-shanty-2.ogg');

   song.loop = true;

   song.play();

== Game Lifecycle Hooks ==

Utilizing the game's lifecycle hooks will allow your mod to perform actions at specific times, which may be useful for waiting for certain game objects to be available. The game lifecycle hooks are as follows:

All of the game's lifecycle hooks are available through your mod's context object and accept a callback function as a sole parameter. This callback function can be synchronous or asynchronous and will be executed at the specified time and receive your mod's context object as a parameter.

export function setup({ onModsLoaded, onCharacterLoaded, onInterfaceReady }) {

   onModsLoaded(ctx => {

     // Build or modify in-game UI elements

   });

== Mod Settings ==

Your mod can define settings for the player to interact with and visually configure your mod in-game. This feature is accessible through a <code>settings</code> property on the context object. If your mod has any settings defined, your mod will appear in the sidebar under Mod Settings. Clicking this will open up a window with all of your defined settings.

Settings are divided (in code and visually) into sections. Get or create a section using the <code>section(name)</code> method on the <code>settings</code> object. The value passed in for the <code>name</code> parameter is used as a header for the section, so this should be human-readable. These sections are displayed in the order that they are created.

export function setup({ settings }) {

   // Creates a section labeled "General"

   // Future calls to that section will not create a new "General" section, but instead return the already existing one

   settings.section('General');

The object returned from using <code>section()</code> can then be used for adding settings to that section. Refer to the next section for settings configurations.

export function setup({ settings }) {

   const generalSettings = settings.section('General');

     hint: '1 through 10'

   }]);

You can then <code>get</code> or <code>set</code> the value of any defined setting by its <code>name</code> property.

const { settings } = mod.getContext(import.meta);

const generalSettings = settings.section('General');

generalSettings.set('pick-a-number', 1);

=== Setting Types ===

There are currently eight predefined setting types that will automatically create a usable input:

* Label

== Customizing the Sidebar ==

If you want to add or modify the in-game sidebar (the menu with the bank, skills, etc.) there is an globally-scoped in-game API, <code>sidebar</code>, for doing so. The sidebar is organized into four levels:

Each of the customizable (categories, items, subitems) pieces are generally interacted with the same way.

const attack = sidebar.category('Combat').item('Attack'); // Get the Attack item within Combat or create one if it doesn't exist

In addition, these can be called with a configuration object as a second parameter to create or update the existing piece with the new configuration.

   before: 'Attack', // Move the Slayer item above Attack

   ignoreToggle: true // Keep Slayer visible when its category has been hidden

The full definition of each sidebar piece's configuration object can be found in the [[Mod Creation/Sidebar API Reference]] guide.

If you need to retrieve all existing categories, items, or subitems, use their respective methods:

sidebar.category('Combat').items(); // returns an array of all Combat items

Removing categories, items, and subitems is also possible:

sidebar.removeCategory('Combat'); // Alternative (this avoids creating a Combat category if it didn't already exist)

sidebar.removeAllCategories(); // Remove all categories, but why?

// Same kind of structure for items and subitems:

sidebar.category('Modding').item('Mod Manager').remove();

== Storing Data ==

There are two options for storing data for your mod that isn't already saved as part of the game or settings: data saved with a character or data saved to the player's account. For most cases, however, character storage should be the preferred location and account storage used sparingly. Both of these stores are available through your mod's context object, as <code>characterStorage</code> and <code>accountStorage</code>, respectively. Aside from where the data is ultimately saved, character and account storage have identical methods and behaviors. Character storage is not available until after a character has been loaded (<code>onCharacterLoaded</code> lifecycle hook).

export function setup({ characterStorage }) {

   // This would all function identically with accountStorage, but also be available across characters

   characterStorage.clear(); // Removes all currently stored items

=== Limitations ===

Currently, a mod's character storage and account storage are each (separately) limited to 8,192 bytes (8kb) of total data. This means each character can store up to 8kb per mod, but only 8kb total can be  stored to an account.

== Game Object Patching/Hooking ==

A common modding scenario is to want to override/modify an in-game method or perform an action before or after it has completed. Your mod's context object contains a patch property that can be used for this these cases. Patches can only be applied to methods that exist on a JavaScript class (<code>Player</code>, <code>Enemy</code>, <code>CombatManager</code>, <code>Woodcutting</code>, etc.). To start, define the class and method that you want to patch:

export function setup({ patch }) {

   const xpPatch = patch(Skill, 'addXP');

From there you can use that patch to perform any of the following actions.

=== Do Something Before ===

Use the <code>before</code> method on the patch object to execute code immediately before the patched method. In addition, the callback hook will receive the arguments that were used to call the patched method as parameters, and can optionally modify them by returning the new arguments as an array.

export function setup({ patch }) {

     console.log(`Doubling XP from ${amount} to ${amount * 2}!`);

     return [amount * 2, masteryAction]; // Double all XP gains

   });

=== Do Something After ===

Use the <code>after</code> method on the patch object to execute code immediately after the patched method. In addition, the callback hook will receive the value returned from the patched method along with the arguments used to call it as parameters. Optionally, an after hook can choose to override the returned value by returning a value itself. '''''Only''' a return value of <code>undefined</code> will be ignored.''

export function setup({ patch }) {

     if (!willHit) console.log('A miss? I think not!');

     return true;

   });

=== Replace the Method Entirely ===

The <code>replace</code> method on the patch object will override the patched method's body, but before and after hooks will still be executed. The replacement method will receive the current method implementation (the one being replaced) along with the arguments used to call it as parameters. The return value of the replacement method will be the return value of the method call, subject to any changes made in an after hook.

export function setup({ patch }) {

   patch(Skill, 'addXP').replace(function(o, amount, masteryAction) {

     // Double any mining XP

     // Grant all other XP as normal

     return o(amount, masteryAction);

   });

It's important to note that the using the replace method replaces the '''current''' method implementation. This means that multiple replacements on the same patched method will be executed in reverse order than they were declared:

export function setup({ patch, onInterfaceReady }) {

   const xpPatch = patch(Skill, 'addXP');

   console.log('XP replace B');

   return o(amount, masteryAction);

== Exposing APIs ==

If your mod serves as a tool for other mods to integrate with, exposing APIs through the context object using <code>ctx.api</code> is the recommended approach. This is especially useful when paired with a mod developed using modules. The <code>api</code> method accepts an object and will expose any properties on that object to the global <code>mod</code> object within the <code>api['your-mods-namespace']</code> property. You can call the <code>api</code> method multiple times to append more APIs.

{

   "namespace": "helloWorld",

   "setup": "setup.mjs"

export function setup({ api }) {

   api({

     greet: name => console.log(`Hello, ${name!}`);

   });

Other mods would then be able to interact with your API:

== The Dev Context ==

To make it easier to test code before committing to uploading a mod, there is a 'dev' mod context that you can access to try out any of the context object's methods that don't require additional resources, i.e. you can't use <code>loadModule</code>. To access this context, you can use the following in your browser console:

''This method/context '''should not''' be used from within a mod.''

== Next Steps ==

Hopefully this guide covers most common modding scenarios and will be a useful reference during your mod development time. For more in-depth looks at specific concepts, consider checking out the following guides:

* [[Mod Creation/Mod Context API Reference]]

* [[Mod Creation/Sidebar API Reference]]