Diff for "StartupParameters" - NEAT Portal Wiki

Diff for "StartupParameters"

Differences between revisions 29 and 59 (spanning 30 versions)

The bot allows certain command line parameters to be passed to it when starting up. The Director already uses these when it sends your email, server, delay, etc. to the bot when launching it.

An example of using these command line parameters from a Windows 7 command prompt:

C:\NeatBot> NEAT2345.exe -u neatbot@neatportal.com -password abcdefg -s 123 -title NeatBotRox

You can also use these with the Director at the bottom where it says Custom Parameters. Simply type in the parameter(s) you want and restart the bot(s) you want to be affected by them. If they're a one-time deal, like to enable some global setting for one account only, then delete the parameters afterwards or they'll be applied to every bot at each restart until the Director itself is restarted.

Parameter	Usage	Description
Login settings
username	-username `neat@neatportal.com` -u `neat@neatportal.com`	The login for the account.
password	-password abc123	The password for the account.
server	-server 123 -s 123	The server to log into.
delay	-delay 1 -d 1	The delay time to log into the server, in minutes.
title	-title NeatBot	The window title you will see in the task bar and name in the system tray for the bot.
autologin	-autologin 1	A "0" (off) or "1" (on) switch to turn autologin to the server on/off.
autorun	-autorun 1	A "0" (off) or "1" (on) switch to turn auto goal setting on/off.
autoscripts	-autoscripts 1	A "0" (off) or "1" (on) switch to turn autorun of scripts on/off.
netbookmode	-netbookmode 0	A "0" (off) or "1" (on) switch to turn on/off the shortened screensize/buttons for netbooks and small monitors.
connectioncheckdelay	-connectioncheckdelay 180	Used to set the number of seconds between connection timeout checks.
logintimeout	-logintimeout 180	Used to set the number of seconds to wait after the bot fails to login before exiting. (default is not to exit on failed login attempt)
serverhost	-serverhost 123.45.67.123	The server host or IP to connect to. In 99.99% of cases you should never need to use this.
serverport	-serverport 123	The server port to connect to. In 99.99% of cases you should never need to use this. Only effective with serverhost aslo.
proxy	-proxy `http://111.22.33.44:3128` -proxy 111.22.33.44:3128 -proxy ss5://123.45.67.89:1080	The http or socks5 proxy to connect to.
Global settings
maintenance	-maintenance 30	Set a custom maintenance time in minutes.
secret key	-ssk abc122	The user's forum profile secret key to link the bot to NeatPortal.com
auth token	-token xyz123	The user's forum profile authentication token to link the bot to NeatPortal.com. Note - tokens expire after 5 mins of non-use, so if adding this to authenticate, be sure to grab a fresh one first. Once authenticated, you can delete this parameter.
maxtrade	-maxtrade 99999999	Used to set the maximum trade quantity allowed via scripting or default tradepolicy. Default is 99,999,999.
MinimizeToTray	-minimizetotray 1	0=off 1=on set global settings minimize to tray option on or off
Minimize	-minimize 1	Enable/disable minimize bot on login (default = 0)
TTSAttackWarning	-ttsattackwarning 0	Enable/disable TTS Attack Warning (default = 0) (dont use this option, it will lock your bot up except in test release Zinc 4 builds!)
AttackFocus	-attackfocus 0	Enable/disable focus(bring to foreground) window on incoming attack
BalloonAttackWarning	-balloonattackwarning 0	Enable/disable balloon pop up attack warnings
CaptchaAutoSolve	-captchaautosolve 0	Enable/disable captcha auto solver
attackwarning	-attackwarning 1	Enable/disable audible attack warning
warreports	-warreports 1	Enable/disable alliance defense reports being logged to log window
notradingreports	-notradingreports 1	Enable/disable trading messages being recorded to log window
noattackreports	-noattackreports 1	Enable/disable NPC/valley attack messages being logged to reports window
noamuletmessages	-noamuletmessages 1	Enable/disable amulet spins being logged in system window
nosystemmessages	-nosystemmessages 1	Enable/disable system messages being logged only in the system window
sce	-sce 1	Enable/disable security code
claimpackages	-claimpackages 1	Enable/disable auto package claim (default = 1)
secure	-secure 1	Enable/disable "Safe mode" in scripts (default = 1). If enabled, prevents Config.xxx info and account reset from being accessed by scripts
compatible	-compatible 0	Enable/disable compatibility mode on the bot (default = 1). This forces the bot to behave more like the Evony client. It can slow down the performance of some scripts.
resetfh	-resetfh 0	Enable/disable reset farming history at startup (default = 0)
showsettings	-showsettings 1	Enable/disable show Settings screen if new settings are detected (default = 1)
Character Creation
player	-player LordNeat	Set the Lord name on account creation
sex	-sex 0	Set the gender on account creation. 0 is male, 1 is female
faceindex	-faceindex 5	Set the face picture on account creation. runs 0-24 for males, 0-7 for females
zone	-zone bavaria	Set the state to start in on account creation. use the actual state name, ie - romagna
city	-city MyCity	Set the name for your starting city on account creation. will be "City Name" if not specified.
flag	-flag NEAT	Set the flag to use on account creation. limit 4 characters, obviously
Misc Settings
runscript	-runscript MyScript.txt	Commands bot to load up the txt file specified at startup to be autorun. Label autorun already in the city will run after the runscript script.
basedir	-basedir "C:\Users\Inanna\Documents\Bot\MyBot\" -basedir "MyFiles\MoreFiles\"	The base directory at which the bot should look for it's files (media folder, images folder, warreport.swf, autorunscript.txt, cmdparams.txt, etc.) Can be relative or absolute path. This feature is not available before version 3280.
prependgoals	-prependgoals "MyGoals.txt"	The file the bot should load automatically as PrependGoals.txt. This allows you to specify custom goals files for different accounts. This feature is not available before version 3279.
appendgoals	-appendgoals "MyOtherGoals.txt"	The file the bot should load automatically as AppendGoals.txt. This allows you to specify custom goals files for different accounts. This feature is not available before version 3279.

