====== Squatter Lottery Helper (SLH) ======

{{::mistahmikey:squatter:squatter.png?400|}}

===== What it does =====

Scans selected residential areas for available plots, and at your discretion, visits them and records how many lottery participants there are.  You can use SLH in any world to which you have access.  It's features include:
  * 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 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 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, 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.
  * Optionally creates CSVs when the Scan Cycle Idle period is entered that 1) record available plot information, including lottery participation status and counts, after those plots have been visited or 2) record plot information for every scanned plot.
===== What it does not do =====

It currently does not have any features to automatically enter you into the lottery for a desired plot or to automatically claim a won plot.  Depending on customer feedback, it might be possible to add such features in a future version.

It does not check your eligibility to actually acquire an available plot - it is strictly a data gathering tool at this point.

When using SLH in a world other than your home world, information normally displayed about the current lottery phase, your free company association, and your current plot ownership, is unavailable.
===== Requirements =====

You must also download MistahMikeysLib from the store.  It's free, of course.

Currently, SLH supports English, French, Japanese, Chinese. and Korean.

You must ensure FFXIV, Minion, and SLH are always updated to their latest versions.

You must be attuned to all the major city aetherytes (Limsa Lominsa Lower Decks, New Gridania, Ul'dah - Steps of Nald, Kugane, and Foundation).

To enable SLH to scan for available plots, you must have completed all the following unlock quests, which adds the "Residential District Aethernet" option to each major city's Aetheryte:

  -Where the Heart Is (Mist)- Lower La Noscea, Ahctkoen – X32,Y20
  -Where the Heart Is (Lavender Beds) – Central Shroud, Margeria – X21,Y22
  -Where the Heart Is (The Goblet) – Western Thanalan, Imme – X25,Y24
  -I Dream of Shirogane (Shirogane) - Kugane, Tsurubami – X12,Y10
  -Ascending to Empyreum (Empyreum) - Foundation, Gondelimbaud – X10,Y12

They are trivial to complete.

** Other addons you allow to run at the same time SLH is running might cause it to fail.  Please ensure that no FFXIVMinon tasks are running, Assist in particular, or things will not go well.** 

__**IMPORTANT**__

SLH will teleport to each major city's aetheryte to scan its associated residential district for available plots. THIS COSTS GIL.  SLH does attempt to minimize the need to use aetheryte teleports when you can visit multiple plots within an individual housing area ward, keeping you withing the ward until all available plots are visited.  If you use the targets feature (see the Target Tab section), SLH will preprocess the list you create to consolidate targeted plots within individual wards.  You can also keep the amount of gil spent scanning reasonable by specifying a large delay between successive scans of the 5 residential districts, so the gil burn is minimal. Given that the lottery entry period is several days long, you only need to scan as often as you desire to have up to date lottery participant totals.

===== Squatter Lottery Helper Update =====

Existing users of the original Squatter addon can purchase SLH for a reduced price.  Select the Squatter Lottery Helper Update addon from the Minion store to take advantage of this special offer.

====== UI ======

You start SLH via the FFXIVMinion menu drop down. It's under the "Mistah Mikey's Addons" menu item.  Clicking "Squatter Lottery Helper" should pop up its UI window.  The UI consists of different input areas called tabs.  The first line of the SLH main window is a list of all the available tabs.  To select a desired tab, click on it.
Each tab is described below.

__**GENERAL UI USAGE NOTE**__

When entering a value into a field control, when you begin to enter the text, the text will appear dimmed as a visual cue you are in the process of modifying the current value of the field.  The field value is not entered until you hit either the RETURN key or the TAB key, at which time the value might be checked, resulting in a popup if an error is detected. After dismissing an error popup, you should be returned to the field control to correct the error. If you navigate away from a field control by focusing other controls (say, by clicking in a different field control) before entering the value, the current value will be redisplayed and the value you were in the process of entering will be lost.

In the SLH control descriptions, if the control label has a asterisk appended, it means that value is saved in your profile (see the Profile Tab.)

Finally, for the Discovered Plots list, some of the columns are sortable. For sortable columns, the column headers provide buttons that allow you to sort the list according to values in that column: “^” sorts in the ascending direction (lowest to highest values), while “v” sorts in the descending direction (highest to lowest values).
===== Scanner Tab =====
{{:mistahmikey:squatter:scan.png?400|}}

This tab generally controls scanning for available plots and the plot visiting process. 
The two lines below the tab selection line show your Available Gil and the current Housing Lottery Status.

==== Character's Free Company and Plot Associations ====

This area of the tab provides information about your Free Company membership and current plot associations. The information is automatically updated whenever SLH is loaded or reset.  However, because SLH must interact with FFXIV controls (dialogs) to accumulate this information, it can sometimes fail for a variety of reasons that are beyond SLH's control.  If you see that the information does not reflect your reality, or if you change those associations during the game, you can hit the "Refresh" button and SLH will attempt to gather the information again.  If SLH is consistently unable to gather this information, it likely means some other addon you have installed is interfering with SLH's ability to operate the required controls.  Please report all such issues on the SLH discord channel (see the support section at the end of this wiki.)

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. You don't have to use SLH to travel to your plots - you can travel to them however you please. Once at the plot, make sure SLH is still enabled, enter your house, and you will see the current time recorded in the Last Visit Date column.  SLH will automatically tell you how many days it's been since that visit date in the Days Since Visit column. The last visit date is saved across logins - BUT - SLH also will delete this information if it determines you no longer own the plot.  This might occur accidentally if, for whatever reason, SLH is unable to accurately determine your plot ownership, which can occur from time to time.  If that happens, simply repeat this procedure for the plots that have NEVER as their Last Visit Date to start the ball rolling again.  


The controls on this tab are described below.

==== Enable, Auto Visit, Travel Only, Create CSV, Reset, and Discord Controls ====

| Enable | When checked, enables SLH to run.  If you disable, SLH execution is paused; reenabling will continue execution from the point you disabled. |
| 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, 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 Visited Plot CSV | When checked, SLH will create a CSV file containing information on all the available plots scanned during a scan cycle that were visited, including their lottery participant status and counts. As long as this option is checked, during the scan idle period a new CSV file will be created as auto-visit or marked plots are visited.  **This CSV file will be created only if plots are visited during the Scan Cycle Idle period.** If you use auto-visit, then one file is created for all plots auto-visited. For marked plots, a file is created for each plot visited. The files exist in //<Minion Installation Directory>/Bots/FFXIVMinion64/LuaMods/Squatter Lottery Helper/CSVData/<your character name>// - the file names are //scanned_plots(<game language>)_<time stamp>_<random nummber>.txt//. Use the data as you please. |
| Create Scanned Plot CSV | When checked, SLH will create a CSV file containing information on all plots scanned during a scan cycle that were visited. As long as this option is checked, when you start a new scan cycle, a new CSV file will be created.  This file will be incrementally built as plots are scanned.  The files exist in //<Minion Installation Directory>/Bots/FFXIVMinion64/LuaMods/Squatter Lottery Helper/CSVData/<your character name>// - the file names are //visited_plots(<game language>)_<time stamp>_<random nummber>.txt//. Use the data as you please. |
| Reset | Resets all settings to their default initial values. You can use this to abort a visit if you can catch it in time. If you have a current profile set, and Load Current Profile After Reset (Profile Tab) is enabled, then your saved profile values will be loaded.  The Reset button will disappear while the reset is in progress, and will reappear when it completes. |
| Discord Icon | Takes you to the SLH Discord channel if you need support.  Be advised I am in the Eastern Time zone (UTC-05:00). |


==== Scan Cycle Teleport Controls ====

Because teleporting costs gil, you have a couple of ways you can control how often SLH will cycle through your selected aetherytes to scan for available plots. After you have completed scanning all selected aetherytes, these controls allow you to specify how long you will idle before beginning to scan the aetherytes again (the scan idle period.)

| Scan Hourly | Determines how scanning resumes when you are in the scan idle period.  If not checked, you will resume scanning Scan Cycle Interval minutes from when you scanned the first selected housing area.  If checked, you will resume scanning Hourly Scan Cycle Delay seconds after each clock hour, local time. Whenever you change this setting, a rescan of all the selected aetherytes immediately occurs, with the next scan occurring in accordance with the new setting.  **Important**: Make sure you sync your clock if you want your hourly scan to be reasonably precise! |
| Scan Cycle Interval (minutes) | The number of minutes SLH will delay between successive scans for available plots. It is 240 minutes by default (since plot status is not likely to change very quickly), but you can set this to whatever you like - just be aware it should be set high enough to allow all plot visits to complete, which can take 30-60 seconds each. The base time to compute the deadline for starting the next scan cycle is the time the first selected aetheryte is scanned. So, for example, if it takes 2 minutes to scan all the aetherytes, and you've set Scan Cycle Interval to 5 minutes, scanning will resume in 3 minutes.  You will see this control only when Scan Hourly is not checked. |
| Hourly Scan Cycle Delay (seconds) | The number of seconds after each clock hour SLH will resume scanning.  You will only see this control only when Scan Hourly is checked. |
| Scan Idle Period Remaining (minutes) | When you are in the Scan Idle Period, this will count down the number of minutes remaining until the next scan cycle is started. |
| Scan Now | When you in the scan idle period, clicking this will immediately resume scanning.  You will only see this control during the scan idle period. |
| Scan Idle Postponement Period (minutes) | The number of minutes SLH will delay before entering the Scan Idle Period.  Setting this value > 0 will cause SLH to continue to scan for the number of minutes specified before it enters the Scan Idle Period. This is most useful when Scan Hourly is checked, because plots typically do not come available precisely on the hour, and may actually show up a few minutes after the hour. |
|Scan Idle Postponement Period Remaining (minutes) | The number of minutes remaining in the Scan Idle Postponement Period.  You will only see this control when the Scan Idle Postponement Period is active. |
| Delay Between Scans | When checked, SLH will delay before teleporting to the next aetheryte to scan.  The time delayed is randomly selected from the interval [Min Scan Delay, Max Scan Delay]. This will cause SLH to linger on the Select Residential Ward control before closing it to teleport.  If you use this when Target Aetherytes is checked, the current aetheryte will remain targeted until you teleport. |
| Min Scan Delay (seconds) | The minimum 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 in Room | Allows you to select an inn room or grand company barracks to enter when SLH 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 visit, SLH will always teleport your character out of the housing area to a random aetheryte. |
| 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.  If you do not have at least two rooms, this control will not be shown. |
| Idle at Random Aetheryte | When checked, SLH will teleport you to a random attuned aetheryte that is not one of the 4 major cities during the scan cycle idle period.   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, SLH will teleport you to a random aethernet that is in one of the 4 major residential areas during the scan cycle idle period.  **This only appears if you have don't have access to any inn rooms or grand company barracks ** |
| Randomize Scan Start | When checked, SLH 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. |
| Serpentine Scan | When checked, SLH will use serpentine ordering for traversing through the Housing Area Scan List.  Serpentine ordering means SLH 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 | When checked, when any other player tries to trade with you, SLH will immediately cancel the trade.  You are able to initiate trades without them being canceled. |
| Change Position During Idle | When checked, this is cause your character to periodically move to random positions around the Aetheryte.  The time between moves is randomly generated from the Base Loiter Duration. |
| Base Loiter Duration (minutes) | The time between moves is generated randomly in the interval [.5*Base Loiter Duration,1.5*Base Loiter Duration]. This value is limited to be between 2 and 10 minutes. |
| Minutes until Next Change | This control counts down the time until the next move will occur. |

==== Housing Area Scan Criteria Synchronization Controls ====

These controls affect how changes to the controls in the housing areas comprising the Housing Area Scan List (described next) work. If they are checked, then changes to the corresponding housing area control will be made to ALL housing area entries.  If they are not checked, the changes only apply to the corresponding housing area control.

| Sync Divisions To Scan | If checked, changes to the Divisions to Scan 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 Plot Size | If checked, changes to the Plot Size Filter controls will affect all housing area entries. |
| Sync Grade | If checked, changes to the Grade Filter controls will affect all housing area entries. |

==== Housing Area Scan List ====

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 visit 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.  SLH 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, SLH enters the Scan Idle Period (delay until SLH will resume scanning), and when it resumes scanning, if serpentine scanning is enabled, it will go in the opposite direction. By default, SLH chooses the leftmost entry to start the scan and the forward direction.  If you check "Randomize Scan Start", SLH will randomly chooses the first entry to scan and direction. So you have some idea of where SLH is in the scanning process, it color codes the current entry being scanned (green) and the next entry to be scanned (cyan); the "enabled" checkbox 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:

=== Housing Area Control ===

Drop down that allows you to set the housing area for its list entry.  You can set these however you like to create whatever visitation order you desire.  Be aware, SLH does not enforce any rules on how you do this - you can set them all to the same housing area if you like, and SLH will visit the same aetheryte 4 times.  It's completely up to you.

=== 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 SLH chooses to start the scan.

=== Divisions to Scan Control ===

Drop down that allows you to select one of the following:

| Both Divisions | SLH will scan both the Main Division and the Subdivision (60 plots) |
| Main Division Only | SLH will only scan the Main Division (30 plots) |
| Subdivision Only | SLH will only scan the Subdivision (30 plots) |

**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.  SLH 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 Visit Control ===

Drop down that allows you to select one of the following:

| Private Only | Select this if you wish to visit only Private plots. (Cannot be changed when Plot Status is Visiting) |
| Free Company Only | Select this if you wish to only visit Free Company plots. (Cannot be changed when Plot Status is Visiting) |
| Both Plot Types | Select this if you wish to visit both Private and Free Company plots. (Cannot be changed when Plot Status is Visiting) |


=== Plot Size Filter Controls ===

(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. 

=== Grade Filter Controls ===

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. 


==== Discovered Plots List ====

A scrollable list of plots discovered during scanning. When using auto-visit, plots with the "Available" status are visited in the order they appear in this list.  Certain column headers provide buttons that allow you to sort the list according to values in that column: "^" sorts in the ascending direction (lowest to highest values), while "v" sorts in the descending direction (highest to lowest values).  Note that sorting the list will change the order in which available plots are visited.  So, for example, if you wanted to visit plots according to their plot size, largest to smallest, you would use the "v" button to sort the list in the descending direction.

Each line contains the following information:

| Status                | Visiting | You are in the process of attempting to visit the plot |
|                       | Visited  | You have visited this plot at least once |
|                       | Available | The plot can be acquired |
|                       | Aborted | Visiting the plot was manually terminated |
|                       | Purchased | You acquired a previously available plot |
|                       | Sold | Someone else acquired a plot that was previously available |
|                       | Owned  | You or your Free Company owns the plot |
|                       | Shared | You are sharing a Private plot with another owner |
| Housing Area          | Town where plot is located |  |
| Plot Type             | Type of plot: P (Private) or FC (Free Company) | |
| Ward Number           | Ward in which plot is located | |
| Plot Number           | The plot being targeted | |
| Size                  | S (small), M (medium), L (large)  | |
| 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 "desirability" (1 being the most expensive and desirable) | |
| Owner                 | The name of the person or Free Company that owns the plot OR  | |
| Price                 | Gil required to acquire plot | |
| Visit Time            | Local time when last visited the plot | |
| Hours Since Visit     | Time that has elapsed since Visit Time | |
| Lottery Participants  | Total number of players who have entered the lottery to acquire that plot. An asterisk means the plot is not yet available for sale | |
| Accepting Entries Until | If the lottery is currently in the entry phase, this will show the date deadline for entering the current lottery | |
| Results Period End  | If the lottery is in the results phase, this will show the date by which a winner must accept their win  | |

Clicking on an Available or Visited plot will mark that plot to be visited during the next Scan Cycle Idle period. 

Clicking on Aborted plots changes their status back to Available.

Clicking on Sold plots will remove them from the list.

Clicking on anything other plot status value does nothing.

The list is sorted by Plot status, in the following order:  Visiting, Purchased, Available, Visited, Aborted, Sold, Owned.  The secondary sorts fields are Housing Area, Ward Number, and Plot Number. 

===== Targets Tab =====
{{:mistahmikey:squatter:targets.png?400|}}

The Targets Tab allows you to prioritize what plots SLH tries to visit. 

| Enable Targets | When checked, enables target prioritization; you are prohibited from checking this if you haven't entered some targets for SLH to consider. When unchecked, SLH will try to visit any plot that becomes available. |
| Only Visit Targets | When checked, SLH will ONLY try to visit your targeted plots; if other plots become available, they will be ignored.  When unchecked, if SLH does not find a targeted plot, it will try to visit untargeted plots as well. |

You enter a target plot using the **Priority**, **Housing Area**, **Ward No**, and **Plot No** fields, then add it to the target list using the **Add** button. The **Priority** value is a number (can be float) that is used to order the target list. Larger priority values indicate higher priority.  If you want to change the priority of an existing target, simply enter its housing area, ward number and plot number along with the new priority value and click **Add**.

The **Ward No** and **Plot No** can be set to zero to act as a wildcard in the plot targeting.  So, if you want to target any plot in ward 17, you would enter a plot number of zero.  Likewise, if you want to target plot 10 in any ward, you would enter a ward number of zero.  If both ward number and plot number are zero, SLH will target all plots in all wards within that **Housing Area** - you can use this to prioritize the housing areas within which SLH will attempt to visit plots.

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.

Also, this feature is intended for use when **Auto Visit** 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.

When you visit plots, SLH will preprocess your target list to consolidate plots within individual wards to minimize the need to teleport out to an aethertye to change the ward you are in.

All of the settings on this tab can be saved in your profile.  So if you want different target lists, you can create different profiles to hold them.

===== Movement Tab =====
{{:mistahmikey:squatter:movement.png?400|}}

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.  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, SLH 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 SLH will use Speed Actions to move your character. |
| Enable Mount | When checked, SLH will attempt to use a mount whenever one is available and it is appropriate. |
| Mount Cutoff Distance (yalms) | The distance above which SLH 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. If you pick one it turns out you cannot use (because you don't own it or you are in a zone where mounts aren't allowed), a popup will appear informing you of the situation. |
| Select Random Mount | When checked, SLH will randomly pick an available mount that you own to run to the placard. This overrides your Mount Selection. |
===== Notifications Tab =====
{{:mistahmikey:squatter:notifications.png?400|}}

The Notification Tab allows you tell SLH to send an email to a desired recipient email account using a desired sender email account.  The events for which SLH sends a email are:  Available plots are discovered during scanning, a plot visit is initiated (either via Auto Visit or clicking on a desired available plot), you win the plot, or someone else wins the plot.  Note: these notifications do not occur when Test Mode or Demo Mode is selected, but you can send a test notification if you wish. The controls on this tab are:

| Notifications Enabled | When checked, enables notifications to be sent. |
| To Email Address | The email address to which notifications will be sent. |
| From Email Address | The email address from which notifications will be sent. |
| Email User Account | The user account name on the email system used to send notifications. |
| Email User Account Password | The user account password of the Email User Account. |
| Smtps Mail Server Url | The Url of the mail server being used to send emails.  The default is for gmail, but you can use others if desired. |
| Send Test Notification | Clicking this will send a test notification email according to your entries above. |
| Notification Sent | The total number of notifications sent during this SLH session. |
| Last Notification Send Error | The output of the command used to send the email if there is an error to help you identify the problem.  "No Error" means the command sent the email without experiencing any immediate error. |



===== Profile Tab =====
{{:mistahmikey:squatter:profile.png?400|}}

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 | When checked, if you hit Reset on the Scanner Tab, or when SLH is loaded when you start Minion, after all settings are initialized to their default values, the saved settings in your current profile are loaded. |
| 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. |
| Save | Save all settings to the current profile. |
| Add New Profile | The name of a new profile you wish to add (must be a valid file name). |
| Add | Create the new profile and save all current settings to it. |

The table is a list of all the profiles you have created for the current character and game language.  Using the "Selection" column, you can select specific profiles for the operations Delete or Make Current.  Obviously, only one profile at a time can be made current, so you can only select one for that operation, but you can select as many as you like for the Delete operation.  You can select/deselect all profiles by using the checkbox in the operation row. ** Be aware that profile values are only saved when you explicitly request them to be saved via the Save button. **


===== Debug Tab =====

{{:mistahmikey:squatter:debug.png?400|}}

This tab is primarily intended for use in conjunction with consultation with SLH support.  It enables various test scenarios and debugging information that are used to help diagnose issues that might occur during SLH's operation.  The controls on this tab are:

| Enable Log file | When checked, SLH will create a unique log file for your session. This only needs to be checked if you are told to do so by SLH support. |
| Enable Timestamp | When checked, SLH will include the current tick count in the debug messages. This provides information that facilitates debugging timing issues. |
| Debug Message Level Settings | SLH's debug message system implements a simple filtering mechanism that can be used to allow or inhibit certain message classes, generally in increasing order of verbosity.  The default settings are fairly "quiet", but SLH support may ask you to enable more verbose settings to gather diagnostic information for investigating issues. |
| 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 the actual placard spamming, as the placard must be in the "For Sale" state for that behavior to be available. |
| Test Mode | When checked, SLH will mark every placard in the first ward of each selected housing area as "Available".  Used in conjunction with "Auto Visit" enabled, it allows verification that there are no floor mesh issues preventing navigation to the placards. Without "Auto Visit" enabled, you can click on specific problem children and subsequently use the Navigation addon to remesh where needed. |
====== Support ======

For support or requests, please contact me on discord: https://discord.gg/J67ybRCRqt.  I will respond as soon as I am able, generally within 24 hours at most.

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.  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 Material Girl main tab

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. SLH is 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.