User Tools

Site Tools


squatter_lottery_helper

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
squatter_lottery_helper [2026/01/10 17:51] – [Requirements] mistahmikeysquatter_lottery_helper [2026/11/14 13:26] (current) – Update release summary, shared controls, support and full-window screenshots mistahmikey
Line 2: Line 2:
  
 {{::mistahmikey:squatter:squatter.png?400|}} {{::mistahmikey:squatter:squatter.png?400|}}
 +
 +===== Release Summary =====
 +
 +**Squatter Lottery Helper 2.0.0**
 +
 +  * Scans residential plots, supports automatic or selected visits, records lottery participation, and revisits bid plots and refunds.
 +  * Shared travel coordinates plot visits with participating addons. Housing initialization handles unavailable controls, and unreadable visit files are reported in the log.
 +  * Requires MML 6.0.0. Display Language is saved per region-based profile. Lottery entry and claiming won plots remain manual.
  
 ===== What it does ===== ===== What it does =====
Line 11: Line 19:
   * Allows you to specify what size plot you'd like to visit: Small, Medium, and Large.   * Allows you to specify what size plot you'd like to visit: Small, Medium, and Large.
   * Allows you to specify which residential districts to scan:  Mist, The Lavender Beds, The Goblet, Shirogane, or Empyreum.   * Allows you to specify which residential districts to scan:  Mist, The Lavender Beds, The Goblet, Shirogane, or Empyreum.
-  * Automatically uses speed actions (Sprint, Peloton, Fists of Wind) and mounts in residential areas to get you to the placard as quickly as possible.+  * Automatically uses speed actions (Sprint, Peloton) and mounts in residential areas to get you to the placard as quickly as possible.
   * Records any plot you bid on so you can easily travel to that plot to check its result status. For failed bids, SLH will automatically collect your refund.   * Records any plot you bid on so you can easily travel to that plot to check its result status. For failed bids, SLH will automatically collect your refund.
   * Optionally creates CSVs when the Scan Cycle Idle period is entered that 1) record available plot information, including lottery participation status and counts, after those plots have been visited or 2) record plot information for every scanned plot.   * Optionally creates CSVs when the Scan Cycle Idle period is entered that 1) record available plot information, including lottery participation status and counts, after those plots have been visited or 2) record plot information for every scanned plot.
Line 23: Line 31:
 ===== Requirements ===== ===== Requirements =====
  
-You must also download MistahMikeysLib from the store.  It's free, of course.+Install the free MistahMikeysLib addon from the store. This update of Squatter Lottery Helper requires MistahMikeysLib 6.0.0; update the addon and library together. 
 + 
 +Game-data lists use MML's shared loading and cache. The first use of a list may take longer while its required data becomes available.
  
 SLH supports the following languages: EN, FR, JP, KR, CN, and TC. SLH supports the following languages: EN, FR, JP, KR, CN, and TC.
Line 41: Line 51:
 They are trivial to complete. They are trivial to complete.
  
-** Other addons you allow to run at the same time SLH is running might cause it to fail.  Please ensure that no FFXIVMinon tasks are running, Assist in particular, or things will not go well.** +** Other addons you allow to run at the same time SLH is running might cause it to fail.  Please ensure that no FFXIVMinon tasks are running, Assist in particular, or things will not go well.**
  
 __**IMPORTANT**__ __**IMPORTANT**__
Line 50: Line 60:
  
 Existing users of the original Squatter addon can purchase SLH for a reduced price.  Select the Squatter Lottery Helper Update addon from the Minion store to take advantage of this special offer. Existing users of the original Squatter addon can purchase SLH for a reduced price.  Select the Squatter Lottery Helper Update addon from the Minion store to take advantage of this special offer.
 +
 +If a saved house-visit file cannot be read, SLH records the read error in its log instead of failing while loading it. Check the Debug log if your saved visit information is unavailable.
 +
 +===== Shared Travel and Reloads =====
 +Travel for scanning, plot visits, selected targets, and idle rooms now uses MML's shared travel coordination. Only one trip can run across participating addons; competing requests are rejected rather than queued or allowed to interrupt the owner. Avoid starting a different travel addon during a scan or visit workflow. If travel is rejected, finish or cancel the owning addon's trip before retrying the SLH operation. Reset does not stop movement owned by another participating addon. Main-division and subdivision destinations use the same shared housing travel service.
 +
 +During a normal Lua reload or unload, MML cancels owned travel and waits for its movement and transport to settle before allowing the reload or unload to complete. An already-issued teleport or area transition may still finish during that cleanup. The next load does not resume the old trip. Saved profiles and addon data are retained; enabled settings or profile loading may start new addon work according to your existing settings.
 +
 +This coordination applies only to participating addons. It cannot prevent unrelated addons from issuing their own movement. Avoid running conflicting movement automation at the same time.
  
 ====== UI ====== ====== UI ======
 +
 +The descriptions reflect the current release. Some screenshots show earlier layouts or English labels; the text describes the current controls.
  
 You start SLH via the FFXIVMinion menu drop down. It's under the "Mistah Mikey'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. You start SLH via the FFXIVMinion menu drop down. It's under the "Mistah Mikey'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.
