User Tools

Site Tools


squatter

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Next revisionBoth sides next revision
squatter [2022/11/01 02:18] – [Scan Cycle Teleport Controls] mistahmikeysquatter [2022/11/01 02:55] – mistahmikey
Line 6: Line 6:
  
 Scans selected residential areas for available plots, and at your discretion, visits them and records how many lottery participants there are. Scans selected residential areas for available plots, and at your discretion, visits them and records how many lottery participants there are.
-  * Has both an auto and manual mode.  In auto mode, it will visit all available plots upon completion of a scan cycle.  In manual mode, it will allow selection of a desired plot to visit from a list of all available plots.+  * Has both an auto and manual mode.  In auto mode, it will visit all available plots upon completion of a scan cycle.  In manual mode, it will allow selection of a desired plot to visit from a list of all available plots at the completion of a scan cycle.
   * Allows you to target specific plots by ward and plot number to visit.   * Allows you to target specific plots by ward and plot number to visit.
   * Allows you to specify what kind of plot to visit: Private, Free Company, or both.   * Allows you to specify what kind of plot to visit: Private, Free Company, or both.
Line 46: Line 46:
 ====== UI ====== ====== UI ======
  
-You start SLH via the FFXIVMinion menu drop down. It's under the "MM's Addons" menu item.  Clicking "Squatter Lottery Helper" should pop up its UI window.  The UI consists of different input areas called tabs.  The first line of the control is a list of all the available tabs.  To select a desired tab, click on it.+You start SLH via the FFXIVMinion menu drop down. It's under the "MM's Addons" menu item.  Clicking "Squatter Lottery Helper" should pop up its UI window.  The UI consists of different input areas called tabs.  The first line of the SLH main window is a list of all the available tabs.  To select a desired tab, click on it.
 Each tab is described below. Each tab is described below.
  
Line 72: Line 72:
 Auto Visit: When checked, SLH will attempt to travel to an available plot to visit it automatically. All selected housing areas will be completely scanned before attempting to visit. Auto Visit: When checked, SLH will attempt to travel to an available plot to visit it automatically. All selected housing areas will be completely scanned before attempting to visit.
  
-Travel Only: When checked, SLH will attempt to travel to an available plot, but will not attempt to record it. After arriving at the plot, Squatter will be disabled (the Enable check box will be unchecked automatically.) Rechecking the Enable check box will cause SLH to resume its normal scanning operations.+Travel Only: When checked, SLH will attempt to travel to an available plot, but will not attempt to record it. After arriving at the plot, SLH will be disabled (the Enable check box will be unchecked automatically.) Rechecking the Enable check box will cause SLH to resume its normal scanning operations.
  
 Create CSV:  When checked, SLH will create a CSV file containing information on all the plots scanned during a scan cycle. As long as this option is checked, each scan will result in a new file being created for each scan cycle.  The contents should be self-explanatory; it is pretty much the same data you see in the Discovered Plots List.  The files exist in <Minion Installation Directory>/Bots/FFXIVMinion64/LuaMods/Squatter Lottery Helper/CSVData - the file names are randomly generated. Use the data as you please. Create CSV:  When checked, SLH will create a CSV file containing information on all the plots scanned during a scan cycle. As long as this option is checked, each scan will result in a new file being created for each scan cycle.  The contents should be self-explanatory; it is pretty much the same data you see in the Discovered Plots List.  The files exist in <Minion Installation Directory>/Bots/FFXIVMinion64/LuaMods/Squatter Lottery Helper/CSVData - the file names are randomly generated. Use the data as you please.
Line 95: Line 95:
 Scan Now:  When you in the scan idle period, clicking this will immediately resume scanning.  You will only see this control during the scan idle period. Scan Now:  When you in the scan idle period, clicking this will immediately resume scanning.  You will only see this control during the scan idle period.
  
-Scan Idle Postponement Period (minutes): The number of minutes SLH will delay before entering the Scan Idle Period.  Setting this value > 0 will cause Squatter to continue to scan for the number of minutes specified before it enters the Scan Idle Period. This is most useful when Scan Hourly is checked, because plots typically do not come available precisely on the hour, and may actually show up a few minutes after the hour.+Scan Idle Postponement Period (minutes): The number of minutes SLH will delay before entering the Scan Idle Period.  Setting this value > 0 will cause SLH to continue to scan for the number of minutes specified before it enters the Scan Idle Period. This is most useful when Scan Hourly is checked, because plots typically do not come available precisely on the hour, and may actually show up a few minutes after the hour.
  
 Scan Idle Postponement Period Remaining (minutes): The number of minutes remaining in the Scan Idle Postponement Period.  You will only see this control when the Scan Idle Postponement Period is active. Scan Idle Postponement Period Remaining (minutes): The number of minutes remaining in the Scan Idle Postponement Period.  You will only see this control when the Scan Idle Postponement Period is active.
