Skip to content

Latest commit

 

History

History
214 lines (169 loc) · 12.3 KB

README.md

File metadata and controls

214 lines (169 loc) · 12.3 KB
Raw

FFXIV Ember Overlay

React overlay for the OverlayPlugin and ACTWebSocket plugins for Advanced Combat Tracker for use with Final Fantasy XIV.

GitHub GitHub package.json version GitHub last commit (branch) Works with OverlayPlugin Works with ACTWebSocket Discord GitHub package.json dynamic

Funding

Donate at StreamElements Donate at Ko-fi Become a Patron

Usage with OverlayPlugin

Set your OverlayPlugin URL to https://goldenchrysus.github.io/ffxiv/ember-overlay/

Usage with ACTWebSocket with OverlayProc

Add a new skin URL to https://goldenchrysus.github.io/ffxiv/ember-overlay/ and create a new overlay window from this skin.

Discord

Join the Discord server to receive live updates, report bugs, or request features at: https://discord.io/emberoverlay

Features

Informative tabs for damage, healing, tanking, and raiding.

DPS tab Healing tab Tanking tab Raid tab

Click on any player's name to view detailed statistics.

Detailed statistics

Customize your experience.

Customizable overlay

Collapsible interface to save space and show only your stats.

Collapsible interface

Minimize the entire overlay to the left or right when not in use to free up screen space.

Minimize when not in use

Easily see the recent changes since your last visit

About and changelog

Clear encounter data or load sample data to perfect your setup.

Clear encounter and load sample data

Installation

Note: OverlayProc cannot be used when FFXIV is in full screen mode. If you wish to remain in full screen mode, you must use OverlayPlugin.

To use this overlay skin, you need Advanced Combat Tracker and either OverlayPlugin or ACTWebSocket with OverlayProc. To determine which one to choose (OverlayPlugin vs ACTWebSocket), consider the following:

OverlayPlugin

✔️ Easy to set up.
✔️ Can be used in full screen mode.
✔️ Add the overlay to your OBS Studio scene or other stream/video feed where Web pages can be embedded.
❌ Limited configuration.
❌ Displays "YOU" instead of your character name in the player list.
❌ Outdated embedded browser.

ACTWebSocket with OverlayProc

✔️ More configuration options (opacity, scale, more flexible auto-hide/-show, etc.).
✔️ Display your character name instead of "YOU" in the player list.
✔️ View the overlay in a regular browser or on your phone (when connected to the same network as your PC).
✔️ Add the overlay to your OBS Studio scene or other stream/video feed where Web pages can be embedded.
✔️ More recent embedded browser.
❌ More difficult to set up.
❌ Cannot be used in full screen mode.
❌ No substantial benefit if not using it in one of the aforementioned ways.

OverlayPlugin

  1. If you already have Advanced Combat Tracker (ACT) and OverlayPlugin setup and configured to your liking, skip to step 3.
    • OverlayPlugin version 0.3.4.0 is required. The overlay will not work in earlier versions.
  2. Ensure ACT and OverlayPlugin are installed and working by following these instructions.
  3. Within ACT, navigate to Plugins > OverlayPlugin.dll > Mini Parse.
  4. Set the URL to https://goldenchrysus.github.io/ffxiv/ember-overlay/
  5. Click "Reload overlay," and the overlay should now be visible in your FFXIV game.

