This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
squatter [2022/11/01 02:14] – [Transaction Completion Action Controls] mistahmikey | squatter [2022/11/01 02:50] – [UI] mistahmikey | ||
---|---|---|---|
Line 6: | Line 6: | ||
Scans selected residential areas for available plots, and at your discretion, visits them and records how many lottery participants there are. | Scans selected residential areas for available plots, and at your discretion, visits them and records how many lottery participants there are. | ||
- | * Has both an auto and manual mode. In auto mode, it will visit all available plots upon completion of a scan cycle. | + | * Has both an auto and manual mode. In auto mode, it will visit all available plots upon completion of a scan cycle. |
* Allows you to target specific plots by ward and plot number to visit. | * Allows you to target specific plots by ward and plot number to visit. | ||
* Allows you to specify what kind of plot to visit: Private, Free Company, or both. | * Allows you to specify what kind of plot to visit: Private, Free Company, or both. | ||
Line 46: | Line 46: | ||
====== UI ====== | ====== UI ====== | ||
- | You start SLH via the FFXIVMinion menu drop down. It's under the " | + | You start SLH via the FFXIVMinion menu drop down. It's under the " |
Each tab is described below. | Each tab is described below. | ||
Line 72: | Line 72: | ||
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. | 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. | ||
- | 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 | + | 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, SLH 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. |
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: 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. | ||
Line 83: | Line 83: | ||
==== 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 95: | 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. | ||
- | Delay Between Scans: | + | Delay Between Scans: |
Min Scan Delay (seconds): | Min Scan Delay (seconds): | ||
Line 106: | Line 106: | ||
- | Idle in Room: Allows you to select an inn room or grand company barracks to enter when Squatter | + | Idle in Room: Allows you to select an inn room or grand company barracks to enter when SLH idles your character. |
- | If you select " | + | If you select " |
- | Idle in Random Room: When checked, | + | Idle in Random Room: When checked, |
- | Idle at Random Aetheryte: | + | Idle at Random Aetheryte: |
- | Idle at Random Aethernet: | + | Idle at Random Aethernet: |
- | Randomize Scan Start: | + | Randomize Scan Start: |
- | Serpentine Scan: When checked, | + | Serpentine Scan: When checked, |
- | Block Trades: | + | 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 137: | Line 135: | ||
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: 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 controls will affect all housing area entries. | Sync Plot Size: If checked, changes to the Plot Size Filter controls will affect all housing area entries. | ||
Line 146: | Line 142: | ||
==== 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. By default, the visitation order is serpentine. |
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 152: | 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. The checkbox will be green for housing area Squatter | + | 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 162: | 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) |
- | **Note** When Squatter | + | **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 Acquire | + | === 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) | ||
- | |||
- | Relocate: Select this is you wish to relocate to the plot. (Cannot be changed when Plot Status is Buying or Relocating) | ||
=== Plot Size Filter Controls === | === Plot Size Filter Controls === | ||
- | (S)mall, (M)edium, and (L)arge: | + | (S)mall, (M)edium, and (L)arge: |
=== Grade Filter Controls === | === Grade Filter Controls === | ||
- | 1 through 5: 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) you select will be shown in the Discovered Plots List. |
Line 199: | 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 215: | 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 234: | 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. | ||
- | For relocations, | + | 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 Actions: |
- | Speed Action Cutoff Distance (yalms): The distance above which Squatter | + | 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 above which Squatter | + | Mount Cutoff Distance (yalms): The distance above which SLH will use a mount to move your character. |
Mount Selection: | Mount Selection: | ||
- | Select Random Mount: | + | Select Random Mount: |
===== 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 312: | 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 321: | 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 342: | 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, 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: | + | |
- | + | ||
- | Demo Mode: When checked, Squatter will simulate randomly available plots and available gil so you can see how it generally works. | + | |
- | + | ||
- | Test Mode: When checked, Squatter will mark every placard in the first ward of each selected housing area as " | + | |
- | + | ||
- | Ignore Eligibility: | + | |
- | + | ||
- | ====== Plot Acquisition Priority Scheme For Auto Buy ====== | + | |
- | + | ||
- | Because there are a number of ways to acquire a plot using Auto Buy, a priority scheme is implemented. | + | |
- | 1. Squatter will only attempt to acquire plots that meet your top-level selection criteria: checked | + | Enable Log file: |
- | 2. Squatter | + | Enable Timestamp: |
- | 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 | + | Debug Message Level Settings: |
- | 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 | + | Demo Mode: When checked, SLH will simulate randomly available plots and available gil so you can see how it generally works. Of course, it can't simulate |
+ | Test Mode: When checked, SLH will mark every placard in the first ward of each selected housing area as " | ||
====== 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: | When you need support, please provide me, at a minimum, the following: | ||
Line 380: | Line 329: | ||
Additionally, | 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. | + | 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. |