[Bot] Garrisonbuddy - An official Garrison Bot

Garrisonbuddy
A Garrison botbase that handles all your daily Garrison needs. Fully automated, and configurable!

How does Garrisonbuddy work?

Just hit start. There is no required configuration needed. However, feel free to configure it as you see fit to set work order limits, mission planning strategies, etc.
​

Feature Set

• Work Orders
  All buildings are handled. This includes the War Mill daily quest for follower weapons/armor tokens. (Non-DE builds only)
  
• Shipments
  All buildings are handled.
  
• Completing missions
  
• Starting Missions
  All missions can be started. Extensible API is provided to allow 3rd parties access to providing new "mission planners". By default, Garrisonbuddy ships with 6 common planning strategies. (Experience, Experience Per Hour, Garrison Resources, Gold Gained, Success Chance, and a "Debug" strategy which includes even further filtering and sorting)
  
• Follower Upgrades
  Will "open" all follower upgrade tokens, and attempt to keep all followers at roughly the same item level (prioritizing Legendary/Epic followers first) using the follower tokens you have in your bags. (The bot will not pull tokens from the bank)
  
• Full harvesting of the mine, and herb garden
  (Not available in HonorbuddyDE.)
  
• Complete Trading Post support
  Includes the ability to "buy" from the current trader (defaults are set to purchase 200 of the best-priced items when you have more than 7500 garrison resources), as well as configurable work orders for the current work order NPC at the trading post.
  
• Barn Work Orders
  The bot will put in work orders for all the traps you have available (prioritizing Massive traps before normal ones)
  
• Garrison Cache Collection
  The bot will collect the Garrison cache when below 9500 resources (to avoid wasting the cache and over-capping the player)
  
• Opening Salvage
  Bags, Crates, etc are opened automatically by the bot.

Download

No download necessary--this bot ships with Honorbuddy. (Currently only Beta builds contain Garrisonbuddy)​

Thread Management Rules

Posts that have been archived from this thread are available here:

HB ARCHIVES: GarrisonBuddy--DO NOT DELETE​

Posts are archived according to the following rules:

• Posts older than 30 days are archived.
  Unless there is a significant reason they should remain.
• Bug reports without FULL, unedited logs attached will be immediately archived without comment.
  Ref: [Guide] How to attach your log​
• Either report bugs properly, or do not report them at all.
  We cannot look into bugs that have little to no information.
  Bugs reported in such a fashion will be immediately archived without comment.
• If you derail this thread, you will be muted for up to 30 days. No questions.
• Archiving may not be immediate, but occur every few days.

​

 

[SIZE=+1]FAQs[/SIZE]

• "Does Garrisonbuddy do questing to open up the work orders for each building?"
  Not at this time. But, this has been captured as feature request HB-2234. Even if the feature is implemented, it will be unavailable to HonorbuddyDE users.
  
  
• "Does Garrisonbuddy do profession quests?"
  Not at this time. But, this has been captured as feature request HB-2229.
  
  
• "Does Garrisonbuddy skip HBRelog tasks when it finishes?"
  Yes, it does. But, it only works in non-HonorbuddyDE builds.
  
  
• "For the Trading Post configuration, what does "KeepMinimum and KeepMinimumSecondary" means?"
  For almost all work orders, there is only 1 reagent needed to place the work order (the only exception as of right now, is Engineering, which requires 2. Hence the "Secondary" value)
  
  Setting either value will ensure the bot will not place a specific work order, if you have less than the "KeepMinimum" value of that item available. Eg; for the "Forge", if you set KeepMinimum to 100, the bot will not place work orders that take you below 100 ore on your character.
  
  This is simply for users who like to pool some resources for other things, and not spend them all on work orders.
  
  
• "Can you describe how the follower weapon/armor upgrade tokens are applied?"
  Follower tokens are common enough to just use as you get them. The bot will only upgrade level 100 followers.
  
  The +9 tokens are only used on followers who are >= 645 ilvl to avoid wasting the more rare tokens. It will also try to keep your followers at roughly the same item level so mission success chances are kept high.
  
  More people requested that upgrades were on by default, than those who asked otherwise. So majority wins in this case.
  
  