ACTWebSocket

  1. If you already have Advanced Combat Tracker (ACT), ACTWebSocket, and OverlayProc setup and configured to your liking, skip to step 15.
    • ACTWebSocket version 1.3.3.9 is required. Images may not display correctly in earlier versions.
  2. Ensure ACT is installed and working by following these instructions.
  3. Within ACT, navigate to Plugins > Plugin Listing.
  4. Delete the "FFXIV_ACT_Plugin.dll" entry by clicking the "X" in the top right of the entry.
  5. Download ACTWebSocket and OverlayProc from here.
  6. Before unzipping the previous file, ensure it is unblocked by right-clicking the file, choosing "Properties," and clicking "Unblock" at the bottom of the "General" tab.
    • If the unblock option is not available at this stage, repeat this process for the ACTWebSocket.dll file after extracting in the next step.
  7. Extract the ZIP file to the location of your choosing.
  8. Within ACT, navigate to Plugins > Plugin Listing > Browse, and choose the ACTWebSocket.dll file from the extracted ZIP file.
  9. Navigate to Options > Show Startup Wizard, and follow the same process you used in step 1 to setup ACT. This will add the FFXIV_ACT_Plugin.dll that was removed in step 3.
  10. Navigate to Plugins > ACTWebSocket, and use the following configuration under "Start Options":
    • Server Auto Start: checked
    • Use UPNP: unchecked
    • Use SSL: unchecked
    • random URL: unchecked
    • Skin Dir on Act/OverlaySkin: checked
    • Use MobileProc Discovery: unchecked
    • Update Plugin Address: checked
  11. Use the following configuration under "Host":
    • Host: either the top-most option or "127.0.0.1"
    • Port: 10501
    • UPNP Port: 10501
  12. Use the following configuration under "Message Filter":
    • Use Miniparse Data: checked
    • Using OnLogLineRead: unchecked
    • Using BeforeLogLineRead: unchecked
    • Using Chat: unchecked
  13. Under "Server Status," click "On."
  14. In the middle of the screen, ensure you are on the tab entitled "HTML Based."
  15. Use the following configuration under "OverlayProc":
    • OverlayProc Auto Start: checked
    • In the dropdown (the only dropdown in this section), choose "x64_QT5.8.0" if on a 64-bit system or "x86_QT5.8.0" if on a 32-bit system.
    • If the textbox to the right of the dropdown has text beginning with "0.0.0" then click "Download."
  16. In the section entitled "Web Skins," click "Add URL."
  17. Enter https://goldenchrysus.github.io/ffxiv/ember-overlay/ and click "Ok."
  18. In the section entitled "OverlayProc," click "Start/Stop OverlayProc."
  19. Click "Open Manager."
  20. In the section entitled "Overlay List," select "Ember Overlay" and click "New." It should then appear in the section entitled "Overlay Windows" and should be visible in your FFXIV game.

Changelog

View the full changelog here.

Staging Site

You can access and test features in advance by using the staging site. Instead of the regular URL, set your overlay to https://goldenchrysus.github.io/ffxiv/ember-overlay-dev/

Please note that the staging site is for pre-release testing, so you may encounter errors. Please report these errors as GitHub issues or in the #bug-reports channel on the Discord.

When viewing the changelog, you will be able to determine which changes are available on the staging site because they will be prefixed with "!" in the changelog for the latest development version.

Credits

Translations

  • Bona - Portuguese translation
  • ShadyWhite - Chinese translation
  • Gusma - Portuguese translation
  • The_X - Portuguese translation
  • okuRaku - Twitter, Twitch - Japanese translation
  • Astriel - German translation

Donors

  • Amneamnius
  • Vulasuw

Misc.

Building

To build this yourself, do the following:

  1. Clone the repository using git, e.g. git clone https://github.com/GoldenChrysus/ffxiv-ember-overlay.git

  2. Run npm install to install the Node packages.

  3. Make a file .env-cmdrc and provide environment variables as necessary, using .env-cmdrc.sample as a guide.

  4. To launch the server immediately:

    1. Run npm start to start the React app on your machine on port 3000.
    2. Navigate to your.server.host:3000 to view the app.

  5. To build the app for usage on a Web server:

    1. Run one of the following build commands depending on your environment:
      • npm run build:development to build the development environment.
      • npm run build:staging to build the staging environment.
      • npm run build to build the production environment.
    2. Copy the contents of /build to the desired path on your Web server.
    3. Navigate to your.server.host/path/to/app to view the app.

Contributing

Process

  1. Create a fork.
  2. Make your changes and follow the coding guidelines.
  3. Commit with meaningful messages that describe your changes.
  4. Create a pull request.
  5. Ensure your pull request describes the nature and purpose of your changes.

Coding Guidelines

This list is not exhaustive and generally applies to formatting. Your merge request may be rejected for other reasons including but not limited to: formatting issues not specified here, architectural concerns, or functionality concerns.

  • Indentation must use tabs.
  • Variable assignment equal signs should be aligned using spaces.
  • Use let for all variable declarations unless unreasonable (e.g. var for scoping reasons or const for constants).
  • Variable comparisons should use ===.
  • Variable names should be descriptive and not misspelled.
  • Variable names should be snake_case.
  • Function names should be camelCase.
  • Class names should be PascalCase.
  • String quotation should be done with double-quotes, not single-quotes, except in cases of interpolation where backticks would be used.
  • Trailing whitespace should be stripped.
  • Do not refactor surrounding code unless necessary for your change.
  • return statements should be as early or late in a function as possible; avoid return statements in the middle of a function.
  • Opening curly braces ({) for classes, functions, and control blocks should be on the same line as the block, e.g. if (some_var === true) {.
  • Use arrow functions unless needing to inherit the class or function context.
  • Ensure the final version of your code is free of debug code.

License

GNU General Public License v3.0 only

Copyright

Copyright (C) 2019, Patrick Golden. All rights reserved.

Copyrights licensed under GNU General Public License v3.0 only.

See the accompanying LICENSE file for terms.