Line 66: Line 87:
 {{:mistahmikey:squatter:scan.png?1000|}} {{:mistahmikey:squatter:scan.png?1000|}}
  
-This tab generally controls scanning for available plots and the plot visiting process. +This tab generally controls scanning for available plots and the plot visiting process.
 The two lines below the tab selection line show your Available Gil and the current Housing Lottery Status. If you have bid on a plot, the Housing Lottery Status will show you its lottery number and plot location. When SLH is enabled and it is either in its Scan Cycle Idle period (waiting for next scan cycle to being) or you have no aetherytes selected in the Housing Area Scan List, you can single left click on the Housing Lottery Status line to travel to the plot on which you bid. If you travel to the plot during the results period, SLH will automatically accept your refund.  If you win, nothing is done automatically yet due to a lack of information about how accepting the lottery win works. The two lines below the tab selection line show your Available Gil and the current Housing Lottery Status. If you have bid on a plot, the Housing Lottery Status will show you its lottery number and plot location. When SLH is enabled and it is either in its Scan Cycle Idle period (waiting for next scan cycle to being) or you have no aetherytes selected in the Housing Area Scan List, you can single left click on the Housing Lottery Status line to travel to the plot on which you bid. If you travel to the plot during the results period, SLH will automatically accept your refund.  If you win, nothing is done automatically yet due to a lack of information about how accepting the lottery win works.
  
Line 160: Line 181:
 === Plot Size Filter Controls === === Plot Size Filter Controls ===
  
