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:26] – [Housing Area Scan Criteria Synchronization 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 112: Line 112:
 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.   SLH will always do this automatically when you successfully purchase or relocate a plot (it will also automatically disable SLH 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, SLH will teleport you to a random aethernet that is in one of the 4 major residential areas during the scan cycle idle period.   SLH will always do this automatically when you successfully purchase or relocate a plot (it will also automatically disable SLH 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, 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.   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.  
Line 142: Line 142:
 ==== Housing Area Scan List ==== ==== Housing Area Scan List ====
  
-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 acquire 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.+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 166: Line 166:
 **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. **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 ===
Line 195: 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 211: 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 SLH 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 SLH 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 230: 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, SLH will send you to a random attuned aetheryte.  After teleporting,  SLH 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 SLH 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 SLH to consider. When unchecked, SLH 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, SLH will ONLY try to acquire 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 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, 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 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, SLH 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.
Line 276: Line 260:
 {{:mistahmikey:squatter:notifications.png?400|}} {{:mistahmikey:squatter:notifications.png?400|}}
  
-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 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 332: Line 316:
 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. 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 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. +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.
- +
-Ignore Eligibility:  When checked, SLH 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.) +
 ====== 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:
squatter.txt · Last modified: 2022/12/13 06:56 by mistahmikey

Page Tools