• "Does this bot use a lot of LUA?"
  This bot uses very little LUA. In total, there are about 8 LUA functions it uses. (Mainly related to mission starting and completing, and work orders)
  It also includes some other LUA to make the UI not quite so finnicky.
  All calls have been confirmed safe.

[SIZE=+1]Making Custom Mission Planners[/SIZE]

Garrisonbuddy ships with a way to "plan" missions by any logic you choose. Simply inherit from GarrisonBuddy.Planning.Missions.IMissionPlanSorter and implement your sorting logic.

For example, here is the logic for the "By Success Chance" planning strategy:

Code:

        internal class BySuccessChanceSorter : IMissionPlanSorter
        {
            public string Name { get { return "By Success Chance"; } }
            public List<MissionPlan> SortMissionPlans(List<MissionPlan> plans)
            {
                List<MissionPlan> output = new List<MissionPlan>();

                foreach (var plan in plans)
                {
                    // Plan has no valid groups for it, so don't process it.
                    if (plan.Groups == null || plan.Groups.Count == 0)
                        continue;

                    // Use List.Sort as it's far faster than an OrderBy
                    // 
                    // We want the higher values to be *lower* in the list. First index is always the first-used group.
                    plan.Groups.Sort(Comparer<MissionGroup>.Create((x, y) => -x.SuccessChance.CompareTo(y.SuccessChance)));

                    // Success chance doesn't meet the threshold defined in the settings.
                    // NOTE: This line is actually "fluff", as the main planner itself will filter out any groups with lower-than-set success chances
                    //         before ever getting to this point.
                    if (plan.Groups[0].SuccessChance <= GarrisonBuddySettings.Instance.MinimumMissionSuccess)
                        continue;

                    // Add the plan to our outgoing list.
                    output.Add(plan);
                }

                // Sort all the missions themselves, by the best success chance of the groups.
                // Remember: Invert here since we want higher succcess chances at lower indices in the list.
                output.Sort(Comparer<MissionPlan>.Create((x, y) => -x.Groups[0].SuccessChance.CompareTo(y.Groups[0].SuccessChance)));
                return output;
            }
        }

Simply implementing your IMissionPlanSorter will have it loaded, and usable by the bot. You can do this via Plugins quite easily.

Before any missions are started, the bot will calculate all possible groups for all available missions. It will also calculate some modifier-based information (estimated XP gained, gold/resource modifiers, etc) for every group. You will have all useful mission data available to you!
​

[SIZE=+1]"Faction Change" Related Bugs[/SIZE]

Unfortunately, Blizzard has a few Garrison-related bugs when doing faction/race transfers. There are currently two known bugs, both of which include settings for users to "fix" these themselves. Unfortunately, since every user is different, and each circumstance is different, we cannot automate this process. However, fixes have been kept as simple as possible.

The current fixes will all be found inside your GarrisonBuddySettings.xml for your specific character, usually near the bottom of the file. (Use any text editor you please, such as Notepad, Notepad++, etc. Do not use an RTF editor such as WordPad, as this tends to break the settings file to a point that .NET cannot read it correctly)

Shipment counts are not correct
Some users will see that the bot (and the in-game UI) reports incorrect numbers for the amount of "shipments available for pickup". This usually means you did a faction/race transfer before you had all your shipments cleared out. This causes the bot to think that there are extra shipments to be picked up, and it will sit around waiting.

You will find this chunk of XML inside of the settings file. Simply find the building you have the issue with, and set the ShipmentCount value to the value you see in game when there are no actual available shipments. This will tell the bot to offset the count the client gives us, with the value you give us, to resolve the issue. These values expect positive integer values.

