Reformatted Config

conf/mod_autofish.conf.dist

@@ -1,42 +1,82 @@
-# AutoFish module
+########################################
+# AutoFish Config
+########################################
+#
+#    AutoFish.Enabled
+#        Description: Enable the module
+#        Default:     1 - Enabled
+#                     0 - Disabled
+#
 AutoFish.Enabled = 1
 
-# Delay between checking the bobber for a fish
+#
-#   Values: 0-15000
+#    AutoFish.TickMs
+#        Description: Sets the delay, in milliseconds, between checking the bobber for a hooked fish
+#        Default:     200
+#
 AuoFish.TickMs = 200
 
-# Max distance to look for your own Bobber
+#
-#  Values: 1.0-100.0
+#    AutoFish.ScanRange
+#        Description: Sets the range from the player to scan for the fish bobber
+#        Default:     30
+#
 AutoFish.ScanRange = 30.0
 
-# Bobber entries to watch
+#
-#   Values: ID(s) of the bobber entities, comma separated
+#    AutoFish.BobberEntries
+#        Description: Sets the object ID of any bobbers to scan for, can have multiple, separated by comma
+#        Default:     35591
+#
 AutoFish.BobberEntries = 35591
 
-# Automatically loot fish
+#
-#   Values: 1 for on, 0 for off
+#    AutoFish.ServerAutoLoot
+#        Description: Forces the player to automatically loot the fish once the loot window pops up
+#        Default:     1 - Enabled
+#                     0 - Disabled
+#
 AutoFish.ServerAutoLoot = 1
 
-# Automatically Recast the fishing line
+#
-#   Values: 1 for on, 0 for off
+#    AutoFish.AutoRecast
+#        Description: Automatically casts again after successfully catching a fish
+#        Default:     1 - Enabled
+#                     0 - Disabled
+#
 AutoFish.AutoRecast = 1
 
-# Delay before recasting the fishing line
+#
-#   Values: 
+#    AutoFish.RecastDelayMs
+#        Description: Delay, in milliseconds, to wait before recasting after looting the previous fish
+#        Default:     500
+#
 AutoFish.RecastDelayMs = 500
 
-# Spell ID used to recast the fishing line
+#
-#   Values: Spell ID of "Fishing"
+#    AutoFish.RecastSpell
+#        Description: Sets the Spell ID to be used to recast, useful if anyone uses a custom fishing spell
+#        Default:     18248
+#
 AutoFish.RecastSpell = 18248
 
-# Delay before looting from the loot window)
+#
-#   Values: 0-3000
+#    AutoFish.AutoLootDelayMs
+#        Description: Delay, in milliseconds, to wait before automatically looting the fish, after the loot window has appeared
+#        Default:     120
+#
 AutoFish.AutoLootDelayMs = 120
 
-# Bag item required to activate autofish
+#
-#   Values: Item ID, if 0 then no item required
+#    AutoFish.RequiredItemId
+#        Description: Sets an item, by ID, to be held in the bags of the player to activate autofishing. Set to 0 to require no item
+#        Default:     0
+#
 AutoFish.RequiredItemId = 0
 
-# Equipped item required to activate autofish
+#
-#   Values: Item ID, if 0 then no item required
+#    AutoFish.RequiredEquipId
+#        Description: Sets an item, by ID, to be equipped by the player to activate autofishing. Set to 0 to require no item
+#        Default:     0
+#
 AutoFish.RequiredEquipId = 0