Differences

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

--- squatter [2022/11/01 02:16] – [Scan Cycle Teleport Controls] mistahmikey
+++ squatter [2022/12/13 06:56] (current) – [Mistah Mikey's Squatter] mistahmikey
@@ Line 1: / Line 1: @@
-====== Squatter Lottery Helper (SLH) ======
+====== Mistah Mikey's Squatter ======
 {{::mistahmikey:squatter:squatter.png?400|}}
+<color #ed1c24>
+Due to the 6.1 changes in how plot acquisition works, Squatter has been discontinued, and will no longer be updated.  For help determining plot availability and lottery status, please check out Squatter Lottery Helper.
+</color>
 ===== What it does =====
-Scans selected residential areas for available plots, and at your discretion, visits them and records how many lottery participants there are.
+Scans all residential areas for available plots, and at your discretion, travels to a chosen plot, and attempts to either buy it by spamming its placard or relocate to it.
-  * 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 immediately travel to the selected plot.  In manual mode, it will allow selection of a desired plot from a list of all available plots.
-  * Allows you to target specific plots by ward and plot number to visit.
+  * Allows you to specify what kind of plot to buy: Private Individual, or Free Company.
-  * Allows you to specify what kind of plot to visit: Private, Free Company, or both.
+  * Allows you to specify what kind of buying transaction you desire: Purchase or Relocation.
-  * 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 buy: 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, and Shirogane.
   * Automatically uses speed actions (Sprint, Peloton, Fists of Wind) and mounts in residential areas to get you to the placard as quickly as possible.
-  * Optionally creates a CSV that records all the available plot information after the plots have been visited when the Scan Cycle Idle period is entered.
+You can use Squatter several different ways:
+  * As a tool to quickly scan all housing areas for available plots (even in worlds other than your home world).
+  * To buy or relocate to an available plot you select (only in your home world).
+  * To automatically buy or relocate to the first plot that meets your criteria (only in your home world).
 ===== What it does not do =====
-It currently does not have any features to automatically enter you into the lottery for a desired plot or to automatically claim a won plot.  Depending on customer feedback, it might be possible to add such features in a future version.
+Guarantee you will be immediately successful buying a plot.  It can take a LONG time, even with an addon that spams the placard every second to purchase it's plot, before you successfully beat out everyone else doing the same thing.  Patience is a virtue. At least in Auto Buy mode, it will continuously attempt to buy other available plots after an unsuccessful attempt.  YMMV.
-It does not check your eligibility to actually acquire an available plot - it is strictly a data gathering tool at this point.
 ===== Requirements =====
 You must also download MistahMikeysLib from the store.  It's free, of course.
-Currently, SLH supports English, French, Japanese, Chinese. and Korean.  All these versions should work, but some translation work remains for the non-English versions.
+Currently, Squatter supports English, French, Japanese, Chinese. and Korean.  All these versions have been verified as successfully buying and relocating plots.
-You must ensure FFXIV, Minion, and SLH are always updated to their latest versions.
+You must ensure FFXIV, Minion, and Squatter are always updated to their latest versions.
-You must be attuned to all the major city aetherytes (Limsa Lominsa Lower Decks, New Gridania, Ul'dah - Steps of Nald, Kugane, and Foundation).
+You must be eligible to buy or relocate to the type of plot you desire.  You can only buy or relocate to plots on your home world. You can only own one private plot and one Free Company plot. No other member of a Free Company that is associated with a plot can buy an additional Free Company plot. To purchase a plot privately, you must have at least one class at level 50, and you must be ranked at Second Lieutenant or above in one of the Grand Companies. To purchase a plot for a Free Company, you must be in the Free Company an have permission to purchase a plot.  A Free Company must be at least rank 6 and have at least 4 members for a member to purchase a lot for it. For additional information, please see https://na.finalfantasyxiv.com/lodestone/playguide/contentsguide/housing_land/.
-To enable SLH to scan for available plots, you must have completed all the following unlock quests, which adds the "Residential District Aethernet" option to each major city's Aetheryte:
+You must be attuned to all the major city aetherytes (Limsa Lominsa Lower Decks, New Gridania, Ul'dah - Steps of Nald, and Kugane).
+To enable Squatter to scan for available plots, you must have completed all the following unlock quests, which adds the "Residential District Aethernet" option to each major city's Aetheryte:
   -Where the Heart Is (Mist)- Lower La Noscea, Ahctkoen – X32,Y20
@@ Line 38: / Line 47: @@
 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 Squatter is running might cause Squatter to fail.  Please ensure that no FFXIVMinon tasks are running, Assist in particular, or things will not go well.**
 __**IMPORTANT**__
-SLH will teleport to each major city's aetheryte to scan its associated residential district for available plots. THIS COSTS GIL.  To keep the amount of gil spent scanning reasonable, you can specify a delay between successive scans of the 5 residential districts, so the gil burn is tolerable. Given that the lottery entry period is several days long, you only need to scan as often as you desire to have up to date lottery participant totals.
+Squatter will teleport to each major city's aetheryte to scan its associated residential district for available plots. THIS COSTS GIL.  To keep the amount of gil spent scanning reasonable, there is a default 30 minute delay between successive scans of the 4 residential districts, so the gil burn is tolerable.  My experience is the plots are for sale for very long periods of time, so it is highly unlikely you will miss an opportunity in 30 minutes. By default, after each successive scan delay, the scan direction reverses, starting with the current aetheryte (see the Serpentine Scan Enabled control below.) This provides a small gil savings by slightly reducing the number of teleports required to scan all residential districts.
+As with any botting activity that occurs in the open world, misuse of this addon might draw attention to yourself as a botter.  I have used it continuously for days without any ill affect, but that doesn't guarantee you won't have an issue.   The easiest way to avoid a ban is to not use "Auto Buy" mode - simply do the scan, and select an available plot from the list to buy.  Then, when your character arrives at the placard, it is programmed to try to find a random open spot near the placard to park itself, but if it doesn't and winds up parking on top of another player, you can uncheck "Enable", move your character to an open spot, then check "Enable" again.  On the other hand, "Auto Buy" often results in you being the first character at the placard, and given Squatters ability to select an open spot automatically, bad positioning is rarely an issue.
 ====== 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 Squatter via the FFXIVMinion menu drop down. It's under the "MM's Addons" menu item.  Clicking "Squatter" should pop up its UI window.  The UI consists of different input areas called tabs.  Each tab is described below.
-Each tab is described below.
 ===== Scanner Tab =====
 {{:mistahmikey:squatter:scan.png?400|}}
-This tab generally controls scanning for available plots and the plot visiting process.
+This tab generally controls scanning for available plots and the buying process.
-The two lines below the tab selection line show your Available Gil and the current Housing Lottery Status.
 ==== Character's Free Company and Plot Associations ====
-This area of the tab provides information about your Free Company membership and current plot associations. The information is automatically updated whenever SLH is loaded or reset.  However, because SLH must interact with FFXIV controls (dialogs) to accumulate this information, it can sometimes fail for a variety of reasons that are beyond SLH's control.  If you see that the information does not reflect your reality, or if you change those associations during the game, you can hit the "Refresh" button and SLH will attempt to gather the information again.  If SLH is persistently unable to gather this information, it likely means some other addon you have installed is interfering with SLH's ability to operated the required controls.  Please report all such issues on the SLH discord channel.
+The top part of the tab provides information about your Free Company membership and current plot associations.  This information is used by Squatter to determine your "eligibility" to acquire a plot, since SoE requires you meet certain conditions. The information is automatically gathered whenever Squatter is loaded or reset.  However, because Squatter must interact with FFXIV controls (dialogs) to accumulate this information, it can sometimes fail for a variety of reasons that are beyond Squatter's control.  If you see that the information does not reflect your reality, or if you change those associations during the game, you can hit the "Refresh" button and Squatter will attempt to gather the information again.  If Squatter is persistently unable to gather this information, it likely means some other addon you have installed is interfering with Squatter's ability to operated the required controls.  If you find that Squatter is incorrectly preventing you from acquiring plots you should be able to acquire, then you can check "Ignore eligibility" on the Debug tab to disable all eligibility checks. Please report all such issues on the Squatter discord channel.
-When SLH is in it's Scan Cycle Idle Period (waiting to begin it's next scan of the aetherytes), or if you have no aetherytes selected, you can click on any of your associated plots and it will navigate you to that plot - sort of a poor man's mini-aetheryte. SLH MUST be enabled for this to occur. Once you arrive at the plot, SLH will disable itself by unchecking "Enable".  To have SLH resume scanning, recheck "Enable".
+When Squatter is in it's Scan Cycle Idle Period (waiting to begin it's next scan of the aetherytes), or if you have no aetherytes selected, you can click on any of your associated plots and it will navigate you to that plot - sort of a poor man's mini-aetheryte. Squatter MUST be enabled for this to occur. Once you arrive at the plot, Squatter will disable itself by unchecking "Enable".  To have Squatter resume scanning, recheck "Enable".
-If you would like SLH to track the demolition timer for the houses on your associated plots, deselect all aetherytes, make sure SLH is enabled, then click on the plots you own one by one to travel to them.  When you arrive, you MUST enable SLH again (it is automatically disabled upon arrival.) You don't have to use SLH to travel to your plots - you can travel to them however you please. Once at the plot, make sure SLH is enabled, enter your house, and you will see the current time recorded in the Last Visit Date column.  SLH will automatically tell you how many days it's been since that visit date in the Days Since Visit column. The last visit date is saved across logins - BUT - SLH also will delete this information if it determines you no longer own the plot.  This might occur accidentally if, for whatever reason, SLH is unable to accurately determine your plot ownership, which can occur from time to time.  If that happens, simply repeat this procedure for the plots that have NEVER as their Last Visit Date to start the ball rolling again.
+If you would like Squatter to track the demolition timer for the houses on your associated plots, deselect all aetherytes, make sure Squatter is enabled, then click on the plots you own one by one to travel to them.  When you arrive, you MUST enable Squatter again (it is automatically disabled upon arrival.) You don't have to use Squatter to travel to your plots - you can travel to them however you please. Once at the plot, make sure Squatter is enabled, enter your house, and you will see the current time recorded in the Last Visit Date column.  Squatter will automatically tell you how many days it's been since that visit date in the Days Since Visit column. The last visit date is saved across logins - BUT - Squatter also will delete this information if it determines you no longer own the plot.  This might occur accidentally if, for whatever reason, Squatter is unable to accurately determine your plot ownership, which can occur from time to time.  If that happens, simply repeat this procedure for the plots that have NEVER as their Last Visit Date to start the ball rolling again.
 The controls on this tab are described below.
-==== Enable, Auto Visit, Travel Only, Create CSV, Reset, and Discord Controls ====
+==== Enable, Auto Buy, Create CSV, Reset, and Discord Controls ====
+Enable: When checked, enables Squatter to run.  If you disable, reenabling will continue execution from the point you disabled. If you were in the middle of buying a plot and have moved out of the housing area, you must reset to put things back in order.
+Auto Buy: When checked, Squatter will attempt to travel to an available plot to acquire it automatically. All housing areas will be completely scanned before attempting to buy, and the highest priority plot will be purchased (the priority scheme is described later.)
+Travel Only: When checked, Squatter will attempt to travel to an available plot, but will not attempt to acquire 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 Squatter to resume its normal scanning operations.
+Create CSV:  When checked, Squatter 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.  The contents should be self-explanatory; it is pretty much the same data you see in the Discovered Plots List, but it is for EVERY plot in the associated Housing Area.  The files exist in <Minion Installation Directory>/Bots/FFXIVMinion64/LuaMods/Squatter/CSVData - the file names are randomly generated. Use the data as you please.
+Reset:  Resets all settings to their default initial values. You can use this to abort a purchase if you can catch it in time. If you have a current profile set, and Load Current Profile After Reset (Profile Tab) is enabled, then your saved profile values will be loaded.  The Reset button will disappear while the reset is in progress, and will reappear when it completes.
+Discord Icon:  Takes you to the Squatter Discord channel if you need support.  Be advised I am in the Eastern Time zone (UTC-05:00).
-Enable: When checked, enables SLH to run.  If you disable, SLH execution is paused; reenabling will continue execution from the point you disabled.
+==== Transaction Completion Action Controls ====
-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.
+Shutdown Game After Buy Success:  When checked, if you successfully purchase or relocate to a plot, Squatter will teleport you to the next aetheryte in the scan list and exit the game.
-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.
+Shutdown Game After Buy Failure: When checked, if someone else acquires the plot you are trying to obtain, Squatter will teleport you to the next aetheryte in the scan list and exit the game.
-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.
+Buy Success Emote:  You can select an emote from the dropdown to be performed when you successfully obtain a plot.  "None" is the default.
-Reset:  Resets all settings to their default initial values. You can use this to abort a visit if you can catch it in time. If you have a current profile set, and Load Current Profile After Reset (Profile Tab) is enabled, then your saved profile values will be loaded.  The Reset button will disappear while the reset is in progress, and will reappear when it completes.
+Buy Failure Emote:  You can select an emote from the dropdown to be performed when you someone else obtains the plot you are trying to obtain.  "None" is the default.
-Discord Icon:  Takes you to the SLH Discord channel if you need support.  Be advised I am in the Eastern Time zone (UTC-05:00).
+__**NOTE**__
+If you use minion to autolaunch the game, be aware it will automatically log you back in after being shutdown. Minion doesn't provide any way to prevent this behavior.  If you don't want Minion to automatically log you back in, start the game manually, then manually attach Minion to the game.
 ==== Scan Cycle Teleport Controls ====
-Because teleporting costs gil, you have a couple of ways you can control how often SLH will cycle through your selected aetherytes to scan for available plots. After you have completed scanning all selected aetherytes, these controls allow you to specify how long you will idle before beginning to scan the aetherytes again (the scan idle period.)
+Because teleporting costs gil, you have a couple of ways you can control how often Squatter will cycle through your selected aetherytes to scan for available plots. After you have completed scanning all selected aetherytes, these controls allow you to specify how long you will idle before beginning to scan the aetherytes again (the scan idle period.)
 Scan Hourly: Determines how scanning resumes when you are in the scan idle period.  If not checked, you will resume scanning Scan Cycle Interval minutes from when you scanned the first selected housing area.  If checked, you will resume scanning Hourly Scan Cycle Delay seconds after each clock hour, local time. Whenever you change this setting, a rescan of all the selected aetherytes immediately occurs, with the next scan occurring in accordance with the new setting.  **Important**: Make sure you sync your clock if you want your hourly scan to be reasonably precise!
-Scan Cycle Interval (minutes): The number of minutes SLH will delay between successive scans for available plots. It is 30 minutes by default, but you can set this to whatever you like. The base time to compute the deadline for starting the next scan cycle is the time the first selected aetheryte is scanned. So, for example, if it takes 2 minutes to scan all the aetherytes, and you've set Scan Cycle Interval to 5 minutes, scanning will resume in 3 minutes.  You will see this control only when Scan Hourly is not checked.
+Scan Cycle Interval (minutes): The number of minutes Squatter will delay between successive scans for available plots. It is 30 minutes by default, but you can set this to whatever you like. The base time to compute the deadline for starting the next scan cycle is the time the first selected aetheryte is scanned. So, for example, if it takes 2 minutes to scan all the aetherytes, and you've set Scan Cycle Interval to 5 minutes, scanning will resume in 3 minutes.  You will see this control only when Scan Hourly is not checked.
-Hourly Scan Cycle Delay (seconds): The number of seconds after each clock hour SLH will resume scanning.  You will only see this control only when Scan Hourly is checked.
+Hourly Scan Cycle Delay (seconds): The number of seconds after each clock hour Squatter will resume scanning.  You will only see this control only when Scan Hourly is checked.
 Scan Idle Period Remaining (minutes):  When you are in the Scan Idle Period, this will count down the number of minutes remaining until the next scan cycle is started.

User Tools

Site Tools

Differences

Page Tools