Line 108: Line 108:
 Idle in Room:  Allows you to select an inn room or grand company barracks to enter when SLH idles your character.  This feature takes precedence over the "Idle at Random Aetheryte" and "Idle at Random Aethernet" features (described below.) If you have any available rooms (inn room or a grand company barracks), the "Idle in Room" pull-down will appear, and the "Idle at Random Aetheryte" and "Idle at Random Aethernet" will not be shown.  On the other hand, if you don't have any available rooms, then the "Idle at Random Aetheryte" and "Idle at Random Aethernet" will appear, and the "Idle in Room" pull-down will not be shown.  Be aware that both inn rooms and grand company barracks must be unlocked via various quests - for inn rooms, have a look at https://ffxiv.consolegameswiki.com/wiki/Inn_Rooms, and for grand company barracks, have a look at https://us.millenium.gg/guide/24362.html.  The "Idle in Room" pull-down entries are the cities where the inn rooms reside or the grand company where the barracks reside. Idle in Room:  Allows you to select an inn room or grand company barracks to enter when SLH idles your character.  This feature takes precedence over the "Idle at Random Aetheryte" and "Idle at Random Aethernet" features (described below.) If you have any available rooms (inn room or a grand company barracks), the "Idle in Room" pull-down will appear, and the "Idle at Random Aetheryte" and "Idle at Random Aethernet" will not be shown.  On the other hand, if you don't have any available rooms, then the "Idle at Random Aetheryte" and "Idle at Random Aethernet" will appear, and the "Idle in Room" pull-down will not be shown.  Be aware that both inn rooms and grand company barracks must be unlocked via various quests - for inn rooms, have a look at https://ffxiv.consolegameswiki.com/wiki/Inn_Rooms, and for grand company barracks, have a look at https://us.millenium.gg/guide/24362.html.  The "Idle in Room" pull-down entries are the cities where the inn rooms reside or the grand company where the barracks reside.
  
-If you select "None" for "Idle in Room", then your character will remain at the next aetheryte to be scanned during the Scan Idle Period, but when you make successful plot visit, Squatter will always teleport your character out of the housing area to a random aetheryte.+If you select "None" for "Idle in Room", then your character will remain at the next aetheryte to be scanned during the Scan Idle Period, but when you make successful plot visit, SLH will always teleport your character out of the housing area to a random aetheryte.
  
 Idle in Random Room:  When checked, SLH will take you to a random entry in your room list (see Idle in Room, above) if you have at least two rooms.  If you do not have at least two rooms, this control will not be shown. Idle in Random Room:  When checked, SLH will take you to a random entry in your room list (see Idle in Room, above) if you have at least two rooms.  If you do not have at least two rooms, this control will not be shown.
  
-Idle at Random Aetheryte:  When checked, SLH will teleport you to a random attuned aetheryte that is not one of the 4 major cities during the scan cycle idle period.   Squatter will always do this automatically when you successfully purchase or relocate a plot (it will also automatically disable Squatter by unchecking the Enable checkbox.)  If you don't have any attuned aetherytes other than the major cities, it fill fall back randomly to one of them.  **This only appears if you have don't have access to any inn rooms or grand company barracks **+Idle at Random Aetheryte:  When checked, SLH will teleport you to a random attuned aetheryte that is not one of the 4 major cities during the scan cycle idle period.   If you don't have any attuned aetherytes other than the major cities, it fill fall back randomly to one of them.  **This only appears if you have don't have access to any inn rooms or grand company barracks **
  
-Idle at Random Aethernet:  When checked, Squatter will teleport you to a random aethernet that is in one of the 4 major residential areas during the scan cycle idle period.   Squatter will always do this automatically when you successfully purchase or relocate a plot (it will also automatically disable Squatter by unchecking the Enable checkbox.) **This only appears if you have don't have access to any inn rooms or grand company barracks **+Idle at Random Aethernet:  When checked, SLH will teleport you to a random aethernet that is in one of the 4 major residential areas during the scan cycle idle period.  **This only appears if you have don't have access to any inn rooms or grand company barracks **
  
-Randomize Scan Start:  When checked, Squatter will begin scanning at a randomly selected entry in the Housing Area Scan List in a randomly chosen direction (forward or backward). The chosen entry serves as the anchor for determining when the Scan Cycle Idle period occurs, which is when the scan wraps around to the start point.  +Randomize Scan Start:  When checked, SLH will begin scanning at a randomly selected entry in the Housing Area Scan List in a randomly chosen direction (forward or backward). The chosen entry serves as the anchor for determining when the Scan Cycle Idle period occurs, which is when the scan wraps around to the start point.  
  
-Serpentine Scan:  When checked, Squatter will use serpentine ordering for traversing through the Housing Area Scan List.  Serpentine ordering means Squatter will reverse direction after each scan cycle completes, eg, 1 2 3 4 4 3 2 1 1 2 3 4 ....  If not checked, then circular ordering is used, eg, 1 2 3 4 1 2 3 4 ...+Serpentine Scan:  When checked, SLH will use serpentine ordering for traversing through the Housing Area Scan List.  Serpentine ordering means SLH will reverse direction after each scan cycle completes, eg, 1 2 3 4 4 3 2 1 1 2 3 4 ....  If not checked, then circular ordering is used, eg, 1 2 3 4 1 2 3 4 ...
  
-Block Trades:  When checked, when any other player tries to trade with you, Squatter will immediately cancel the trade.  You are able to initiate trades without them being canceled. +Block Trades:  When checked, when any other player tries to trade with you, SLH will immediately cancel the trade.  You are able to initiate trades without them being canceled.
- +
-Target Aetherytes:  When checked, Squatter will target the aetheryte before scanning so others will see you interacting with it.+
  
 Change Position During Idle: When checked, this is cause your character to periodically move to random positions around the Aetheryte.  The time between moves is randomly generated from the Base Loiter Duration. Change Position During Idle: When checked, this is cause your character to periodically move to random positions around the Aetheryte.  The time between moves is randomly generated from the Base Loiter Duration.
Line 137: Line 135:
  
 Sync Plot Type:          If checked, changes to the Plot Type control will affect all housing area entries. Sync Plot Type:          If checked, changes to the Plot Type control will affect all housing area entries.
