setup guide draft

FFXIV-ACT · Feb 12, 2020 · 5f9fce5 · 5f9fce5
commit 5f9fce5
Show file tree

Hide file tree

Showing 27 changed files with 132 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,132 @@
+# FFXIV ACT Setup Guide
+
+This guide is intended to get a FFXIV player setup with ACT and an overlay for parsing purposes and be able to upload logs to the FFLogs website.
+
+*Last updated: 2/11/2020*
+
+<img align="right" src="act_logo.png" alt="act_logo" height="100" vspace="25">
+
+## Contents
+- [Installing ACT](#installing-act)
+- [Configuring ACT](#configuring-act)
+  - [Running as Admin](#running-as-admin)
+  - [Adding Firewall Exception](#adding-firewall-exception)
+- [FFXIV ACT Plugin](#ffxiv-act-plugin)
+- [OverlayPlugin](#overlayplugin)
+  - [Preset Overlays](#preset-overlays)
+  - [Custom Overlays](#custom-overlays)
+- [Adding an Overlay](#adding-an-overlay)
+- [FFLogs Uploader](#fflogs-uploader)
+
+## Installing ACT
+
+Navigate to the [ACT website](https://advancedcombattracker.com/), click on the **Download** page tab, then click on the `Advanced Combat Tracker - Setup` link to download the ACT installation program.
+
+![act_download](resources/act_download.png)
+
+Find the `ACTv3-Setup` executable in your downloads and run it to begin the installation (If you get a User Account Control prompt, click yes).
+
+![actv3_setup](resources/actv3_setup.png)
+
+The setup program will ask you for the installation location and start menu folder (You can leave the default options). Click **Install** then **Close** to complete the installation.
+
+![act_installation](resources/act_installation.png)
+
+## Configuring ACT
+
+### Running as Admin
+It is recommended that ACT be run as Admin. You can right click on the ACT shortcut and select the **Run as administrator** option. You may get an UAC prompt, select yes.
+
+![runas_admin](resources/runas_admin.png)
+
+You can also configure ACT to always run as admin by right clicking on the shortcut then selecting **Properties**. In the **Properties** window, select the **Compatibility** tab, then check the **Run this program as an administrator** option. Click **Apply** to save the changes. This will ensure ACT is always run as admin.
+
+![always_runas_admin](resources/always_runas_admin.png)
+
+### Adding Firewall Exception
+Open the windows **Control Panel** (you can search for control panel in the taskbar search bar). Select the **System and Security** category and under **Windows Defender Firewall** click on **Allow an app through Windows Firewall**. 
+
+![control_panel](resources/control_panel.png)
+
+Inside the allowed apps window, click on **Change settings** button, then on the **Allow another app...** button. This will open up a dialog window to select an app.
+
+![allowed_apps](resources/allowed_apps.png)
+
+Click on the **Browse...** button and navigate to the ACT install folder. The default location should be in `C:\Program Files (x86)\Advanced Combat Tracker`.
+
+![add_an_app](resources/add_an_app.png)
+
+In the ACT folder, select the `Advanced Combat Tracker` application and click on **Open**.
+
+![select_act](resources/select_act.png)
+
+Back in the dialog window, click on **Add** to add ACT to the windows firewall exceptions.
+
+![add_act](resources/add_act.png)
+
+`Advanced Combat Tracker` should now appear in the list of **Allowed apps and features**. Click **OK** and exit the Control Panel.
+
+![allowed_apps_act](resources/allowed_apps_act.png)
+
+## FFXIV ACT Plugin
+
+Upon first running ACT, it will prompt you with the Startup Wizard. If you forget to download a parsing plugin, ACT will prompt you again the next time you run it, or you can manually open the wizard by going to **Options** > **Miscellaneous** > **Show Startup Wizard**.
+
+![startup_wizard](resources/startup_wizard.png)
+
+In the **Parsing Plugin** section of the startup wizard, ensure `FFXIV Parsing Plugin` is selected from the dropdown, then click the `Download/Enable Plugin` button. You will receive an alert when the plugin has been added to ACT. Click **Ok** to dismiss it.
+
+![parsing_plugin](resources/parsing_plugin.png)
+
+Click **Next** to move to the log file section. ACT will ask if it will be used for Final Fantasy XIV. Select **Yes** to configure ACT logs for FFXIV.
+
+![log_file](resources/log_file.png)
+
+Click **Next** to move to Startup Settings, then **Close** to accept the default settings and finish the startup wizard.
+
+At this point `FFXIV_ACT_Plugin.dll` should be enabled in **Plugins** > **Plugin Listing**.
+
+![ffxiv_act_plugin](resources/ffxiv_act_plugin.png)
+
+## OverlayPlugin
+
+From the **Plugin Listing** tab, click on the `Get Plugins...` button near the upper right corner. This will open a window that will populate with available plugins for ACT.
+
+![get_plugins](resources/get_plugins.png)
+
+In the **Get Plugins** window, select the `[FFXIV+others]Overlay Plugin` option and click on `Download and Enable`. This will add the latest ngld **OverlayPlugin** to ACT (the OverlayPlugin auto-updater may also run during this step).
+
+![get_plugins_window](resources/get_plugins_window.png)
+
+The OverlayPlugin should now be setup. Click on the `X` to close the **Get Plugins** window.
+
+## Adding an Overlay
+
+### Preset Overlays
+
+Ngld's OverlayPlugin comes with built-in presets for a majority of popular overlays. To setup an overlay go to **Plugins** > **OverlayPlugin.dll** and click on the `New` button. 
+
+![new_overlay](resources/new_overlay.png)
+
+This will open the **Create new overlay** dialog. Enter a **name** for the overlay and select a **preset** from the dropdown (the overlayplugin will show you a preview of each preset). Once you have selected your desired overlay, click on the **OK** button to add your overlay.
+
+![add_overlay](resources/add_overlay.png)
+
+Your overlay should now appear in the overlays list. Select it from the list to view and edit its settings. You can move your overlay to the desired position, then check the **Lock overlay** box to lock it in place.
+
+![overlay_settings](resources/overlay_settings.png)
+
+You can add additional overlays using the same steps. Certain plugins, e.g. cactbot plugin, will populate the preset dropdown with additional presets for their respective overlays.
+
+### Custom Overlays
+
+For an overlay not available in the presets, select the **Custom** option from the dropdown and the desired **Type**. For most overlays, it will be the **MiniParse** type.
+
+![custom_overlay](resources/custom_overlay.png)
+
+In the overlay settings, make sure to add the overlay **URL** source. It can be a web url or the path to a local html file.
+
+![overlay_url](resources/overlay_url.png)
+
+## FFLogs Uploader
+
diff --git a/resources/act_download.png b/resources/act_download.png
diff --git a/resources/act_installation.gif b/resources/act_installation.gif
diff --git a/resources/act_installation.png b/resources/act_installation.png
diff --git a/resources/act_logo.png b/resources/act_logo.png
diff --git a/resources/actv3_setup.png b/resources/actv3_setup.png
diff --git a/resources/add_act.png b/resources/add_act.png
diff --git a/resources/add_an_app.png b/resources/add_an_app.png
diff --git a/resources/add_overlay.png b/resources/add_overlay.png
diff --git a/resources/allowed_apps.png b/resources/allowed_apps.png
diff --git a/resources/allowed_apps_act.png b/resources/allowed_apps_act.png
diff --git a/resources/always_runas_admin.png b/resources/always_runas_admin.png
diff --git a/resources/control_panel.png b/resources/control_panel.png
diff --git a/resources/custom_overlay.png b/resources/custom_overlay.png
diff --git a/resources/fflogs_download.png b/resources/fflogs_download.png
diff --git a/resources/fflogs_installation.png b/resources/fflogs_installation.png
diff --git a/resources/ffxiv_act_plugin.png b/resources/ffxiv_act_plugin.png
diff --git a/resources/get_plugins.png b/resources/get_plugins.png
diff --git a/resources/get_plugins_window.png b/resources/get_plugins_window.png
diff --git a/resources/log_file.png b/resources/log_file.png
diff --git a/resources/new_overlay.png b/resources/new_overlay.png
diff --git a/resources/overlay_settings.png b/resources/overlay_settings.png
diff --git a/resources/overlay_url.png b/resources/overlay_url.png
diff --git a/resources/parsing_plugin.png b/resources/parsing_plugin.png
diff --git a/resources/runas_admin.png b/resources/runas_admin.png
diff --git a/resources/select_act.png b/resources/select_act.png
diff --git a/resources/startup_wizard.png b/resources/startup_wizard.png