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
squatter [2021/09/04 06:32] – [Scan Cycle Teleport Controls] mistahmikeysquatter [2022/12/13 06:56] (current) – [Mistah Mikey's Squatter] mistahmikey
Line 2: Line 2:
  
 {{::mistahmikey:squatter:squatter.png?400|}} {{::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 ===== ===== What it does =====
Line 29: Line 33:
 You must ensure FFXIV, Minion, and Squatter are always updated to their latest versions. You must ensure FFXIV, Minion, and Squatter are always updated to their latest versions.
  
-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.+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/.
  
 You must be attuned to all the major city aetherytes (Limsa Lominsa Lower Decks, New Gridania, Ul'dah - Steps of Nald, and Kugane). 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 quests, which adds the "Residential District Aethernet" option to each major city's Aetheryte:+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   -Where the Heart Is (Mist)- Lower La Noscea, Ahctkoen – X32,Y20
Line 39: Line 43:
   -Where the Heart Is (The Goblet) – Western Thanalan, Imme – X25,Y24   -Where the Heart Is (The Goblet) – Western Thanalan, Imme – X25,Y24
   -I Dream of Shirogane (Shirogane) - Kugane, Tsurubami – X12,Y10   -I Dream of Shirogane (Shirogane) - Kugane, Tsurubami – X12,Y10
 +  -Ascending to Empyreum (Empyreum) - Foundation, Gondelimbaud – X10,Y12
  
 They are trivial to complete. They are trivial to complete.
Line 46: Line 51:
 __**IMPORTANT**__ __**IMPORTANT**__
  
-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. But, if you want to burn gil like a madman because you don't want to miss a medium or large relocation opportunity, you can change the default interval to whatever you can bear. +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.
- +
-Be aware the the relocation feature can cause you to unintentionally spend a lot of gil if you aren't careful. Unlike Purchase transactions, Relocation transactions are guaranteed to succeed if you have the gil required to relocate. Use of Auto Buy in conjunction with Relocate will relocate to the first plot discovered during scanning. It's there for you to use as you wish; please make sure you understand the risks involved.+
  
 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. 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.
Line 76: Line 79:
 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. 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 plot to acquire it automatically. +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.)
  
-If you have *not* selected a relocation transactionall housing areas will be completely scanned before attempting to buyand the highest priority plot will be purchased (the priority scheme is described later.) +Travel Only: When checkedSquatter will attempt to travel to an available plotbut 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.
- +
-If you *have* selected a relocation transaction, Squatter will immediately relocate to the highest priority plot that meets your criteria (you have enough money and it is the size you've chosen).+
  
 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. 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.
Line 126: Line 127:
 Max Scan Delay (seconds):  The maximum amount to time to delay before teleporting to scan. Max Scan Delay (seconds):  The maximum amount to time to delay before teleporting to scan.
  
-Idle at Random Aetheryte:  When checked, Squatter 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. 
  
-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.)+Idle in Room:  Allows you to select an inn room or grand company barracks to enter when Squatter 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 acquisition, Squatter will always teleport your character out of the housing area to a random aetheryte. 
 + 
 +Idle in Random Room:  When checked, Squatter 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, Squatter 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 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 **
  
 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, 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.  
Line 160: Line 168:
 ==== 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 randomly chooses 1) which housing area will be the first one scanned, which acts as the anchor for determining when the Scan Idle Period begins, and 2) the direction the housing areas will be visited (forward or backward). When the scan wraps around to the first housing area, 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.  So you have some idea of where Squatter is in the scanning process, it color codes the current housing area being scanned (green) and the next housing area to be scanned (cyan); the enabled checkbox for the first housing area in the scan is green.+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 "enabledcheckbox 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 181: Line 189:
  
 Subdivision Only:   Squatter will only scan the Subdivision (30 plots) Subdivision Only:   Squatter 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.
  
 === Plot Type to Acquire Control === === Plot Type to Acquire Control ===
Line 267: Line 277:
 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.
  
-Keep in mind, priority really only comes into play when you are engaged in a purchase transaction. Only then does Squatter have a full view of everything that is available and can then select your highest priority purchase. Relocation transactions will still occur immediately, so in that case, the first targeted plot encountered will always be acquired. 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 Acquire Targets** is checked, since if it is not, Squatter 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 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.
Line 294: Line 304:
 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 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:
  
-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.+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. 
 + 
 +Speed Action Cutoff Distance (yalms): The distance above which Squatter 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, Squatter will attempt to use a mount whenever one is available and it is appropriate.
  
-Mount Cutoff Distance (yalms): The distance below which Squatter will use Speed Actions to move your character, and above which a mount will be used.+Mount Cutoff Distance (yalms): The distance above which Squatter 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, Squatter will randomly pick an available mount that you own to run to the placard. This overrides your Mount Selection.
- 
-This feature is only really useful when you are doing relocations.  Getting to that medium or large plot you've been drooling over for months ASAP is paramount. Getting to a plot first for a purchase isn't all that compelling since you'll be there for hours anyway. Be aware, if you enable the Minion speed enhancements, you can get there even faster.  Just don't go crazy. 
- 
 ===== Notifications Tab ===== ===== Notifications Tab =====
 {{:mistahmikey:squatter:notifications.png?400|}} {{:mistahmikey:squatter:notifications.png?400|}}
Line 377: Line 386:
 2. Squatter will always go after Available plots you click on first (this is true regardless of your Auto Buy state.) 2. Squatter will always go after Available plots you click on first (this is true regardless of your Auto Buy state.)
  
-3. If you are in the scan active phase, and you've specified a relocation transaction for a housing area, then Squatter will immediately attempt to acquire the first available targeted plot in that housing area it encounters (See the Targets Tab.)  If no targets match and you've not checked Only Acquire Targets, Squatter will immediately relocate to the first available plot it encounters.+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.
  
-**To repeat, while scanning, if a relocation transaction is enabled, Squatter will attempt to relocate to the FIRST acceptable plot it encounters.**  This may not be (and probably won't be) the highest priority plot in your targets list, nor the highest priority untargeted plot you could relocate to. Squatter can only provide that additional discrimination during the scan idle period, when it has a full view of all the plots that are available. +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.
- +
-4. If you are in the scan idle period, 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. +
- +
-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.+
  
 ====== Support ====== ====== Support ======
Line 391: Line 396:
 When you need support, please provide me, at a minimum, the following: When you need support, please provide me, at a minimum, the following:
  
-  - screen shot of your Minion Console Log when the problem occurs +  - 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 Squatter Scanner tab +  - A screen shot of your Material Girl main tab
- +
-If you post this information to the specified channel, **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. **
  
 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. 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.
squatter.1630737125.txt.gz · Last modified: 2021/09/04 06:32 by mistahmikey