- 
-Sync Transaction Type:   If checked, changes to the Transaction Type control will affect all housing area entries. 
  
 Sync Plot Size:          If checked, changes to the Plot Size Filter controls will affect all housing area entries. Sync Plot Size:          If checked, changes to the Plot Size Filter controls will affect all housing area entries.
Line 146: Line 142:
 ==== Housing Area Scan List ==== ==== Housing Area Scan List ====
  
-The housing area scan list controls how Squatter scans housing areas (surprise!) and, for each housing area, the top level filter criteria for the plots it will attempt to acquire within that housing area.   There are currently 4 entries in this list, one for each of the housing areas currently in the game. Squatter will visit the city aetherytes associated with each housing area in the list to scan for available plots. By default, the visitation order is serpentine.  Squatter chooses 1) which entry will be the first one scanned, which acts as the anchor for determining when the Scan Idle Period begins, and 2) the direction the entries will be visited (forward or backward). When the scan wraps around to the first entry, Squatter enters the Scan Idle Period (delay until Squatter will resume scanning), and when it resumes scanning, if serpentine scanning is enabled, it will go in the opposite direction. By default, Squatter chooses the leftmost entry to start the scan and the forward direction.  If you check "Randomize Scan Start", Squatter will randomly chooses the first entry to scan and direction. So you have some idea of where Squatter is in the scanning process, it color codes the current entry being scanned (green) and the next entry to be scanned (cyan); the "enabled" checkbox for the first entry is green.+The housing area scan list controls how SLH scans housing areas (surprise!) and, for each housing area, the top level filter criteria for the plots it will attempt to visit within that housing area.   There are currently 4 entries in this list, one for each of the housing areas currently in the game. SLH will visit the city aetherytes associated with each housing area in the list to scan for available plots. By default, the visitation order is serpentine.  SLH chooses 1) which entry will be the first one scanned, which acts as the anchor for determining when the Scan Idle Period begins, and 2) the direction the entries will be visited (forward or backward). When the scan wraps around to the first entry, SLH enters the Scan Idle Period (delay until SLH will resume scanning), and when it resumes scanning, if serpentine scanning is enabled, it will go in the opposite direction. By default, SLH chooses the leftmost entry to start the scan and the forward direction.  If you check "Randomize Scan Start", SLH will randomly chooses the first entry to scan and direction. So you have some idea of where SLH is in the scanning process, it color codes the current entry being scanned (green) and the next entry to be scanned (cyan); the "enabled" checkbox for the first entry is green.
  
 For each entry in the housing area scan list, you can specify the following housing area-specific criteria by using the following controls: For each entry in the housing area scan list, you can specify the following housing area-specific criteria by using the following controls:
Line 152: Line 148:
 === Housing Area Control === === Housing Area Control ===
  
-Drop down that allows you to set the housing area for its list entry.  You can set these however you like to create whatever visitation order you desire.  Be aware, Squatter does not enforce any rules on how you do this - you can set them all to the same housing area if you like, and Squatter will visit the same aetheryte 4 times.  It's completely up to you.+Drop down that allows you to set the housing area for its list entry.  You can set these however you like to create whatever visitation order you desire.  Be aware, SLH does not enforce any rules on how you do this - you can set them all to the same housing area if you like, and SLH will visit the same aetheryte 4 times.  It's completely up to you.
  
 === Enable Housing Area Control === === Enable Housing Area Control ===
  
-If checked, the housing area list entry will be included in the scan. The checkbox will be green for housing area Squatter chooses to start the scan.+If checked, the housing area list entry will be included in the scan. The checkbox will be green for housing area SLH chooses to start the scan.
  
 === Divisions to Scan Control === === Divisions to Scan Control ===
Line 162: Line 158:
 Drop down that allows you to select one of the following: Drop down that allows you to select one of the following:
  
-Both Divisions:     Squatter will scan both the Main Division and the Subdivision (60 plots)+Both Divisions:     SLH will scan both the Main Division and the Subdivision (60 plots)
  
-Main Division Only: Squatter will only scan the Main Division (30 plots)+Main Division Only: SLH will only scan the Main Division (30 plots)
  
-Subdivision Only:   Squatter will only scan the Subdivision (30 plots)+Subdivision Only:   SLH will only scan the Subdivision (30 plots)
  
-**Note** When Squatter scans a housing area ward for available plots, the Residential Area Selection control will not change view when it scans subdivision plots 30-60.  Squatter receives the data for all 60 plots when the ward is selected, so you will never see the control's view switch to plots 30-60.  Don't worry, if you selected "Both Divisions" or "Subdivision Only" in the **Divisions to Scan** control, those subdivision plots are being scanned.+**Note** When SLH scans a housing area ward for available plots, the Residential Area Selection control will not change view when it scans subdivision plots 30-60.  SLH receives the data for all 60 plots when the ward is selected, so you will never see the control's view switch to plots 30-60.  Don't worry, if you selected "Both Divisions" or "Subdivision Only" in the **Divisions to Scan** control, those subdivision plots are being scanned.
  
-=== Plot Type to Acquire Control ===+=== Plot Type to Visit Control ===
  
 Drop down that allows you to select one of the following: Drop down that allows you to select one of the following:
  
-Private:      Select this if you wish to acquire a private plot. (Cannot be changed when Plot Status is Buying or Relocating)+Private Only:      Select this if you wish to visit only Private plots. (Cannot be changed when Plot Status is Visiting)
  
