This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
squatter [2021/05/09 13:29] – mistahmikey | squatter [2022/11/01 02:48] – [What it does] mistahmikey | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | ====== Squatter |
{{:: | {{:: | ||
Line 5: | Line 5: | ||
===== What it does ===== | ===== What it does ===== | ||
- | Scans all residential areas for available plots, and at your discretion, | + | Scans selected |
- | * 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. | + | * 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 specify what kind of plot to buy: Private Individual, or Free Company. | + | * Allows you to target specific plots by ward and plot number |
- | * Allows you to specify what kind of buying transaction you desire: Purchase | + | * Allows you to specify what kind of plot to visit: Private, Free Company, |
- | * Allows you to specify what size plot you'd like to buy: 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, | + | * 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, Fists of Wind) and mounts in residential areas to get you to the placard as quickly as possible. | ||
- | + | | |
- | You can use Squatter several different ways: | + | |
- | | + | |
- | * 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 ===== | ===== What it does not do ===== | ||
- | Guarantee | + | It currently does not have any features to automatically enter you into the lottery for a desired |
+ | It does not check your eligibility to actually acquire an available plot - it is strictly a data gathering tool at this point. | ||
===== Requirements ===== | ===== Requirements ===== | ||
You must also download MistahMikeysLib from the store. | You must also download MistahMikeysLib from the store. | ||
- | Currently, | + | Currently, |
- | You must ensure FFXIV, Minion, and Squatter | + | You must ensure FFXIV, Minion, and SLH are always updated to their latest versions. |
- | You must be eligible to buy or relocate | + | You must be attuned |
- | 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 |
- | + | ||
- | To enable | + | |
-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 34: | ||
-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. | ||
- | ** Other addons you allow to run at the same time Squatter | + | ** 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**__ | ||
- | Squatter | + | 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, |
- | + | ||
- | Be aware the the relocation feature can cause you to unintentionally spend a lot of gil if you aren't careful. Unlike Purchase transactions, | + | |
- | + | ||
- | As with any botting activity that occurs in the open world, misuse of this addon might draw attention | + | |
====== UI ====== | ====== UI ====== | ||
- | You start Squatter | + | You start SLH via the FFXIVMinion menu drop down. It's under the " |
+ | Each tab is described below. | ||
===== Scanner Tab ===== | ===== Scanner Tab ===== | ||
{{: | {{: | ||
- | This tab generally controls scanning for available plots and the buying | + | This tab generally controls scanning for available plots and the plot visiting |
+ | The two lines below the tab selection line show your Available Gil and the current Housing Lottery Status. | ||
==== Character' | ==== Character' | ||
- | 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 " | + | This area of the tab provides information about your Free Company membership and current plot associations. The information is automatically |
- | When Squatter | + | When SLH is in it's Scan Cycle Idle Period (waiting to begin it's next scan of the aetherytes), |
- | If you would like Squatter | + | 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 |
The controls on this tab are described below. | The controls on this tab are described below. | ||
- | ==== Enable, Auto Buy, Reset, and Discord Controls ==== | + | ==== Enable, Auto Visit, Travel Only, Create CSV, Reset, and Discord Controls ==== |
- | Enable: When checked, enables | + | Enable: When checked, enables |
- | Auto Buy: When checked, | + | Auto Visit: When checked, |
- | If you have *not* selected a relocation transaction, all housing areas will be completely scanned before attempting | + | Travel Only: When checked, SLH will attempt |
- | If you *have* selected a relocation transaction, Squatter | + | 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. |
- | Create CSV: | + | Reset: |
- | Reset: | + | Discord Icon: |
- | Discord Icon: Takes you to the Squatter Discord channel if you need support. | ||
- | |||
- | ==== Transaction Completion Action Controls ==== | ||
- | |||
- | Shutdown Game After Buy Success: | ||
- | |||
- | 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. | ||
- | |||
- | __**NOTE**__ | ||
- | |||
- | If you use minion to autolaunch the game, be aware it will automatically log you back in after being shutdown. Minion doesn' | ||
==== Scan Cycle Teleport Controls ==== | ==== Scan Cycle Teleport Controls ==== | ||
- | Because teleporting costs gil, you have a couple of ways you can control how often Squatter | + | 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.) |
Scan Hourly: Determines how scanning resumes when you are in the scan idle period. | Scan Hourly: Determines how scanning resumes when you are in the scan idle period. | ||
- | Scan Cycle Interval (minutes): The number of minutes | + | Scan Cycle Interval (minutes): The number of minutes |
- | Hourly Scan Cycle Delay (seconds): The number of seconds after each clock hour Squatter | + | Hourly Scan Cycle Delay (seconds): The number of seconds after each clock hour SLH will resume scanning. |
Scan Idle Period Remaining (minutes): | Scan Idle Period Remaining (minutes): | ||
Line 112: | Line 95: | ||
Scan Now: When you in the scan idle period, clicking this will immediately resume scanning. | Scan Now: When you in the scan idle period, clicking this will immediately resume scanning. | ||
- | Scan Idle Postponement Period (minutes): The number of minutes | + | Scan Idle Postponement Period (minutes): The number of minutes |
Scan Idle Postponement Period Remaining (minutes): The number of minutes remaining in the Scan Idle Postponement Period. | Scan Idle Postponement Period Remaining (minutes): The number of minutes remaining in the Scan Idle Postponement Period. | ||
- | Idle at Random Aetheryte: When checked, | + | Delay Between Scans: When checked, |
- | Serpentine Scan Enabled: When checked, | + | Min Scan Delay (seconds): |
+ | |||
+ | Max Scan Delay (seconds): | ||
+ | |||
+ | |||
+ | Idle in Room: Allows you to select an inn room or grand company barracks to enter when SLH idles your character. | ||
+ | |||
+ | If you select " | ||
+ | |||
+ | 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. | ||
+ | |||
+ | Idle at Random Aetheryte: | ||
+ | |||
+ | Idle at Random Aethernet: | ||
+ | |||
+ | Randomize Scan Start: | ||
+ | |||
+ | Serpentine Scan: When checked, | ||
+ | |||
+ | Block Trades: | ||
Change Position During Idle: When checked, this is cause your character to periodically move to random positions around the Aetheryte. | Change Position During Idle: When checked, this is cause your character to periodically move to random positions around the Aetheryte. | ||
Line 134: | Line 136: | ||
Sync Plot Type: If checked, changes to the Plot Type control will affect all housing area entries. | Sync Plot Type: If checked, changes to the Plot Type control will affect all housing area entries. | ||
- | Sync Transaction Type: | + | Sync Plot Size: If checked, changes to the Plot Size Filter controls |
- | Sync Plot Size: If checked, changes to the Plot Size Filter | + | Sync Grade: If checked, changes to the Grade Filter |
==== Housing Area Scan List ==== | ==== Housing Area Scan List ==== | ||
- | The housing area scan list controls how Squatter | + | 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. |
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 146: | Line 148: | ||
=== Housing Area Control === | === Housing Area Control === | ||
- | Drop down that allows you to set the housing area for its list entry. | + | Drop down that allows you to set the housing area for its list entry. |
=== Enable Housing Area Control === | === Enable Housing Area Control === | ||
- | If checked, the housing area list entry will be included in the scan. | + | If checked, the housing area list entry will be included in the scan. The checkbox will be green for housing area SLH chooses to start the scan. |
=== Divisions to Scan Control === | === Divisions to Scan Control === | ||
Line 156: | Line 158: | ||
Drop down that allows you to select one of the following: | Drop down that allows you to select one of the following: | ||
- | Both Divisions: | + | Both Divisions: |
- | Main Division Only: Squatter | + | Main Division Only: SLH will only scan the Main Division (30 plots) |
- | Subdivision Only: Squatter | + | Subdivision Only: SLH will only scan the Subdivision (30 plots) |
- | === Plot Type to Acquire | + | **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. |
+ | |||
+ | === 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: | + | Private |
- | Free Company: Select this if you wish to acquire a Free Company | + | Free Company |
- | === Plot Transaction | + | 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) | + | === Plot Size Filter Controls === |
- | Relocate: Select this is you wish to relocate to the plot. (Cannot be changed when Plot Status is Buying or Relocating) | + | (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. |
- | === Plot Size Filter | + | === Grade Filter |
- | (S)mall, (M)edium, and (L)arge: Check the ones you wish to have Squatter | + | 1 through 5: Check the ones you wish to have SLH check for availability. Note: only available plots with the grade(s) |
Line 187: | 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 | + | | Status |
- | | | Relocating | + | | | Visited |
- | | | Purchased | + | | | Available |
- | | | Relocated | + | | | Aborted |
- | | | Available | + | | | Purchased | You acquired a previously available plot | |
- | | | Available- | + | | | Sold | Someone else acquired |
- | | | Aborted | + | |
- | | | Sold | Someone else bought | + | |
| | Owned | You or your Free Company owns the plot | | | | Owned | You or your Free Company owns the plot | | ||
| | Shared | | | Shared | ||
| 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 Number | ||
| Plot Number | | Plot Number | ||
Line 203: | 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 " | | 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 " | ||
| 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 buy plot | | |
- | | Discovery | + | | Visit Time | Local time when last visited |
- | | Hours Since Discovery | + | | Hours Since Visit | Time that has elapsed since Visit Time |
- | | Hours At Placard | + | | Lottery Participants |
- | Clicking on an Available plot when another plot is not currently being acquired | + | Clicking on an Available |
- | + | ||
- | 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 222: | 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: | + | The list is sorted by Plot status, in the following order: |
- | + | ||
- | __**NOTE**__ | + | |
- | + | ||
- | If a plot you are visiting is purchased or relocated by someone else, or you are successful purchasing or relocating to it, you will be automatically teleported out of the housing area. If Idle at Random Aetheryte is not checked, you will be sent to the next aetheryte in the scan rotation; otherwise, Squatter will send you to a random attuned aetheryte. | + | |
===== Targets Tab ===== | ===== Targets Tab ===== | ||
{{: | {{: | ||
- | The Targets Tab allows you to prioritize what plots Squatter | + | The Targets Tab allows you to prioritize what plots SLH tries to visit. |
- | Enable Targets: when checked, enables target prioritization; | + | Enable Targets: when checked, enables target prioritization; |
- | Only Acquire | + | Only Visit Targets: when checked, |
You enter a target plot using the **Priority**, | You enter a target plot using the **Priority**, | ||
- | The **Ward No** and **Plot No** can be set to zero to act as a wildcard in the plot targeting. | + | The **Ward No** and **Plot No** can be set to zero to act as a wildcard in the plot targeting. |
You can delete plots from the target list by checking them in the **Selection** column and clicking the **Delete** button. | You can delete plots from the target list by checking them in the **Selection** column and clicking the **Delete** button. | ||
- | 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, | + | For relocations, |
Also, this feature is intended for use when **Auto Buy** is checked on the **Scan Tab** - otherwise, it really doesn' | Also, this feature is intended for use when **Auto Buy** is checked on the **Scan Tab** - otherwise, it really doesn' | ||
All of the settings on this tab can be saved in your profile. | All of the settings on this tab can be saved in your profile. | ||
- | |||
- | ===== Timing Tab ===== | ||
- | {{: | ||
- | |||
- | The Timing Tab is provided to help tune Squatter' | ||
- | |||
- | At the top of the tab is a pull down, Set Game FPS, that can be used to modify the FFXIV in-game FPS settings that are available on the System control. Just like that control, you can set the FPS to unlimited, 30, 15, or 7. This is most useful when you are running multiple instances of the FFXIV client on the same computer. You can use the setting to reduce the graphics processing load on certain clients to, say, improve performance on another client you are using to spam placards. | ||
- | |||
- | Below the Set Game FPS pulldown is a table that contains timing parameters that are critical to Squatter' | ||
- | |||
- | Each of these entities requires communication with the FFXIV server and is therefore affected by your network' | ||
- | |||
- | To give you an idea of how well your timing parameters are working, performance statistics are provided: | ||
- | |||
- | A timing issue associated with the Plot Placard control can result in your character slightly moving as the placard is targeted. For the final plot purchase request to be accepted by the server, the placard must be specifically targeted by your character. | ||
- | |||
===== Movement Tab ===== | ===== Movement Tab ===== | ||
{{: | {{: | ||
- | The Movement Tab allows you to control what kind of movement speed Squatter | + | 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. |
+ | |||
+ | Enable Speed Actions: | ||
- | Enable | + | Speed Action Cutoff Distance (yalms): The distance above which SLH will use Speed Actions to move your character. |
- | Enable Mount: | + | Enable Mount: |
- | Mount Cutoff Distance (yalms): The distance | + | Mount Cutoff Distance (yalms): The distance |
Mount Selection: | Mount Selection: | ||
- | Select Random Mount: | + | Select Random Mount: |
- | + | ||
- | This feature is only really useful when you are doing relocations. | + | |
===== Notifications Tab ===== | ===== Notifications Tab ===== | ||
{{: | {{: | ||
- | The Notification Tab allows you tell Squatter | + | The Notification Tab allows you tell SLH to send an email to a desired recipient email account using a desired sender email account. |
Notifications Enabled: When checked, enables notifications to be sent. | Notifications Enabled: When checked, enables notifications to be sent. | ||
Line 301: | Line 276: | ||
Send Test Notification: | Send Test Notification: | ||
- | Notification Sent: The total number of notifications sent during this squatter | + | Notification Sent: The total number of notifications sent during this SLH session. |
Last Notification Send Error: | Last Notification Send Error: | ||
Line 310: | Line 285: | ||
{{: | {{: | ||
- | The Profile Tab allows you to persistently store most of Squatter's settings. The profile settings are stored in files unique to the character and game language used to create the profile. You can create as many profiles as you like. The controls on this tab are: | + | The Profile Tab allows you to persistently store most of SLH's settings. The profile settings are stored in files unique to the character and game language used to create the profile. You can create as many profiles as you like. The controls on this tab are: |
- | Load Current Profile After Reset: | + | Load Current Profile After Reset: |
- | Current Profile Name: The settings file you selected to be the current profile being used by Squatter. | + | Current Profile Name: The settings file you selected to be the current profile being used by SLH. |
Load: Load all settings from the current profile. | Load: Load all settings from the current profile. | ||
Line 331: | Line 306: | ||
{{: | {{: | ||
- | This tab is primarily intended for use in conjunction with consultation with Squatter | + | This tab is primarily intended for use in conjunction with consultation with SLH support. |
- | Enable Log file: When checked, | + | Enable Log file: When checked, |
- | Debug Message Level Settings: | + | Enable Timestamp: |
- | Demo Mode: When checked, Squatter will simulate randomly available plots and available gil so you can see how it generally works. | + | Debug Message Level Settings: |
- | Test Mode: When checked, | + | Demo Mode: When checked, |
- | Ignore Eligibility: When checked, | + | Test Mode: When checked, |
+ | ====== Support ====== | ||
- | ====== Plot Acquisition Priority Scheme | + | For support or requests, please contact me on discord: https:// |
- | Because there are a number of ways to acquire a plot using Auto Buy, a priority scheme is implemented. | + | When you need support, please provide me, at a minimum, the following: |
- | 1. Squatter will only attempt | + | - Enable the debug information category on the Debug Tab and do what you did to create the problem. |
+ | - A screen shot of your Material Girl main tab | ||
- | 2. Squatter will always go after Available plots you click on first (this is true regardless of your Auto Buy state.) | + | If you post this information to the specified |
- | + | Additionally, **you should not use an account | |
- | 3. If you are in the scan active phase, and you' | + | |
- | + | ||
- | **To repeat, while scanning, if a relocation transaction is enabled, Squatter will attempt to relocate to the FIRST acceptable plot it encounters.** | + | |
- | + | ||
- | 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 | + | |
- | + | ||
- | 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 ====== | + | |
- | For support or requests, please contact | + | If that initial information is insufficient for me to determine the cause, I will ask you to set other debug settings that will provide more information. SLH has been very stable after many months of use, but it is also a very complex piece of software, and can be negatively affected by a number of factors over which I have no control, not the least of which is what other addons you run. I appreciate your patience in working with me to solve your issue when it is not slam-dunk easy. As long as you are willing to try the debugging measures |