HTML:

  <BlizzardBug_TransferFixes>
    <ShipmentTransferFix BuildingType="Unknown" ShipmentCount="0" />
    <ShipmentTransferFix BuildingType="Mines" ShipmentCount="0" />
    <ShipmentTransferFix BuildingType="HerbGarden" ShipmentCount="0" />
    <ShipmentTransferFix BuildingType="Barn" ShipmentCount="0" />
    <ShipmentTransferFix BuildingType="LumberMill" ShipmentCount="0" />
    <ShipmentTransferFix BuildingType="Inn" ShipmentCount="0" />
    <ShipmentTransferFix BuildingType="TradingPost" ShipmentCount="0" />
    <ShipmentTransferFix BuildingType="Menagerie" ShipmentCount="0" />
    <ShipmentTransferFix BuildingType="Barracks" ShipmentCount="0" />
    <ShipmentTransferFix BuildingType="WarMill" ShipmentCount="0" />
    <ShipmentTransferFix BuildingType="Stables" ShipmentCount="0" />
    <ShipmentTransferFix BuildingType="SpiritLodge" ShipmentCount="0" />
    <ShipmentTransferFix BuildingType="SalvageYard" ShipmentCount="0" />
    <ShipmentTransferFix BuildingType="Storehouse" ShipmentCount="0" />
    <ShipmentTransferFix BuildingType="Alchemy" ShipmentCount="0" />
    <ShipmentTransferFix BuildingType="Blacksmithing" ShipmentCount="0" />
    <ShipmentTransferFix BuildingType="Enchanting" ShipmentCount="0" />
    <ShipmentTransferFix BuildingType="Engineering" ShipmentCount="0" />
    <ShipmentTransferFix BuildingType="Inscription" ShipmentCount="0" />
    <ShipmentTransferFix BuildingType="Jewelcrafting" ShipmentCount="0" />
    <ShipmentTransferFix BuildingType="Leatherworking" ShipmentCount="0" />
    <ShipmentTransferFix BuildingType="Tailoring" ShipmentCount="0" />
    <ShipmentTransferFix BuildingType="Fishing" ShipmentCount="0" />
    <ShipmentTransferFix BuildingType="GladiatorsSanctum" ShipmentCount="0" />
    <ShipmentTransferFix BuildingType="Workshop" ShipmentCount="0" />
  </BlizzardBug_TransferFixes>

The bot thinks a quest is not complete
Some users will have quests that they completed on the opposing faction, show up as non-complete on the current faction they transferred to. Unfortunately, this too is another bug that Blizzard has with their transfer system. But, there's a fix!

Unfortunately, the fix here is slightly more complicated due to some other requirements, but it should still be fairly simple. If the following XML does not exist in your settings file, feel free to add it in! (You may find a blank element called BlizzardBug_QuestTransferFixes, if so, just remove it, and paste the XML below with your modifications)

Please note: The BuildingType parameter here has the full listing above, so you can find the correct name to put.

Do not add fixes for buildings that do not need fixes unless you know what you're doing. This will override the pre-quest completion logic and force the bot to assume the quest has been completed.

HTML:

  <BlizzardBug_QuestTransferFixes>
    <QuestTransferFix BuildingType="SalvageYard" PreQuestCompleted="true" />
    <QuestTransferFix BuildingType="StoreHouse" PreQuestCompleted="true" />
  </BlizzardBug_QuestTransferFixes>

​

 

[size=+1]GarrisonBuddy under heavy refactoring...[/size]
With the upcoming "Shipyard" garrison changes, I've gone ahead and re-organized all of the Garrisonbuddy code-base. This means I've fixed numerous bugs (both by proxy, and on purpose), and probably introduced quite a few more.

Buildings are now self-contained logic systems, with each having their own settings. These settings have been wrapped in the UI (I may have possibly missed a setting or two, but I'm fairly confident I got all the ones that are implemented currently)

You can now enable/disable a building completely. Enable/disable shipments, work orders, or other building-specific things (such as collecting herbs/minerals, using mining items, etc) on a per-building basis. This allows much better control over what GSB will do for you automatically.

I've also introduced the idea of building "Priority", which will allow you to change what order GSB handles doing any given building. For instance; if you want to have the bot do the Blacksmithing building before Jewelcrafting (so you don't waste all your BS daily materials putting in JC work orders), you can now do this. This option is not currently exposed in the UI, but will be coming soon (via drag-drop style reordering, if I can get it working )

Settings have also been moved to JSON instead of XML. Mainly due to the extra control afforded by the JSON library we use. (Those of you familiar with Wildbuddy, will recognize the settings system being used)

I've also included the ability to manually add your own profession tradeskills (please note: tradeskills are still early beta support, so don't expect them to work 100% if you add custom ones). This allows you guys to add/remove anything you want, and have the bot automatically craft things. I will still add in "default" tradeskills if requested, and there's enough requests behind them.

Please report any bugs you may find. (I've completely overhauled the looting logic in GSB, which is going to be an early test for possibly moving into the core HB logic) It should be far more responsive, and work far faster than the old logic.