-Free Company: Select this if you wish to acquire a Free Company plot. (Cannot be changed when Plot Status is Buying or Relocating)+Free Company Only: Select this if you wish to only visit Free Company plots. (Cannot be changed when Plot Status is Visiting)
  
-=== Plot Transaction to Apply Control ===+Both Plot Types: Select this if you wish to visit both Private and Free Company plots. (Cannot be changed when Plot Status is Visiting)
  
-Drop down that allows you to select one of the following: 
- 
-Purchase: Select this if you wish to buy the plot. (Cannot be changed when Plot Status is Buying or Relocating) 
- 
-Relocate: Select this is you wish to relocate to the plot. (Cannot be changed when Plot Status is Buying or Relocating) 
  
 === Plot Size Filter Controls === === Plot Size Filter Controls ===
  
-(S)mall, (M)edium, and (L)arge:  Check the ones you wish to have Squatter check for availability. Note: only available plots with the size(s) you select will be shown in the Discovered Plots List. +(S)mall, (M)edium, and (L)arge:  Check the ones you wish to have SLH check for availability. Note: only available plots with the size(s) you select will be shown in the Discovered Plots List. 
  
 === Grade Filter Controls === === Grade Filter Controls ===
  
-1 through 5:  Check the ones you wish to have Squatter check for availability. Note: only available plots with the grade(s) you select will be shown in the Discovered Plots List. +1 through 5:  Check the ones you wish to have SLH check for availability. Note: only available plots with the grade(s) you select will be shown in the Discovered Plots List. 
  
  
Line 199: Line 190:
 A scrollable list of plots discovered during scanning. Each line contains the following information: A scrollable list of plots discovered during scanning. Each line contains the following information:
  
-| Status                 | Buying                                                                                                                                                                                             | You are in the process of attempting to buy the plot          | +| Status                 | Visiting | You are in the process of attempting to visit the plot          | 
-|                        | Relocating                                                                                                                                                                                         | You are in the process of attempting to relocate to the plot  | +|                        | Visited | You have visited this plot at least once  | 
-|                        | Purchased                                                                                                                                                                                          | You bought the plot                                           | +|                        | Available                                                                                                                                                                                          | The plot can be acquired                                     | 
-|                        | Relocated                                                                                                                                                                                          | You relocated to the plot                                     | +|                        | Aborted                                                                                                                                                                                            | Visiting the plot was manually terminated               | 
-|                        | Available                                                                                                                                                                                          | The plot can be purchased                                     | +|                        | Purchased | You acquired a previously available plot | 
-|                        | Available-                                                                                                                                                                                         | The plot can be purchased, but you are ineligible             | +|                        | Sold                                                                                                                                                                                               | Someone else acquired a plot that was previously available            |
-|                        | Aborted                                                                                                                                                                                            | Acquisition of the plot was manually terminated               | +
-|                        | Sold                                                                                                                                                                                               | Someone else bought a plot you were trying to buy             |+
 |                        | Owned                                                                                                                                                                                              | You or your Free Company owns the plot                        | |                        | Owned                                                                                                                                                                                              | You or your Free Company owns the plot                        |
 |                        | Shared                                                                                                                                                                                             | You are sharing a Private plot with another owner             | |                        | Shared                                                                                                                                                                                             | You are sharing a Private plot with another owner             |
 | Housing Area           | Town where plot is located                                                                                                                                                                         |                                                               | | Housing Area           | Town where plot is located                                                                                                                                                                         |                                                               |
 +| Plot Type | Type of plot: P (Private) or FC (Free Company) |
 | Ward Number            | Ward in which plot is located                                                                                                                                                                      |                                                               | | Ward Number            | Ward in which plot is located                                                                                                                                                                      |                                                               |
 | Plot Number            | The plot being targeted                                                                                                                                                                            |                                                               | | Plot Number            | The plot being targeted                                                                                                                                                                            |                                                               |
Line 215: Line 205:
 | Grade                  | A number (1-5) that indicates what the initial price of the plot will be when it first comes on the market, and thus corresponds to its "desirability" (1 being the most expensive and desirable)  |                                                               | | Grade                  | A number (1-5) that indicates what the initial price of the plot will be when it first comes on the market, and thus corresponds to its "desirability" (1 being the most expensive and desirable)  |                                                               |
 | Owner                  | The name of the person or Free Company that owns the plot OR                                                                                                                                       |                                                               | | Owner                  | The name of the person or Free Company that owns the plot OR                                                                                                                                       |                                                               |
-| Price                  | Gil required to buy plot (if status is Available, Available-, Buying, or Relocating)                                                                                                               |                                                               | +| Price                  | Gil required to acquire plot                                                                                                                |                                                               | 
-| Discovery Time         | Local time when you detected the plot was available.  This time is persistent and is restored, if warranted, whenever Squatter scans after a restart or reset.                                     |                                                               | +| Visit Time         | Local time when last visited the plot                                    |                                                               | 
-| Hours Since Discovery  | Time that has elapsed since Discovery Time                                                                                                                                                         |                                                               | +| Hours Since Visit | Time that has elapsed since Visit Time                                                                                                                                                         |                                                               | 
-| Hours At Placard       | Fractional number of hours you have spent at the placard trying to buy the plot                                                                                                                    |                                                               |+| Lottery Participants       | Total number of players who have entered the lottery to acquire that plot                                                                                                                    |                                                               |
  