The following syntax is recognized (enclose value in quotes if it has spaces!):

-parameter value

-parameter=value

-parameter:value

/parameter:value

/parameter=value

/parameter value

To set checkbox for one of the above-mentioned parameters, the value must be one of these (any other value will uncheck it):

1
yes
on
true

Please note that until we get the source code upgraded for Zinc 4.0 compatibility, command line parameters will not work with Linux binary builds. This is a limitation in the program we're using now to compile them. Sorry, we hope to rectify this very soon!

-  ⇤ ← Revision 29 as of 2013-11-03 23:30:35 → 
  Size: 5204
  Editor: Inanna
  Comment:
+   ← Revision 59 as of 2015-09-23 19:31:52 → ⇥
  Size: 7644
  Editor: Romulus
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 2:
+An example of using these command line parameters from a Windows 7 command prompt:

'''C:\!NeatBot>''' NEAT2345.exe -u `neatbot@neatportal.com` -password abcdefg -s 123 -title !NeatBotRox

You can also use these with the Director at the bottom where it says Custom Parameters. Simply type in the parameter(s) you want and restart the bot(s) you want to be affected by them. If they're a one-time deal, like to enable some global setting for one account only, then delete the parameters afterwards or they'll be applied to every bot at each restart until the Director itself is restarted.
-Line 4:
+Line 10:
-||username ||-username `neat@neatportal.com` or -u `neat@neatportal.com` ||The login for the account. ||
+||username ||-username `neat@neatportal.com`<<BR>>-u `neat@neatportal.com` ||The login for the account. ||
-Line 6:
+Line 12:
-||server ||-server 123 or -s 123 ||The server to log into. ||
||delay ||-delay 1 or -d 1 ||The delay time to log into the server, in minutes. ||
+||server ||-server 123<<BR>>-s 123 ||The server to log into. ||
||delay ||-delay 1<<BR>>-d 1 ||The delay time to log into the server, in minutes. ||
-Line 13:
+Line 19:
-||connectioncheck ||-connectioncheckdelay 180 ||Used to set the number of seconds between connection timeout checks. ||
+||connectioncheckdelay ||-connectioncheckdelay 180 ||Used to set the number of seconds between connection timeout checks. ||
||logintimeout ||-logintimeout 180 ||Used to set the number of seconds to wait after the bot fails to login before exiting. (default is not to exit on failed login attempt) ||
||serverhost ||-serverhost 123.45.67.123 ||The server host or IP to connect to. In 99.99% of cases you should never need to use this. ||
||serverport ||-serverport 123 ||The server port to connect to. In 99.99% of cases you should never need to use this. Only effective with serverhost aslo. ||
||proxy ||-proxy `http://111.22.33.44:3128`<<BR>>-proxy 111.22.33.44:3128<<BR>>-proxy ss5://123.45.67.89:1080 ||The http or socks5 proxy to connect to. ||
-Line 15:
+Line 25:
-||secret key ||-ssk abc122 ||The user's forum secret key to link the bot to !NeatPortal.com ||
+||maintenance ||-maintenance 30 ||Set a custom maintenance time in minutes. ||
||secret key ||-ssk abc122 ||The user's forum profile secret key to link the bot to !NeatPortal.com ||
||auth token ||-token xyz123 ||The user's forum profile authentication token to link the bot to !NeatPortal.com.<<BR>>Note - tokens expire after 5 mins of non-use, so if adding this to authenticate, be sure to grab a fresh one first. Once authenticated, you can delete this parameter. ||
-Line 18:
+Line 30:
-||Minimize ||-minimize 1 ||enable/disable minimize bot on login (default = 0) ||
||TTSAttackWarning ||-ttsattackwarning 0 ||enable/disable TTS Attack Warning (default = 0) (dont use this option, it will lock your bot up except in test release Zinc 4 builds!) ||
||!AttackFocus ||-attackfocus 0 ||enable/disable focus(bring to foreground) window on incoming attack ||
||!BalloonAttackWarning ||-balloonattackwarning 0 ||enable/disable balloon pop up attack warnings ||
||!CaptchaAutoSolve ||-captchaautosolve 0 ||enable/disable captcha auto solver ||
||attackwarning ||-attackwarning 1 ||enable/disable audible attack warning ||
||warreports ||-warreports 1 ||enable/disable alliance defense reports being logged to log window ||
||notradingreports ||-notradingreports 1 ||enable/disable trading messages being recorded to log window ||
||noattackreports ||-noattackreports 1 ||enable/disable enable NPC/valley attack messages being logged to reports window ||
||noamuletmessages ||-noamuletmessages 1 ||enable/disable amulet spins being logged in system window ||
||sce ||-sce 1 ||enable/disable security code ||
||claimpackages ||-claimpackages 1 ||enable/disable auto package claim (default = 1) ||
||secure ||-secure 1 ||enable/disable secure scripts (default = 1) if enabled, prevents Config.password from being accessed by scripts ||
||resetfh ||-resetfh 0 ||enable/disable reset farming history at startup (default = 0) ||
||showsettings ||-showsettings 1 ||enable/disable show Settings screen if new settings are detected (default = 1) ||
||'''''Account Creation''''' || || ||
||player ||-player !LordNeat ||set the Lord name on account creation ||
||sex ||-sex 0 ||set the gender on account creation. 0 is male, 1 is female ||
||faceindex ||-faceindex 5 ||set the face picture on account creation. runs 0-24 for males, 0-7 for females ||
||zone ||-zone bavaria ||set the state to start in on account creation. use the actual state name, ie - romagna ||
||flag ||-flag NEAT ||set the flag to use on account creation. limit 4 characters, obviously :) ||
+||Minimize ||-minimize 1 ||Enable/disable minimize bot on login (default = 0) ||
||TTSAttackWarning ||-ttsattackwarning 0 ||Enable/disable TTS Attack Warning (default = 0) (dont use this option, it will lock your bot up except in test release Zinc 4 builds!) ||
||!AttackFocus ||-attackfocus 0 ||Enable/disable focus(bring to foreground) window on incoming attack ||
||!BalloonAttackWarning ||-balloonattackwarning 0 ||Enable/disable balloon pop up attack warnings ||
||!CaptchaAutoSolve ||-captchaautosolve 0 ||Enable/disable captcha auto solver ||
||attackwarning ||-attackwarning 1 ||Enable/disable audible attack warning ||
||warreports ||-warreports 1 ||Enable/disable alliance defense reports being logged to log window ||
||notradingreports ||-notradingreports 1 ||Enable/disable trading messages being recorded to log window ||
||noattackreports ||-noattackreports 1 ||Enable/disable NPC/valley attack messages being logged to reports window ||
||noamuletmessages ||-noamuletmessages 1 ||Enable/disable amulet spins being logged in system window ||
||nosystemmessages ||-nosystemmessages 1 ||Enable/disable system messages being logged only in the system window ||
||sce ||-sce 1 ||Enable/disable security code ||
||claimpackages ||-claimpackages 1 ||Enable/disable auto package claim (default = 1) ||
||secure ||-secure 1 ||Enable/disable "Safe mode" in scripts (default = 1). If enabled, prevents Config.xxx info and account reset from being accessed by scripts ||
||compatible ||-compatible 0 ||Enable/disable compatibility mode on the bot (default = 1). This forces the bot to behave more like the Evony client. It can slow down the performance of some scripts. ||
||resetfh ||-resetfh 0 ||Enable/disable reset farming history at startup (default = 0) ||
||showsettings ||-showsettings 1 ||Enable/disable show Settings screen if new settings are detected (default = 1) ||
||'''''Character Creation''''' || || ||
||player ||-player !LordNeat ||Set the Lord name on account creation ||
||sex ||-sex 0 ||Set the gender on account creation. 0 is male, 1 is female ||
||faceindex ||-faceindex 5 ||Set the face picture on account creation. runs 0-24 for males, 0-7 for females ||
||zone ||-zone bavaria ||Set the state to start in on account creation. use the actual state name, ie - romagna ||
||city ||-city !MyCity ||Set the name for your starting city on account creation. will be "City Name" if not specified. ||
||flag ||-flag NEAT ||Set the flag to use on account creation. limit 4 characters, obviously :) ||
-Line 40:
+Line 55:
-||runscript ||-runscript !MyScript.txt ||Commands bot to load up the txt file specified at startup to be autoran. Label autorun already in the city will run after the runscript script. ||
+||runscript ||-runscript !MyScript.txt ||Commands bot to load up the txt file specified at startup to be autorun. Label autorun already in the city will run after the runscript script. ||
||basedir ||-basedir "C:\Users\Inanna\Documents\Bot\!MyBot\"<<BR>>-basedir "!MyFiles\!MoreFiles\" ||The base directory at which the bot should look for it's files (media folder, images folder, warreport.swf, autorunscript.txt, cmdparams.txt, etc.)<<BR>>Can be relative or absolute path.<<BR>>This feature is not available before version 3280. ||
||prependgoals ||-prependgoals "!MyGoals.txt" ||The file the bot should load automatically as !PrependGoals.txt. This allows you to specify custom goals files for different accounts.<<BR>>This feature is not available before version 3279. ||
||appendgoals ||-appendgoals "!MyOtherGoals.txt" ||The file the bot should load automatically as !AppendGoals.txt. This allows you to specify custom goals files for different accounts.<<BR>>This feature is not available before version 3279. ||
-Line 42:
+Line 60:
-An example of using these command line parameters from a Windows 7 command prompt:
-Line 44:
+Line 61:
-'''C:\!NeatBot>''' !NeatBot123.exe -u `neatbot@neatportal.com` -password abcdefg -s 123 -title !NeatBotRox
-Line 46:
+Line 62:
-You can also use these with the Director at the bottom where it says Custom Parameters. Simply type in the parameter(s) you want and restart the bot(s) you want to be affected by them. If they're a one-time deal, like to enable some global setting, then delete the parameters afterwards or they'll be applied to every bot you start afterwards too.
-Line 48:
+Line 63:
-The following syntax is recognized:
+The following syntax is recognized (enclose value in quotes if it has spaces!):
-Line 63:
+Line 78:
-To set checkbox for one of the above-mentioned parameters, the value must be one of these (any other vlaue will uncheck it):
+To set checkbox for one of the above-mentioned parameters, the value must be one of these (any other value will uncheck it):
-Line 73:
+Line 88:
+See also: CmdParms
-Line 74:
+Line 91:
-CategorySetup CategoryHowTo
+CategoryHowTo CategoryExtras