Settings reference

Asterobot has 19 settings, grouped here by what they're about. You change them on Server > Config (The Config page) or in config.toml. Settings marked as needing a restart only take effect the next time Asterobot starts.

All settings at a glance

On the Config page, each group is a card named after the first part of its keys, and the cards come in alphabetical order rather than in the order of this page.

Connection to Asteroboard

These settings decide where and how Asteroboard reaches Asterobot. The defaults only accept connections from the computer Asterobot runs on. To reach Asterobot from another device, follow Asteroboard on another device rather than changing them one by one, and read Security first.

server.listenAddress

Text. Default 127.0.0.1:8080. Restart needed.

The address and port where Asterobot waits for Asteroboard, written as address:port. With 127.0.0.1, only the computer Asterobot runs on can connect. 0.0.0.0:8080 accepts connections on every network interface of the computer.

Change it when another program already uses port 8080, or when Asteroboard runs on another device. Keep in mind:

• If Asterobot can't use the address, for example because the port is taken, it stops right after starting with An error occurred during the server's initialization process.
• When Asterobot starts, it opens your browser on 127.0.0.1 with this port. That only works when the value is an IP address followed by a port. With a name such as localhost:8080, the terminal shows Failed to open frontend, and Asterobot keeps running: open Asteroboard yourself.
• Asteroboard keeps using its old Server URL after the restart. Open Asterobot's new address in your browser, or change Server URL in Preferences.
• The port also appears in the line Asterobot writes in your Dofus folder for MITM mode (MITM mode).

server.basicAuth

Logins and passwords. Default empty. Restart needed. Hidden.

The logins and passwords someone must enter to reach Asterobot. Empty means no password at all, which is fine as long as only your own computer can connect.

It's edited as JSON on the Config page, one login per entry:

{"alice": "a long password", "bob": "another long password"}

The passwords are stored in plain text in config.toml. Once a login is set, Server > Status shows Password protected (Status and console).

server.tls

On or off. Default off. Restart needed.

Serves Asterobot over HTTPS instead of HTTP. The first time Asterobot starts with this on, it creates its own certificate, tls/cert.pem, and its private key, tls/key.pem, in its data folder (Files and folders). The certificate is valid for three years, only for the names localhost, 127.0.0.1 and ::1, and signed by Asterobot itself, so browsers warn about it until you accept it.

The description on the Config page mentions the file cache directory, but the two files are in the data folder. To get a new certificate, delete them and start Asterobot again.

With this on, Asteroboard's Server URL must start with https://, and the browser Asterobot opens at start uses https://127.0.0.1 with the port of server.listenAddress.

server.skipOpenFrontend

On or off. Default off. No restart needed.

Asterobot opens your browser on Asteroboard each time it starts. Turn this on to stop that, for example on a computer without a screen, or when Asteroboard is already open. It's read each time Asterobot starts.

Logs

The two log levels are independent: one for the terminal Asterobot runs in, one for Server > Console. Both take one of four values, and a level shows its own lines and every level above it:

Status and console explains both places in detail.

logger.cliLevel

Log level. Default INFO. No restart needed.

How much the terminal Asterobot was started from prints. Set it to DEBUG when someone helping you asks for detailed logs, and back to INFO afterwards: debug lines are numerous.

logger.webLevel

Log level. Default INFO. No restart needed.

How much reaches Server > Console. Lines below this level are never sent to Asteroboard at all. The Server level list on the Console tab changes this same setting.

asterobot.net sign-in

website.token

Text. Default empty. No restart needed. Hidden.

The sign-in Asterobot uses on asterobot.net. Asterobot stores it when you confirm a sign-in code, and empties it when you log out. There's no reason to type anything here.

Anyone who gets this value can use your asterobot.net access, so never share it (Getting help). Resetting it signs Asterobot out.

website.showQRCode

On or off. Default off. No restart needed.

Prints the sign-in link as a QR code in the terminal, so you can confirm the code from a phone. Useful when Asterobot runs on a machine without a browser. It applies from the next code Asterobot asks for. See Sign in with asterobot.net.

