Configuration

All of difys' configuration is done on the interface of our website.

In this doc, we will go through the various configurations to manually set up Difys.

Accounts

~/config/accounts.json

First things first, let's add a couple of accounts

Here's an example accounts.json which represents adding a new account:

{
    "myUsername": {
        "disabled": true,
        "username": "myUsername",
        "password": "mySuperSecretPassword",
        "proxy": false,
        "directLogin": false,
        "script": "test",
        "groupId": 0
    },
    "Zed": {
        "disabled": false,
        "username": "Zed",
        "password": "mySuperSecretPassword",
        "proxy": "135.65.43.11",
        "directLogin": false,
        "server": "Oshimo",
        "character": "myCharacterName",
        "script": "test",
        "groupId": 1
    }
}

Note on boilerplate

myUsername must be written twice, if your username is Alistar, you'll have to both define it as a property in the account list and as a value for username.

Resulting in Alistar.username = "Alistar"

This is called normalizing and it helps with easy access to the data, you'll find the same pattern in our generalized redux data store docs

An account is an object inside the account list.

disabled boolean

  • true: Difys will ignore this account and never be initialized
  • false: Difys will initialize this account

directLogin boolean

  • true: difys will ignore server and character and will directly connect you to the last character you were connected to.
  • false: difys will check the server and the character and tries to connect you to it.

proxy string

If you want, you can specify a proxy. We highly recommend using proxies, check our usage guide to help secure yourself against bans

groupId number

This is much easier to manage it in the interface, but it simply tells the script that they must act in a group.

General

~/config/general.json

Holds the general configuration of difys.

{
    "telemetry": true,
    "lang": "fr",
    "country": "fr",
    "debug": true,
    "antiAfk": true,
    "delays": {
        "connection": 1500,
        "reconnection": 4000,
        "startupActions": 400
    },
    "difysAPI": {
        "enabled": true,
        "port": 5960,
        "defaultRole": "USER",
        "userRoles": {
            "ADMIN": "GET,POST",
            "USER": ""
        },
        "users": [
            {
                "username": "admin",
                "password": "mysUpErSEcuRepasSwoRd",
                "role": "ADMIN"
            }
        ]
    },
    "cluster": {
        "enabled": false,
        "maxCPUCores": 0
    },
    "databases": [
        {
            "_type": "mongo",
            "host": "localhost",
            "port": 27017,
            "dbname": "gamedata"
        }
    ]
}

telemetry boolean

This is not working for the moment, but will be in the future.

Enabling this will send some usage data to difys, in order to make it better.

What you will send

  • Performance data including CPU usage, memory etc..
  • Platforms difys is used on
  • Fights data
  • Map data informations (such as resources types and more)

What you will not send

  • Any account information that could lead to an individual associating you in-game and any authentication information including your username, password and connection tokens.

debug boolean

  • true: Shows debug messages
  • false: Doesn't show debug messages

cluster.enabled boolean

If enabled, Difys will duplicate its power depending on maxCPUCores.

This is only usefull when your computer cannot support a big amount of accounts at the same time.

cluster.maxCPUCores number

Defines the number of power Difys will ask to your computer, depending on how much cores you have.

← InstallationMotivation →