This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
squatter [2021/05/03 13:11] – [What it does] mistahmikey | squatter [2022/11/01 03:08] – old revision restored (2022/10/26 19:14) mistahmikey | ||
---|---|---|---|
Line 2: | Line 2: | ||
{{:: | {{:: | ||
+ | |||
+ | <color #ed1c24> | ||
+ | Squatter no longer fully works as described in this wiki for the version 6.1 lottery system. Squatter will still scan for available plots in 6.1, and will travel to plots you specify for acquisition. As the lottery system becomes better understood, Squatter will be updated to provide other features that might be helpful to managing the lottery. | ||
+ | </ | ||
===== 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 must be eligible to buy or relocate to the type of plot you desire. |
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 " | + | To enable Squatter to scan for available plots, you must have completed all the following |
-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. | ||
- | ** Other addons you allow to run at the same time Squatter is running might cause Squatter to fail. | + | ** Other addons you allow to run at the same time Squatter is running might cause Squatter to fail. |
__**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. | + | 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. |
- | + | ||
- | Be aware the the relocation feature can cost 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 to yourself as a botter. | As with any botting activity that occurs in the open world, misuse of this addon might draw attention to yourself as a botter. | ||
Line 72: | Line 75: | ||
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 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. | 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 a plot to acquire it automatically. | + | Auto Buy: When checked, Squatter will attempt to travel to an available |
- | If you have *not* selected a relocation transaction, all housing areas will be completely scanned before attempting | + | Travel Only: When checked, Squatter |
- | 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. |
Reset: | Reset: | ||
Line 91: | Line 94: | ||
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. | 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. | ||
+ | |||
+ | Buy Success Emote: | ||
+ | |||
+ | Buy Failure Emote: | ||
__**NOTE**__ | __**NOTE**__ | ||
Line 114: | Line 121: | ||
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, Squatter will teleport you to a random attuned | + | Delay Between Scans: When checked, Squatter will delay before teleporting |
- | Serpentine Scan Enabled: When checked, Squatter will use serpentine ordering for traversing through the Housing Area Scan List. Serpentine ordering means Squatter will reverse direction after each scan cycle completes, eg, 1 2 3 4 4 3 2 1 1 2 3 4 .... If not checked, then circular ordering is used, eg, 1 2 3 4 1 2 3 4 ... | + | 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 Squatter idles your character. | ||
+ | |||
+ | If you select " | ||
+ | |||
+ | 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. | ||
+ | |||
+ | Idle at Random Aetheryte: | ||
+ | |||
+ | Idle at Random Aethernet: | ||
+ | |||
+ | Randomize Scan Start: | ||
+ | |||
+ | Serpentine Scan: When checked, Squatter will use serpentine ordering for traversing through the Housing Area Scan List. Serpentine ordering means Squatter will reverse direction after each scan cycle completes, eg, 1 2 3 4 4 3 2 1 1 2 3 4 .... If not checked, then circular ordering is used, eg, 1 2 3 4 1 2 3 4 ... | ||
+ | |||
+ | Block Trades: | ||
+ | |||
+ | Target Aetherytes: | ||
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 162: | ||
Sync Transaction Type: If checked, changes to the Transaction Type control will affect all housing area entries. | Sync Transaction Type: If checked, changes to the Transaction Type control will affect all housing area entries. | ||
- | Sync Plot Size: If checked, changes to the Plot Size Filter | + | Sync Plot Size: If checked, changes to the Plot Size Filter |
+ | |||
+ | Sync Grade: | ||
==== 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. | + | 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. |
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 148: | Line 178: | ||
=== 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 Squatter chooses to start the scan. |
=== Divisions to Scan Control === | === Divisions to Scan Control === | ||
Line 159: | Line 189: | ||
Subdivision Only: | Subdivision Only: | ||
+ | |||
+ | **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. | ||
=== Plot Type to Acquire Control === | === Plot Type to Acquire Control === | ||
Line 176: | Line 208: | ||
Relocate: Select this is you wish to relocate to the plot. (Cannot be changed when Plot Status is Buying or Relocating) | Relocate: Select this is you wish to relocate to the plot. (Cannot be changed when Plot Status is Buying or Relocating) | ||
- | === Plot Size Filter | + | === Plot Size Filter |
+ | |||
+ | (S)mall, (M)edium, and (L)arge: | ||
+ | |||
+ | === Grade Filter Controls | ||
- | (S)mall, (M)edium, and (L)arge: Check the ones you wish to have Squatter check for availability. Note: only available plots with the size you select will be shown in the Discovered Plots List. | + | 1 through 5: Check the ones you wish to have Squatter check for availability. Note: only available plots with the grade(s) |
Line 241: | Line 277: | ||
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' | ||
Line 268: | 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. | 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. | ||
- | Enable Speed Actions: | + | Enable Speed Actions: |
+ | |||
+ | Speed Action Cutoff Distance (yalms): The distance above which Squatter 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 ===== | ||
{{: | {{: | ||
Line 332: | Line 367: | ||
Enable Log file: When checked, Squatter will create a unique log file for your session. This only needs to be checked if you are told to do so by Squatter support. | Enable Log file: When checked, Squatter will create a unique log file for your session. This only needs to be checked if you are told to do so by Squatter support. | ||
+ | |||
+ | Enable Timestamp: | ||
Debug Message Level Settings: | Debug Message Level Settings: | ||
Line 349: | 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 | + | 3. When you are in the scan idle period (the delay between scan attempts), then Squatter will attempt to acquire the highest priority |
- | **To repeat, while scanning, if a relocation transaction is enabled, Squatter will attempt to relocate to the FIRST acceptable plot it encounters.** | + | 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 ====== | ||
For support or requests, please contact me on discord: https:// | For support or requests, please contact me on discord: https:// | ||
+ | |||
+ | When you need support, please provide me, at a minimum, the following: | ||
+ | |||
+ | - 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 | ||
+ | |||
+ | If you post this information to the specified channel (NOT RECOMMENDED), | ||
+ | Additionally, | ||
+ | |||
+ | 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. |