Accounts.js Users and SetupTools Settings - jakcodex/muledump GitHub Wiki

Links below are valid as of Jakcodex/Muledump v9.4.0.

Note: Using an accounts.js file is considered legacy and no longer the primary method for using Muledump.

One common use case for Muledump is at a shared computer. Typically this involves utilizing the legacy accounts.js system to keep account configurations separate between users.

SetupTools is the program utilized within Muledump to store settings and configuration. It stores configuration data along with account information directly in the browser. This is not suitable to a computer intending to switch between accounts.js files.

Many of the new features offered in Muledump since v7.3 require the use of SetupTools to save settings and configuration. Users relying on accounts.js are given a default SetupTools configuration.

As of Jakcodex/Muledump v9.4 it is now possible to set new configuration values via the accounts.js file.

Warning: You can break Muledump if you put incorrect values into these settings.

See user-config.js for the base information. To use this feature copy the contents of this file to the bottom of your accounts.js file. Editing user-config.js itself won't do anything.

SetupTools Client Configuration Example

A common request is how to change the gift chests width. To change this setting you would look for the line containing:

//    "giftChestWidth": 0,

Remove the "//" to enable the setting. The default value is '0' which means automatic. If you want to set it to a width of 5 then you would change it to read:

    "giftChestWidth": 5,

Here's what your configuration might look like:

userConfiguration.config = {
    "animations": 0,
    "compression": true,
    "giftChestWidth": 5,
    "mulelogin": 1
}

For a full list of client configuration keys and what they do, see the SetupTools Object Reference for more information.

Custom Character Sorting Configuration

Presently you cannot use the Muledump Character Sorting UI to create your list; however, you can write your own list into the configuration object.

Beneath the Client Configuration portion of user-config.js there is a Muledump Configuration section.

The example provided is fairly straight forward. You create a key named after the account guid (i.e. email, steamworks, or kongregate ids). You specify which list is active and then provide a set of named lists using the comma-separated character ID scheme of Character Sorting v1.

Here's what your configuration might look like:

userConfiguration.muledump.chsortcustom = {
    sort: -1,
    disabledmode: false,
    accounts: {
        '[email protected]': {
            active: 'My favorite list',
            data: {
                'My self-named list 1': [1, 4, 5],
                'Some different list name': [44, 90, 300, 2],
                'My favorite list': [900, 339, 22]
            }
        }
    }
},

Muledump Totals ConfigSets

Same caveats apply as character sorting in that you can't use the UI to make permanent changes to these settings. The configuration size is potentially very large for each configSet you create.

The sample configuration in user-config.js includes notes and tips for using each setting.

Here's what your configuration might look like:

userConfiguration.muledump.totals.configSets = {
    "active": "My set name",
    "favorites": ["My set name", "Separate list"],  //  you should add each named config below to this list
    "settings": {
        "My set name": {
            "totalsGlobal": false,
            "nonsbfilter": true,
            "sortingMode": "fb"
        },
        "Separate list": {
            "totalsGlobal": true,
            "nonsbfilter": true,
            "sortingMode": "alphabetical"
        }
    }
};

Feel free to join our Discord for help configuring these settings.