-(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. +(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 SLH 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 198: Line 219:
 | Winning Number | The winning lottery number | | Winning Number | The winning lottery number |
  
-Left clicking on an Available, Bid, or Visited plot will mark that plot to be visited during the next Scan Cycle Idle period. +Left clicking on an Available, Bid, or Visited plot will mark that plot to be visited during the next Scan Cycle Idle period.
  
 Left clicking on Aborted or Visited plots changes their status back to Available or Bid as appropriate. Left clicking on Aborted or Visited plots changes their status back to Available or Bid as appropriate.
Line 206: Line 227:
 Left clicking on anything other plot status value does nothing. Left clicking on anything other plot status value does nothing.
  
-The list is sorted by Plot status, in the following order:  Visiting, Bid, Purchased, Available, Visited, 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, Bid, Purchased, Available, Visited, Aborted, Sold, Owned.  The secondary sorts fields are Housing Area, Ward Number, and Plot Number.
  
 ===== 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 visit. +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 visit 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. |
Line 231: Line 252:
 {{:mistahmikey:squatter:movement.png?400|}} {{:mistahmikey:squatter:movement.png?400|}}
  
-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:+The Movement Tab allows you to control what kind of movement speed will be used to move your character to placards in housing areas.  There are two types of movement speed enhancements that are used:  running speed actions and mounts. Running speed actions include Sprint and, where available for your job, Peloton.  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, 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. |+| Enable Speed Actions | When checked, SLH will attempt to use speed actions (Sprint or Peloton) 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 SLH 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, SLH 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 SLH 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. If you pick one it turns out you cannot use (because you don't own it or you are in a zone where mounts aren't allowed), a popup will appear informing you of the situation. | +| Mount Selection | A list of mounts from which you can chose one to use whenever a mount is needed to travel to the destination. Be aware that this list, due to limitations in Minion, contains more mounts than you really own. If you pick one it turns out you cannot use (because you don't own it or you are in a zone where mounts aren't allowed), a popup will appear informing you of the situation. | 
-| 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. |+| Select Random Mount | When checked, SLH will randomly pick an available mount that you own to travel to the destination. This overrides your Mount Selection. | 
 ===== Notifications Tab ===== ===== Notifications Tab =====
 {{:mistahmikey:squatter:notifications.png?400|}} {{:mistahmikey:squatter:notifications.png?400|}}
Line 259: Line 281:
 {{:mistahmikey:squatter:profile.png?400|}} {{:mistahmikey:squatter:profile.png?400|}}
  
-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:+The Display Language choice on Debug is saved with this addon's profile. Save the profile after changing it; loading that profile restores the choice. Profiles and the current-profile selection are separated by game region, not by the display language. 
 + 
 +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 region 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 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. | | 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. |
Line 268: Line 292:
 | Add | Create the new profile and save all current settings to it. | | Add | Create the new profile and save all current settings to it. |
  
-The table is a list of all the profiles you have created for the current character and game language.  Using the "Selection" column, you can select specific profiles for the operations Delete or Make Current.  Obviously, only one profile at a time can be made current, so you can only select one for that operation, but you can select as many as you like for the Delete operation.  You can select/deselect all profiles by using the checkbox in the operation row. ** Be aware that profile values are only saved when you explicitly request them to be saved via the Save button. ** +The table is a list of all the profiles you have created for the current character and game region.  Using the "Selection" column, you can select specific profiles for the operations Delete or Make Current.  Obviously, only one profile at a time can be made current, so you can only select one for that operation, but you can select as many as you like for the Delete operation.  You can select/deselect all profiles by using the checkbox in the operation row.  ** Be aware that profile values are only saved when you explicitly request them to be saved via the Save button. **
  
 ===== Debug Tab ===== ===== Debug Tab =====
- 
 {{:mistahmikey:squatter:debug.png?400|}} {{:mistahmikey:squatter:debug.png?400|}}
  
-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:+This tab is primarily intended for use in conjunction with consultation with support.  It enables various test scenarios and debugging information that are used to help diagnose issues that might occur during operation.  The controls on this tab are: 
 + 
 +Changing Display Language refreshes presentation without resetting active work. It does not change game text, interaction matching, command destination names, or region-based profile selection. Some screenshots show earlier controls or English labels. 
 + 
 +| Display Language | Choose Automatic (Game Language), English, French, Japanese, Chinese (Simplified), Korean, or Chinese (Traditional). This affects this addon's interface. Missing UI translations use English. | 
 +| Enable Log File | When checked, a unique log file will be created for your session. This only needs to be checked if you are told to do so by support. | 
 +| Enable Timestamp | When checked, the current tick count will be included in the debug messages. This provides information that facilitates debugging timing issues. | 
 +| Debug Message Level Settings | The 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. When checked, the corresponding message class is enabled. | 
 +| Enable Async Logging | When checked, log output for periodic writing is buffered. | 
 +| Log Flush Interval (ms) | Shown when async logging is enabled; sets the buffer flush interval in milliseconds. | 
 +| Cleanup Log Files | When clicked, runs the library's log-file cleanup; progress is shown while cleanup runs. |
  
-| 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. | 
-| Enable Timestamp | When checked, SLH will include the current tick count in the debug messages. This provides information that facilitates debugging timing issues. | 
-| 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. | 
 | 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 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. | | 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 ====== 
  
 +Additional tracing and diagnostic panels may appear when authorized by the library. Use these with support guidance.
 +
 +====== Support ======
 For bug support, please post a message on discord: https://discord.gg/J67ybRCRqt.  I will respond as soon as I am able, generally within 24 hours at most. For bug support, please post a message on discord: https://discord.gg/J67ybRCRqt.  I will respond as soon as I am able, generally within 24 hours at most.
  
Line 289: Line 320:
  
   - Enable the debug information category on the Debug Tab and do what you did to create the problem.  Then take a screen shot of your Minion Console Log when the problem occurs. Make sure the Log's window as big as possible to show the maximum amount of output.  If the output is larger than the window, then scroll the offscreen portions into view and send multiple screen shots.   - Enable the debug information category on the Debug Tab and do what you did to create the problem.  Then take a screen shot of your Minion Console Log when the problem occurs. Make sure the Log's window as big as possible to show the maximum amount of output.  If the output is larger than the window, then scroll the offscreen portions into view and send multiple screen shots.
-  - A screen shot of your SLH scanner tab+  - A screenshot of SLH's Scanner tab and the affected housing area, ward, and plot
  
 If you post this information to the specified channel (NOT RECOMMENDED), **please ensure it does not contain any information that identifies your account, character, or server.**  For complete anonymity, just DM it to mistahmikey#4073. If you post this information to the specified channel (NOT RECOMMENDED), **please ensure it does not contain any information that identifies your account, character, or server.**  For complete anonymity, just DM it to mistahmikey#4073.
 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. SLH is 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. This is a complex piece of software that can be negatively affected by a number of factors over which I have no control, including the 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_lottery_helper.txt · Last modified: 2026/11/14 13:26 by mistahmikey

Page Tools