DreamBot's QuickStart / CLI
Power users of DreamBot that want a way to automate and speed up launching their bot farms should look no further than our QuickStart offering.
QuickStart allows users to set a wide array of parameters to control everything from the account that should log in, proxy selection, and even configure supported script settings all from one command.
QuickStart is a VIP feature, so if you're looking to make the most of your bots, consider upgrading today.
Command Line
While the examples below can be directly copy and pasted into a command line of your choice, they can also be put in a script file of your operating system (batch files for Windows, shell scripts on Unix based systems, etc.).
All of these examples will have paths that might not match your system, so you'll need to change them accordingly.
Examples
There are many other parameters supported by QuickStart, these are just a few simple examples showing some common use cases.
You can find at the bottom of this page the full list of supported parameters.
Start a script called "Test Script" on an account with the saved nickname "Account 1", with Covert Mode enabled:
java -jar C:\Users\YOURNAME\DreamBot\Launcher.jar -script "Test Script" -account "Account 1" -covert
java -jar /home/YOURNAME/DreamBot/Launcher.jar -script "Test Script" -account "Account 1" -covert
Same settings as above, but use a proxy saved with a nickname of "US Proxy":
java -jar C:\Users\YOURNAME\DreamBot\Launcher.jar -script "Test Script" -account "Account 1" -covert -proxy "US Proxy"
java -jar /home/YOURNAME/DreamBot/Launcher.jar -script "Test Script" -account "Account 1" -covert -proxy "US Proxy"
You can also start scripts and configure them if they support QuickStart parameters, usually to avoid manually filling out a GUI.
Only scripts that support the QuickStart params will accept and use them, and their format depends on the scripter. If you still need help setting it up, try contacting the scripter directly.
Warning
The params flag must be the last parameter you set as it can take any number of arguments!
java -jar C:\Users\YOURNAME\DreamBot\Launcher.jar -script "Test Script" -params Param1 Param2 Param3
java -jar /home/YOURNAME/DreamBot/Launcher.jar -script "Test Script" -params Param1 Param2 Param3
Warning
This will ignore DreamBot's memory limiting which is normally found at the bottom of the launcher, to limit the memory usage put -Xmx512M before -jar
java -Xmx512M -jar C:\Users\YOURNAME\DreamBot\Launcher.jar -script "Test Script" -params Param1 Param2 Param3
java -Xmx512M -jar /home/YOURNAME/DreamBot/Launcher.jar -script "Test Script" -params Param1 Param2 Param3
Available Parameters
General
| Parameter | Description |
|---|---|
-add-stored-auth=<auth> |
This will add the given stored auth key on start, should be formatted account@email.com:123456789 |
-breaks=<break>[,<break>...] |
Breaks that will be enabled |
-browserProxyHost=<host> |
Proxy host for use in the browser |
-browserProxyPort=<port> |
Proxy port for use in the browser |
-covert |
Covert Mode will be enabled |
-debug |
Debug logging will be enabled |
-destroy |
The client will exit if it fails to load the game |
-destroy-on-ban |
The client will exit if an account is banned or locked during login with our default solver |
-disable-share-cache |
This will force disable the shared cache |
-features=<features>[,<features>...] |
Comma separated list of beta features you want to enable |
-fps=<fps> |
Frames per second the client will run at |
-fresh |
Fresh Start will be enabled |
-height=<height> |
The client's height |
-help, --help |
Shows QuickStart's help information |
-ignore-entity-walk |
Ignores entities when walking on screen |
-json=<path> |
QuickStart settings file. Using this option will ignore all other args provided. |
-layout=<mode> |
The game's layout. Valid values: NO_PREFERENCE, FIXED, RESIZABLE_CLASSIC, RESIZABLE_MODERN |
-maximized |
The client will maximize itself on start |
-minimized |
The client will minimize itself on start |
-mouse-speed=<speed> |
The mouse speed the client should use, should be 1-100 |
-no-covert |
Covert Mode will be disabled |
-nofresh, -no-fresh |
Fresh Start will be disabled |
-remote-debugging-port=<port> |
This will set the remote debugging port for the new account login browser |
-render=<mode> |
Rendering mode of the client. Valid values: NONE, GAME, SCRIPT, ALL |
-userhome=<path> |
This is the user's home directory (used for the game cache among other files) |
-width=<width> |
The client's width |
-world=<world> |
The world to start the client with. Valid values: f2p, members, or a world id (>300) |
DreamBot Account Options
| Parameter | Description |
|---|---|
-email, -username=<email> |
Your DreamBot email |
-password=<password> |
Your DreamBot password |
DreamBot Settings Options
| Parameter | Description |
|---|---|
-delete-account-on-ban |
The client will delete the current account from the Account Manager if it's disabled |
-disable-delete-account-on-ban |
The client will not delete the current account from the Account Manager if it's disabled |
-disable-dismiss-random-events |
Force disables our dismiss random solver |
-disable-no-input-login |
Force disables no input login |
-disable-world-hop-on-login-error |
The client will not change worlds if it there's a login error |
-disableAnimations, -disable-animations |
Disable animations |
-disableLowDetail, -disable-low-detail |
Force disables low details |
-disableMenuManipulation, -disable-menu-manipulation |
Force disables menu manipulation |
-disableModels, -disable-models |
Disable models |
-disableNoClickWalk, -disable-no-click-walk |
Force disables no click walk |
-disableTileRendering, -disable-tile-rendering |
Disables tile rendering (provided menu manipulation and no click walk are enabled) |
-disableSounds, -disable-sounds |
Disables all sounds |
-dismiss-random-events |
Enables our dismiss random solver |
-enableAnimations, -enable-animations |
Enables animations |
-enableModels, -enable-models |
Enable models |
-enableTileRendering, -enable-tile-rendering |
Enables tile rendering |
-lowDetail, -low-detail |
Enable low details |
-menuManipulation, -menu-manipulation |
Enable menu manipulation |
-no-input-login |
Enable no input login |
-noClickWalk, -no-click-walk |
Enable no click walk |
-world-hop-on-login-error |
The client will change worlds if it there's a login error |
-developer-mode |
Enables the developer mode menu |
-disable-developer-mode |
Disables the developer mode menu |
Proxy Options
| Parameter | Description |
|---|---|
-proxy=<proxy> |
Stored proxy's nickname |
-proxyHost, -proxyHostArg=<host> |
Proxy host |
-proxyHttpPort, -proxyHttpPortArg=<port> |
Proxy HTTP port |
-proxyPass, -proxyPassArg=<password> |
Proxy password |
-proxyPort, -proxyPortArg=<port> |
Proxy port |
-proxyUser, -proxyUserArg=<user> |
Proxy username |
Game Account Options
| Parameter | Description |
|---|---|
-account=<account> |
Stored game account's nickname |
-accountPass, -accountPassword=<password> |
Game account's login password |
-accountPin=<pin> |
Game account's bank PIN |
-accountTotp=<totp> |
Game account's TOTP key |
-accountUser, -accountUsername=<user> |
Game account's login username or email |
-newAccountBrowserLogin, -new-account-browser-login |
You can use this flag to avoid us trying to log in normally, and to automatically open the login browser. |
-characterId=<id> |
Character ID |
-displayName=<name> |
Display Name |
-sessionId=<id> |
Session ID |
-accessToken=<token> |
Access Token |
-refreshToken=<token> |
Refresh Token |
Script Options
| Parameter | Description |
|---|---|
-params=<params>... |
Script's QuickStart parameters, must be the final QuickStart argument |
-schedule=<schedule name> |
Schedule's name (must be exact) |
-script=<script> |
Script's name (must be exact) |
-version=<version> |
Script version number (optional) |
Discord Notification Options
| Parameter | Description |
|---|---|
-disable-notify-on-ban |
This will disable notifications on ban |
-disable-notify-on-death |
This will disable notifications on death |
-disable-notify-on-level-up |
This will disable notifications on level up |
-disable-notify-on-pet |
This will disable notifications when you receive a pet |
-disable-notify-on-script-pause |
This will disable notifications on script pause |
-disable-notify-on-script-start |
This will disable notifications on script start |
-disable-notify-on-script-stop |
This will disable notifications on script stop |
-disable-notify-on-untradeable-drop |
This will disable notifications when you receive an untradeable drop |
-disable-notify-on-valuable-drop |
This will disable notifications when you receive a valuable drop |
-disable-notify-on-quest-complete |
This will disable notifications when you complete a quest |
-discord-webhook=<url> |
The Discord webhook URL to be used for notifications |
-notify-on-ban |
This will enable notifications on ban |
-notify-on-death |
This will enable notifications on death |
-notify-on-level-up |
This will enable notifications on level up |
-notify-on-level-up-by=<amount> |
This controls when we'll send a level up notification, if the new level is divisible by this amount (1 will send for every level up, 5 for every 5th, etc.) |
-notify-on-pet |
This will enable notifications when you receive a pet |
-notify-on-script-pause |
This will enable notifications on script pause |
-notify-on-script-start |
This will enable notifications on script start |
-notify-on-script-stop |
This will enable notifications on script stop |
-notify-on-untradeable-drop |
This will enable notifications when you receive an untradeable drop |
-notify-on-valuable-drop |
This will enable notifications when you receive a valuable drop |
-notify-on-valuable-drop-amount=<amount> |
This is the minimum value of a valuable drop in order to send a valuable drop notification |
-notify-on-quest-complete |
This will enable notifications when you complete a quest |