npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@kp-mods/mods-settings

v3.2.0

Published

[![pipeline status](https://gitgud.io/karryn-prison-mods/mods-settings/badges/master/pipeline.svg?ignore_skipped=true)](https://gitgud.io/karryn-prison-mods/mods-settings/-/commits/master) [![Latest Release](https://gitgud.io/karryn-prison-mods/mods-setti

Downloads

42

Readme

Mods Settings

pipeline status Latest Release Discord server

[TOC]

Description

Adds menu with settings to configure mods.

Download

Download the latest version of the mod.

Installation

Use this installation guide.

Preview

For mod creators

How to add settings to your mod

Let's take mod MyMod.js as an example:

// #MODS TXT LINES:
// {"name":"MyMod","status":true,"description":"","parameters":{}}
// #MODS TXT LINES END
console.log('Very useful mod here!');

There are two ways to register settings:

  • Register settings using global library

    To add settings to the mod perform following steps:

    1. Add dependency to your mod's declarations (at the beginning). It will ensure that ModsSettings loaded before MyMod. Changes in MyMod.js:

       // #MODS TXT LINES:
      +// {"name":"ModsSettings","status":true,"parameters":{}}
       // {"name":"MyMod","status":true,"description":"","parameters":{}}
       // #MODS TXT LINES END
    2. Optional. Install and use types if you want to operate with strongly typed settings.

      1. Install types:
        npm install -D @kp-mods/mods-settings
      2. Add types to your mod: Changes in MyMod.js:
         // #MODS TXT LINES:
         // {"name":"ModsSettings","status":true,"parameters":{}}
         // {"name":"MyMod","status":true,"description":"","parameters":{}}
         // #MODS TXT LINES END
        +/// <reference types="@kp-mods/mods-settings" />
         console.log('Very useful mod here!');
      3. Register settings. Intelli-sense will help you if you didn't skip step 2. After this step specified settings will be available in mods menu.
        // Name of the mod must be the same as js filename.
        const settings = ModsSettings.forMod('MyMod')
            .addSettings({
                // Adds ON/OFF setting with description
                isEnabled: {
                    type: 'bool',
                    defaultValue: true,
                    description: {
                        title: 'Is Enabled',
                        help: 'Enables mod'
                    }
                },
                // Adds value gauge with range from 0 to 1 and step of 0.1 (without description)
                someValueYouWillUse: {
                    type: 'volume',
                    defaultValue: 1,
                    step: 0.1,
                    minValue: 0,
                    maxValue: 1
                }
            })
            .register();
      4. Use settings:
        if (settings.get('isEnabled')) {
            const usefulValue = settings.get('someValueYouWillUse') * 100;
            console.log('Very useful mod here! Useful value is: ' + usefulValue);
        }

      Resulted MyMod.js:

      // #MODS TXT LINES:
      // {"name":"ModsSettings","status":true,"parameters":{}}
      // {"name":"MyMod","status":true,"description":"","parameters":{}}
      // #MODS TXT LINES END
      /// <reference types="@kp-mods/mods-settings" />
      
      // Register settings.
      const settings = ModsSettings.forMod('MyMod')
          .addSettings({
              isEnabled: {
                  type: 'bool',
                  defaultValue: true,
                  description: {
                      title: 'Is Enabled',
                      help: 'Enables mod'
                  }
              },
              someValueYouWillUse: {
                  type: 'volume',
                  defaultValue: 1,
                  step: 0.1,
                  minValue: 0,
                  maxValue: 1
              }
          })
          .register();
      
      // Use settings
      if (settings.get('isEnabled')) {
          const usefulValue = settings.get('someValueYouWillUse') * 100;
          console.log('Very useful mod here! Useful value is: ' + usefulValue);
      }
  • Register settings using a module

    Alternatively, you can import the library as module, if you use bundler (e.g. webpack):

    1. Add dependency to your mod's declarations (at the beginning). It will ensure that ModsSettings loaded before MyMod. Changes in MyMod.js:
       // #MODS TXT LINES:
      +// {"name":"ModsSettings","status":true,"parameters":{}}
       // {"name":"MyMod","status":true,"description":"","parameters":{}}
       // #MODS TXT LINES END
    2. Install library @kp-mods/mods-settings
      npm install @kp-mods/mods-settings
    3. Register settings. After this step specified settings will be available in mods menu.
      import {registerMod} from '@kp-mods/mods-settings';
      // or if you use don't use typescript:
      // const {registerMod} = require('@kp-mods/mods-settings');
      
      // Name of the mod must be the same as js filename.
      const settings = ModsSettings.forMod('MyMod')
          .addSettings({
              // Adds ON/OFF setting with description
              isEnabled: {
                  type: 'bool',
                  defaultValue: true,
                  description: {
                      title: 'Is Enabled',
                      help: 'Enables mod'
                  }
              },
              // Adds value gauge with range from 0 to 1 and step of 0.1 (without description)
              someValueYouWillUse: {
                  type: 'volume',
                  defaultValue: 1,
                  step: 0.1,
                  minValue: 0,
                  maxValue: 1
              }
          })
          .register();
    4. Use settings:
      if (settings.get('isEnabled')) {
          const usefulValue = settings.get('someValueYouWillUse') * 100;
          console.log('Very useful mod here! Useful value is: ' + usefulValue);
      }

    Resulted MyMod.js:

    // #MODS TXT LINES:
    // {"name":"ModsSettings","status":true,"parameters":{}}
    // {"name":"MyMod","status":true,"description":"","parameters":{}}
    // #MODS TXT LINES END
    import {registerMod} from '@kp-mods/mods-settings';
    // or if you use don't use typescript:
    // const {registerMod} = require('@kp-mods/mods-settings');
    
    // Register settings.
       const settings = ModsSettings.forMod('MyMod')
           .addSettings({
               isEnabled: {
                   type: 'bool',
                   defaultValue: true,
                   description: {
                       title: 'Is Enabled',
                       help: 'Enables mod'
                   }
               },
               someValueYouWillUse: {
                   type: 'volume',
                   defaultValue: 1,
                   step: 0.1,
                   minValue: 0,
                   maxValue: 1
               }
           })
           .register();
    
    // Use settings
    if (settings.get('isEnabled')) {
        const usefulValue = settings.get('someValueYouWillUse') * 100;
        console.log('Very useful mod here! Useful value is: ' + usefulValue);
    }

Links

Discord server