-Clicking on an Available plot when another plot is not currently being acquired will cause Squatter to immediately try to acquire that plot.  +Clicking on an Available or Visited plot will mark that plot to be visited during the next Scan Cycle Idle period. 
- +
-Clicking on an Available plot when another plot is currently being acquired results in a popup that allows you to abort the current acquisition and immediately try to acquire that plot.  +
- +
-Clicking on Buying or Relocating plots results in a popup that allows you to abort the acquisition.  +
  
 Clicking on Aborted plots changes their status back to Available. Clicking on Aborted plots changes their status back to Available.
- 
-Clicking on Available- plots results in a popup that provides the reason for your ineligibility. 
  
 Clicking on Sold plots will remove them from the list. Clicking on Sold plots will remove them from the list.
Line 234: Line 218:
 Clicking on anything other plot status value does nothing. Clicking on anything other plot status value does nothing.
  
-The list is sorted by Plot status, in the following order:  Buying, Relocating, Purchased, Relocated, Available, Available-, Aborted, Sold, Owned.  The secondary sorts fields are Housing Area, Ward Number, and Plot Number.  +The list is sorted by Plot status, in the following order:  Visiting, Purchased, Available, Visited, Aborted, Sold, Owned.  The secondary sorts fields are Housing Area, Ward Number, and Plot Number. 
- +
-__**NOTE**__ +
- +
-If a plot you are visiting is purchased or relocated by someone else, or you are successful purchasing or relocating to it, you will be automatically teleported out of the housing area.  If Idle at Random Aetheryte is not checked, you will be sent to the next aetheryte in the scan rotation; otherwise, Squatter will send you to a random attuned aetheryte.  After teleporting,  Squatter disables itself, so you can see the result and change settings appropriately if you desire (say, to now relocate to a bigger plot than the one you might have just bought.)+
  
 ===== Targets Tab ===== ===== Targets Tab =====
 {{:mistahmikey:squatter:targets.png?400|}} {{:mistahmikey:squatter:targets.png?400|}}
  
-The Targets Tab allows you to prioritize what plots Squatter tries to purchase. +The Targets Tab allows you to prioritize what plots SLH tries to visit. 
  
-Enable Targets: when checked, enables target prioritization; you are prohibited from checking this if you haven't entered some targets for Squatter to consider. When unchecked, Squatter will try to acquire any plot that becomes available.+Enable Targets: when checked, enables target prioritization; you are prohibited from checking this if you haven't entered some targets for SLH to consider. When unchecked, SLH will try to visit any plot that becomes available.
  
-Only Acquire Targets: when checked, Squatter will ONLY try to acquire your targeted plots; if other plots become available, they will be ignored.  When unchecked, if Squatter does not find a targeted plot, it will try to acquire untargeted plots as well.+Only Visit Targets: when checked, SLH will ONLY try to visit your targeted plots; if other plots become available, they will be ignored.  When unchecked, if SLH does not find a targeted plot, it will try to visit untargeted plots as well.
  
 You enter a target plot using the **Priority**, **Housing Area**, **Ward No**, and **Plot No** fields, then add it to the target list using the **Add** button. The **Priority** value is a number (can be float) that is used to order the target list. Larger priority values indicate higher priority.  If you want to change the priority of an existing target, simply enter its housing area, ward number and plot number along with the new priority value and click **Add**. You enter a target plot using the **Priority**, **Housing Area**, **Ward No**, and **Plot No** fields, then add it to the target list using the **Add** button. The **Priority** value is a number (can be float) that is used to order the target list. Larger priority values indicate higher priority.  If you want to change the priority of an existing target, simply enter its housing area, ward number and plot number along with the new priority value and click **Add**.
  
-The **Ward No** and **Plot No** can be set to zero to act as a wildcard in the plot targeting.  So, if you want to target any plot in ward 17, you would enter a plot number of zero.  Likewise, if you want to target plot 10 in any ward, you would enter a ward number of zero.  If both ward number and plot number are zero, Squatter will target all plots in all wards within that **Housing Area** - you can use this to prioritize the housing areas within which Squatter will attempt to acquire plots.+The **Ward No** and **Plot No** can be set to zero to act as a wildcard in the plot targeting.  So, if you want to target any plot in ward 17, you would enter a plot number of zero.  Likewise, if you want to target plot 10 in any ward, you would enter a ward number of zero.  If both ward number and plot number are zero, SLH will target all plots in all wards within that **Housing Area** - you can use this to prioritize the housing areas within which SLH will attempt to visit plots.
  
 You can delete plots from the target list by checking them in the **Selection** column and clicking the **Delete** button.  You can select/deselect them all by using the checkbox at the bottom of the **Selection** column. You can delete plots from the target list by checking them in the **Selection** column and clicking the **Delete** button.  You can select/deselect them all by using the checkbox at the bottom of the **Selection** column.
  
-For relocations, you likely want to ensure **Only Acquire Targets** is checked, since if it is not, Squatter will also relocate to untargeted plots that it encounters before any other targeted plots.+For relocations, you likely want to ensure **Only Visit Targets** is checked, since if it is not, SLH will also relocate to untargeted plots that it encounters before any other targeted plots.
  
-Also, this feature is intended for use when **Auto Buy** is checked on the **Scan Tab** - otherwise, it really doesn't do anything at all. It does not filter the available plot list to only show targeted plots. This design decision was driven by the fact that normally there will only be a few available plots up at any given time, so the effort associated with adding in the filtering behavior is not warranted.+Also, this feature is intended for use when **Auto Visit** is checked on the **Scan Tab** - otherwise, it really doesn't do anything at all. It does not filter the available plot list to only show targeted plots. This design decision was driven by the fact that normally there will only be a few available plots up at any given time, so the effort associated with adding in the filtering behavior is not warranted.
  
 All of the settings on this tab can be saved in your profile.  So if you want different target lists, you can create different profiles to hold them. All of the settings on this tab can be saved in your profile.  So if you want different target lists, you can create different profiles to hold them.
