version 1.9.9+ OPERATOR'S GUIDE
[Linux/Win/Mac zCore Plugin Module]
|
INDEX
1: Setting up the bot USER HELP ARTICLES
RESOURCES 1: GNU License Information2: Source Code (Download) |
-------------------------------------------------------------- The module is now ready. It can be run on Windows, Linux or Mac with Python. Channel specific configuration is self generated into a separate configuration files upon initial start up. Do not edit these files manually. The module has built in configuration commands. Run the module with zcore.py (python3 zcore.py) -------------------------------------------------------------- 2. Configuration --------------------------------------------------------------
DuckHunt is pre-configured to have the game enabled from start up. To turn DuckHunt on or off, in chat use !duckhunt on or !duckhunt off FURTHER CONFIGURATION IS USER DEFINED. Below you can find a description of the pre-configured default settings, and how to change them. (Advanced users) This plugin has the ability to change the configuration and settings live, while the bot is running. There is no need to configure or change settings of this plugin thru the configuration files, and zCore will not need to be manually restarted. All changes take effect immediately. [Configuration Explanation] The configuration commands can only be used by botmasters. The configuration of this plugin is stored in the duckhunt.cnf and server/channel specific files (duckhunt_server1_channel1.cnf). This plugin has the capability to make live changes to its configuration, and making the changes take effect quickly, if not immediately. Everything works based on time, random numbers and percentages that are set within a specified range. The various values and settings that can be configured in this plugin allow each botmaster to fine tune their DuckHunt games for their chats. PLEASE NOTE: The Help Documentation is designed to follow the stock (or pre-configured) settings. Making your own changes may cause game experience to change, based on the settings you declare. Some commands or game situations may be enabled or disabled per botmaster definition. [Core Configuration] Core configuration values are: maxducks, spawntime, flytime, duckexp, duckfear, duckgold, friendrate The following commands will change these values. (Pre-configured values listed)
maxducks is the maximum amount of ducks that can exist at once in the specified channel; Recommend 3-6. Pre-config: 6 This will send a message saying what the current maxducks setting is. spawntime spawntime is the amount of time for a duck to spawn automatically in chat. If you wish to have multiple ducks spawn automatically in the channel, set this value lower than flytime. Time value is in seconds Recommend 900-1800 seconds (15-30 min) Pre-config: 1800 seconds This will send a message saying what the current spawntime setting is in seconds. flytime flytime is the amount of time a duck will stay in the area before flying away. If you wish you have multiple ducks spawn automatically in the channel, set this value higher than spawntime. The value is in seconds Recommend 600-1500 seconds (10-25 min) Pre-config: 1500 seconds This will send a message saying what the current flytime setting is in seconds. duckexp duckexp is the amount of xp a player earns for shooting down or befriending a normal duck. Golden ducks are a variable value that can be up 15 times this value. Based on game pricing Recommend 15 Pre-config: 15 xp This will send a message saying what the current duckexp setting is in xp. duckfear duckfear is based on a points accumulation. Points accumulate every time a player uses !bang. The lower the value, the easier it is to scare ducks Recommend 45-55 Pre-config: 50 This will send a message saying what the current duckfear setting is in fear points. duckgold duckgold is the number that represents what percentage of automatically spawned ducks will turn golden. 1-100 Recommend 30-50 Pre-config: 40 This will send a message saying what the current duckgold setting percentage is. friendrate friendrate is the number that represents the percentage of luck players will have befriending ducks. 1-100 Recommend 70-75 Pre-config: 71 This will send a message saying what the current friendrate setting percentage is. [Configuring Game Rules] The In-Game Rules and Regulations can be modified to change the game experience for your channel. A basic rules setting can be viewed in channel by everyone with the command !rules
When turned on, if a player has an accident, or fires their gun without a duck in the area, that player's gun is confiscated until the following duck is shot by someone else. The player's gun will be silently returned upon the following duck being successfully shot down. Pre-config: ON Bullet Ricochet Gun ricochet is disabled at 0. If enabled, ricochets will result in a player accident. If gun confiscation is on, the player's gun will also be confiscated. Pre-config: 15 Searching The Bushes Searching the bushes is disabled at 0. If enabled, 1-100% of players will find objects in the bushes after shooting a duck. Recommend 15 Pre-config: 20 Infinite Ammo When turned on players will have infinite gun magazines, and infinite bread loafs. Players will still need to reload, but will not run out of ammo. Pre-config: OFF No shooting (!bang command set) Disabling bang will result in a different game experience with a reduced shop menu and functionality. This setting cannot be disabled unless !bef command set is enabled. Turning bang off disables the following commands: !bang, !reload, !rearm Turning bang off disables the following shop items: 1, 2, 3, 4, 5, 6, 7, 8, 9, 15, 17, 18, 23, 24 Pre-config: bang ON No befriending (!bef command set) Disabling bef will result in a different game experience with a recuded shop menu and functionality. This setting cannot be disabled unless !bang command set is enabled. Turning bef off disables the following commands: !bef, !bread Turning bef off disables the following shop items: 19, 20, 21 Pre-config: bef ON [Configuring Flood Control] Flood control settings are currently experimental. The flood control system is designed to reduce virtual load and CPU usage, while also preventing the bot from an excess flood on the IRC network. The maxducks and duckfear configuration settings can also be used to help fine tune flood control, by setting maxducks and duckfear to their recommended values. In general situations, this should trigger the ducks to flee just before the threshold of flood protection is reached, and puts a limit on how many ducks can exists at one time, thereby reducing demand from users when ducks exist. Certain commands like !shop and !duckstats will also trigger flood control quicker, because of their multi-line message formats. Flood control is currently a hard coded value that cannot be changed. Pre-config: ON 3. Resetting the game --------------------------------------------------------------
If the configuration file for the server/channel instance has becomed erroneous, to reset to defaults, shut down the bot. Open the zCore folder, locate duckhunt_server_channel.cnf and delete it. Restart the bot. Upon restarting the server and channel configuration file will self generate a new file with the default settings. [Reset Command] Resetting the game permanently erases all player stats, timed effects and timed inventory data. Back up the duckhunt_server_channel.cnf file if you want to save previous data. This command DOES NOT self-backup. 4. Botmaster and Admin Chat Commands -------------------------------------------------------------- These are the commands that botmasters and admins can use in chat during the game.
|