website.signedOut

On or off. Default off. No restart needed.

Turned on when you log out, and off again when you sign in. While it's on, Asterobot never starts a sign-in by itself, not even after a restart. Leave it to the account button: turning it off by hand only lets Asterobot start a new sign-in on its own the next time it needs your account. See Your account.

MITM mode

These settings only matter for bots in MITM mode, short for man-in-the-middle, where a bot relays the Dofus you play. A bot that signs in on its own never uses them. MITM mode explains the mode, and MITM across machines the setups where Dofus runs on another computer.

botmanager.mitmSignInPort

Number. Default 5555. Restart needed.

The port your Dofus signs in on once its files point at Asterobot. Change it only when another program on this computer already uses the port. It must differ from botmanager.mitmSessionPort.

botmanager.mitmSessionPort

Number. Default 5556. Restart needed.

The port your Dofus opens its game session on, after signing in. One port serves every relayed bot: Asterobot tells the sessions apart by what they send. Change it only when another program already uses the port.

botmanager.mitmBindHost

Text. Default 127.0.0.1. Restart needed.

The network interface the two ports listen on. 127.0.0.1 only accepts connections from this computer, which is right when you play on it. To relay a Dofus running on another computer, set this computer's address on your network, or 0.0.0.0 for every interface. Anything on that network can then reach the two ports.

botmanager.mitmAdvertiseHost

Text. Default empty. Restart needed.

The address your Dofus is told to connect to. Empty uses botmanager.mitmBindHost, or 127.0.0.1 when that one is 0.0.0.0. Set it when Asterobot is bound to 0.0.0.0, or sits behind a NAT, to the address the Dofus computer can actually reach.

botmanager.mitmGamePath

Text. Default depends on the system. No restart needed.

The folder of the Dofus you play, the one the Ankama Launcher installed. Asterobot reads the version number of its Dofus_Data/StreamingAssets/version file and edits one line of it while a bot waits for your game, and reads nothing else from that folder.

The default is only filled in when that folder exists as Asterobot starts. Set the folder yourself on macOS, or when your Dofus is installed somewhere else. A new value applies once no bot is waiting for your game.

Automatic Ankama sign-in

These settings refine how Asterobot signs Ankama accounts in through a browser. None of them is needed for automatic sign-in to work: storing an account's password is what turns it on. Automatic sign-in explains the whole process.

zaapmanager.browserHeadless

On or off. Default on. No restart needed.

Runs the sign-in browser without a window. Turn it off, on a computer with a screen you're sitting at, to watch the sign-in and answer a challenge Ankama shows. Turn it back on afterwards. It applies from the next sign-in.

zaapmanager.browserPath

Text. Default empty. No restart needed.

The full path of the browser used to sign in to Ankama. Empty makes Asterobot look for Google Chrome, Chromium or Microsoft Edge in their usual places. Set it for a browser installed somewhere unusual, or for another Chromium-based browser such as Brave, Vivaldi or Opera. When it's set, Asterobot uses that browser only.

zaapmanager.browserUserAgent

Text. Default empty. No restart needed.

How the sign-in browser identifies itself to the pages it opens. Empty presents it as Chrome on Windows 11, with the major version number of the browser actually installed. Whatever you enter replaces that identity. Leave it empty unless you have a precise reason to change it.

Game download lists

When Asterobot downloads game versions, it keeps copies of two kinds of lists from Ankama's download servers in its cache folder: the list of available game versions, and for each version, the list of files it's made of. These two settings limit how many copies it keeps. You'll rarely need to change them.

cytrus.keepMostRecentIndexes

Number. Default 5. No restart needed.

How many copies of the list of available game versions Asterobot keeps. Older copies are deleted. 0 keeps every copy. The gamemanager registry command lists the versions found in the copies that are kept (Command line).

cytrus.keepMostRecentGamesManifests

Number. Default 5. No restart needed.

How many lists of files Asterobot keeps for each game. Older ones are deleted. 0 keeps them all.

Where to go next

• The Config page
• Command line