- 
-===== Timing Tab ===== 
-{{:mistahmikey:squatter:timing.png?400|}} 
- 
-The Timing Tab is provided to help tune Squatter's ability to interact with the controls that govern plot buying and relocation. 
- 
-At the top of the tab is a pull down, Set Game FPS, that can be used to modify the FFXIV in-game FPS settings that are available on the System control. Just like that control, you can set the FPS to unlimited, 30, 15, or 7.  This is most useful when you are running multiple instances of the FFXIV client on the same computer. You can use the setting to reduce the graphics processing load on certain clients to, say, improve performance on another client you are using to spam placards.   
- 
-Below the Set Game FPS pulldown is a table that contains timing parameters that are critical to Squatter's placard spamming performance. There are 4 entities Squatter must interact with to acquire a plot: The Plot Placard, the Purchase Land control, the Landowner Selection control, and the Purchase Yes/No control.  The Plot Placard sits just outside the plot and is what the player interacts with to begin a plot transaction.  Clicking on the Plot Placard causes the Purchase Land control to display. From there, clicking the Purchase Land button will either cause the Landowner Selection control or the Purchase Yes/No control to display, depending on what options are available to you to purchase a plot according to your current plot ownership status.  If you own no plots and are not in a Free Company, you will be presented with the Purchase Yes/No control to authorize purchasing a private plot.  Otherwise, the Landowner Selection control will display, which then allows you to select the type of transaction you want, again dependent on your current plot ownership status:  private plot purchase, free company plot purchase, private plot relocation, or free company plot relocation.  Once you click on the desired transaction type, you are presented the Purchase Yes/No control to authorize the selected transaction. 
- 
-Each of these entities requires communication with the FFXIV server and is therefore affected by your network's current latency and your host's current CPU utilization. Attempting to interact with a control before it is ready - i.e., completely initialized - results in a failure that must then be timed out and retried.  To manage the timeout process, two timing parameters are associated with each entity, both in milliseconds: the Total Timeout (total time before failure is declared by Squatter), the Interim Timeout (time delay before Squatter will retry the operation being performed if it hasn't yet succeeded.) The Total Timeout should be a multiple of the Interim Timeout. So, for example, if you have a 2 second Total Timeout, an Interim Timeout could be 200ms, meaning if Squatter doesn't successfully complete its intended operation within 200ms, the operation will be redone up to 10 times until the 2 second Total Timeout is exceeded. Note that these retries are idempotent - that is, they have no impact on the FFXIV server if it is currently executing the prior operation. The default timing values provided work for most normal network latency and CPU utilization situations.  However, if your situation requires something different, these parameters can be adjusted to tune Squatter's use of these entities so that you can mitigate the frequency that timeouts occur. By setting "Spam" Debug level in the Debug Tab, you can get information in the Minion Console Log that will tell you what entities are timing out, giving you a clue as to the correct timing parameters to adjust. The bottom line: this is an advanced feature that is best used in consultation with Squatter support, but you are free to use it yourself if you wish. 
- 
-To give you an idea of how well your timing parameters are working, performance statistics are provided:  Success Rate (total successful entity interactions/total entity interactions), Min Time, Avg Time, and Max Time (minimum, average, and maximum times required to successfully interact with the entity.)  If your success rate is consistently 100%, then your parameters are working well - you might even be able to adjust them downward to increase the rate at which you "spam" the placard.  If any are consistently below 100%, then those entities' timing parameters might need to be adjusted upwards to reduce failure retries.  Additionally, if you are worried that you might be spamming the placard too fast, you can use these parameters to slow down the spamming process to whatever you are comfortable with. 
- 
-A timing issue associated with the Plot Placard control can result in your character slightly moving as the placard is targeted. For the final plot purchase request to be accepted by the server, the placard must be specifically targeted by your character.  Because answering the Yes/No control to make the purchase removes the character's target, it must be retargeted on each purchase failure. This repeated retargeting, if done too slowly, can make your character appear to move a little from time to time - a small head bob or shoulder turn. If you experience this, tuning the Plot Placard timing parameters can eliminate it under normal network latency conditions.  For example, for good connections, setting the Total Timeout to 1000 and Interim Timeout to 25 results in no discernable movement of your character from other players. This will typically result in the Plot Placard failure statistics to rise, and you'll see some error messages in the console log, but that's not problematic to Squatter's ability to purchase the plot.  If you don't want to see the time out error messages, deselect the error debug message level on the Debug Tab.   If you want to tune the placard interaction so failures occur less often, you can increase the Total Timeout to be a little larger than the average placard response time. 
- 
  
 ===== Movement Tab ===== ===== Movement Tab =====
 {{:mistahmikey:squatter:movement.png?400|}} {{:mistahmikey:squatter:movement.png?400|}}
  
-The Movement Tab allows you to control what kind of movement speed Squatter will use to run your character to the placard in the housing area.  There are two types of movement speed enhancements that are used:  running speed actions and mounts. Running speed actions include Sprint, and if you use the right character, Peloton and Fists of Wind.  These are invoked as they are available when the distance you must move is fairly short as indicated by the Mount Cutoff Distance.  When the distance is longer than the Mount Cutoff Distance, a selected or random mount will be used to travel that distance.  The controls on this tab are:+The Movement Tab allows you to control what kind of movement speed SLH will use to run your character to the placard in the housing area.  There are two types of movement speed enhancements that are used:  running speed actions and mounts. Running speed actions include Sprint, and if you use the right character, Peloton and Fists of Wind.  These are invoked as they are available when the distance you must move is fairly short as indicated by the Mount Cutoff Distance.  When the distance is longer than the Mount Cutoff Distance, a selected or random mount will be used to travel that distance.  The controls on this tab are:
  
-Enable Speed Actions:  When checked, Squatter will attempt to use speed actions (Sprint, Peloton, Fists of Wind) whenever they are available and it is appropriate. The mount will take priority if the cutoff distance requirement is met.+Enable Speed Actions:  When checked, SLH will attempt to use speed actions (Sprint, Peloton, Fists of Wind) whenever they are available and it is appropriate. The mount will take priority if the cutoff distance requirement is met.
  
-Speed Action Cutoff Distance (yalms): The distance above which Squatter will use Speed Actions to move your character.+Speed Action Cutoff Distance (yalms): The distance above which SLH will use Speed Actions to move your character.
  
-Enable Mount:  When checked, Squatter will attempt to use a mount whenever one is available and it is appropriate.+Enable Mount:  When checked, SLH will attempt to use a mount whenever one is available and it is appropriate.
  
-Mount Cutoff Distance (yalms): The distance above which Squatter will use a mount to move your character.+Mount Cutoff Distance (yalms): The distance above which SLH will use a mount to move your character.
  
 Mount Selection:  A list of mounts from which you can chose one to use whenever a mount is needed to run that long distance to the placard. Be aware that this list, due to limitations in Minion, contains more mounts than you really own. So be sure you pick one you can actually use, or you'll be legging it out over those longer distances. Mount Selection:  A list of mounts from which you can chose one to use whenever a mount is needed to run that long distance to the placard. Be aware that this list, due to limitations in Minion, contains more mounts than you really own. So be sure you pick one you can actually use, or you'll be legging it out over those longer distances.
  
-Select Random Mount:  When checked, Squatter will randomly pick an available mount that you own to run to the placard. This overrides your Mount Selection.+Select Random Mount:  When checked, SLH will randomly pick an available mount that you own to run to the placard. This overrides your Mount Selection.
 ===== Notifications Tab ===== ===== Notifications Tab =====
 {{:mistahmikey:squatter:notifications.png?400|}} {{:mistahmikey:squatter:notifications.png?400|}}
  
-The Notification Tab allows you tell Squatter to send an email to a desired recipient email account using a desired sender email account.  The events for which Squatter sends a email are:  Available plots are discovered during scanning, a plot transaction is initiated (either via AutoBuy or clicking on a desired available plot), a plot transaction succeeds (you acquired the plot), or a plot transaction fails (someone else acquired the plot.)  Note: these notifications do not occur when Test Mode or Demo Mode is selected, but you can send a test notification if you wish. The controls on this tab are:+The Notification Tab allows you tell SLH to send an email to a desired recipient email account using a desired sender email account.  The events for which SLH sends a email are:  Available plots are discovered during scanning, a plot visit is initiated (either via Auto Visit or clicking on a desired available plot), you win the plot, or someone else wins the plot.  Note: these notifications do not occur when Test Mode or Demo Mode is selected, but you can send a test notification if you wish. The controls on this tab are:
  
 Notifications Enabled: When checked, enables notifications to be sent. Notifications Enabled: When checked, enables notifications to be sent.
Line 312: Line 276:
 Send Test Notification: Clicking this will send a test notification email according to your entries above. Send Test Notification: Clicking this will send a test notification email according to your entries above.
  
-Notification Sent:  The total number of notifications sent during this squatter session.+Notification Sent:  The total number of notifications sent during this SLH session.
  
 Last Notification Send Error:  The output of the command used to send the email if there is an error to help you identify the problem.  "No Error" means the command sent the email without experiencing any immediate error. Last Notification Send Error:  The output of the command used to send the email if there is an error to help you identify the problem.  "No Error" means the command sent the email without experiencing any immediate error.
Line 321: Line 285:
 {{:mistahmikey:squatter:profile.png?400|}} {{:mistahmikey:squatter:profile.png?400|}}
  
-The Profile Tab allows you to persistently store most of Squatter's settings. The profile settings are stored in files unique to the character and game language used to create the profile. You can create as many profiles as you like. The controls on this tab are:+The Profile Tab allows you to persistently store most of SLH's settings. The profile settings are stored in files unique to the character and game language used to create the profile. You can create as many profiles as you like. The controls on this tab are:
  
-Load Current Profile After Reset:  When checked, if you hit Reset on the Scanner Tab, or when Squatter is loaded when you start Minion, after all settings are initialized to their default values, the saved settings in your current profile are loaded.+Load Current Profile After Reset:  When checked, if you hit Reset on the Scanner Tab, or when SLH is loaded when you start Minion, after all settings are initialized to their default values, the saved settings in your current profile are loaded.
  
-Current Profile Name:  The settings file you selected to be the current profile being used by Squatter.+Current Profile Name:  The settings file you selected to be the current profile being used by SLH.
  
 Load: Load all settings from the current profile. Load: Load all settings from the current profile.
Line 342: Line 306:
 {{:mistahmikey:squatter:debug.png?400|}} {{:mistahmikey:squatter:debug.png?400|}}
  
-This tab is primarily intended for use in conjunction with consultation with Squatter support.  It enables various test scenarios and debugging information that are used to help diagnose issues that might occur during Squatter's operation.  The controls on this tab are: +This tab is primarily intended for use in conjunction with consultation with SLH support.  It enables various test scenarios and debugging information that are used to help diagnose issues that might occur during SLH's operation.  The controls on this tab are:
- +
-Enable Log file:  When checked, Squatter will create a unique log file for your session. This only needs to be checked if you are told to do so by Squatter support. +
- +
-Enable Timestamp:  When checked, Squatter will include the current tick count in the debug messages. This provides information that facilitates debugging timing issues. +
- +
-Debug Message Level Settings:  Squatter's debug message system implements a simple filtering mechanism that can be used to allow or inhibit certain message classes, generally in increasing order of verbosity.  The default settings are fairly "quiet", but Squatter support may ask you to enable more verbose settings to gather diagnostic information for investigating issues. +
- +
-Demo Mode: When checked, Squatter will simulate randomly available plots and available gil so you can see how it generally works.  Of course, it can't simulate the actual placard spamming, as the placard must be in the "For Sale" state for that behavior to be available. +
- +
-Test Mode: When checked, Squatter will mark every placard in the first ward of each selected housing area as "Available".  Used in conjunction with "Auto Buy" enabled, it allows verification that there are no floor mesh issues preventing navigation to the placards. Without "Auto Buy" enabled, you can click on specific problem children and subsequently use the Navigation addon to remesh where needed. +
- +
-Ignore Eligibility:  When checked, Squatter will ignore eligibility issues for available plots and always mark them as available (and therefore will attempt to buy them if you have checked AutoBuy or click on them.) +
- +
-====== Plot Acquisition Priority Scheme For Auto Buy ====== +
- +
-Because there are a number of ways to acquire a plot using Auto Buy, a priority scheme is implemented.  The way this scheme works is as follows:+
  
-1. Squatter will only attempt to acquire plots that meet your top-level selection criteria:  checked Housing Areas, selected Divisions To Scan, and checked Plot Sizes. It will ignore any available plots that do not meet these criteria, and they will not appear in the Available Plots list.+Enable Log file:  When checked, SLH will create a unique log file for your session. This only needs to be checked if you are told to do so by SLH support.
  
-2. Squatter will always go after Available plots you click on first (this is true regardless of your Auto Buy state.)+Enable Timestamp:  When checked, SLH will include the current tick count in the debug messages. This provides information that facilitates debugging timing issues.
  
-3. When you are in the scan idle period (the delay between scan attempts), then Squatter will attempt to acquire the highest priority targeted plot it encounters (See the Targets Tab.) if no targets match and you've not checked Only Acquire Targets, then Squatter will attempt to acquire the the plot **it deems as having been on the market the longest.** This determination is somewhat complicated and includes considerations for initial plot prices and the time since Squatter discovered a plot became available. The goal is to get you at a plot that you can buy the quickest - the longer a plot has been on the market, the shorter the amount of time you will likely need to spend at it spamming its placard. When there are multiple plots available, this scheme tends to maximize your ability to acquire plots over time, as you won't be wasting time at a plot that just came on the market if others have been on longer, thereby potentially missing buy opportunities.+Debug Message Level Settings:  SLH's debug message system implements a simple filtering mechanism that can be used to allow or inhibit certain message classes, generally in increasing order of verbosity.  The default settings are fairly "quiet", but SLH support may ask you to enable more verbose settings to gather diagnostic information for investigating issues.
  
-If more than one plot has the same highest priority (i.e., Squatter believes they have been on the market the same amount of time), Squatter will attempt to acquire the one that has lowest price.+Demo Mode: When checked, SLH will simulate randomly available plots and available gil so you can see how it generally works.  Of course, it can't simulate the actual placard spamming, as the placard must be in the "For Sale" state for that behavior to be available.
  
 +Test Mode: When checked, SLH will mark every placard in the first ward of each selected housing area as "Available".  Used in conjunction with "Auto Visit" enabled, it allows verification that there are no floor mesh issues preventing navigation to the placards. Without "Auto Visit" enabled, you can click on specific problem children and subsequently use the Navigation addon to remesh where needed.
 ====== Support ====== ====== Support ======
  
-For support or requests, please contact me on discord: https://discord.gg/4fdbD8G.  I will respond as soon as I am able, generally within 24 hours at most.+For support or requests, please contact me on discord: https://discord.gg/uDWDPJSk7X.  I will respond as soon as I am able, generally within 24 hours at most.
  
 When you need support, please provide me, at a minimum, the following: When you need support, please provide me, at a minimum, the following:
Line 380: Line 329:
 Additionally, **you should not use an account you use for in-game communications so you can't be doxed as a botter. ** Additionally, **you should not use an account you use for in-game communications so you can't be doxed as a botter. **
  
-If that initial information is insufficient for me to determine the cause, I will ask you to set other debug settings that will provide more information. Squatter has been very stable after many months of use, but it is also a very complex piece of software, and can be negatively affected by a number of factors over which I have no control, not the least of which is what other addons you run. I appreciate your patience in working with me to solve your issue when it is not slam-dunk easy. As long as you are willing to try the debugging measures I request, I will work with you until your problem is solved.+If that initial information is insufficient for me to determine the cause, I will ask you to set other debug settings that will provide more information. SLH has been very stable after many months of use, but it is also a very complex piece of software, and can be negatively affected by a number of factors over which I have no control, not the least of which is what other addons you run. I appreciate your patience in working with me to solve your issue when it is not slam-dunk easy. As long as you are willing to try the debugging measures I request, I will work with you until your problem is solved.
squatter.txt · Last modified: 2022/12/13 06:56 by mistahmikey

Page Tools