Repository: GoldenChrysus/ffxiv-ember-overlay Branch: bleeding-edge Commit: 9fbc86c7301f Files: 234 Total size: 1.8 MB Directory structure: gitextract_r56vcy8c/ ├── .commitlintrc.json ├── .env-cmdrc.sample ├── .eslintrc.json ├── .github/ │ ├── FUNDING.yml │ ├── ISSUE_TEMPLATE/ │ │ ├── bug_report.md │ │ └── feature_request.md │ └── workflows/ │ ├── autodeploy.yml │ ├── code-lint.yml │ └── commit-lint.yml ├── .gitignore ├── .husky/ │ ├── commit-msg │ └── pre-commit ├── ACT_INSTALLATION.md ├── CHANGELOG.md ├── LICENSE ├── README.md ├── craco.config.js ├── package.json ├── public/ │ ├── data/ │ │ └── streamers.txt │ ├── index.html │ ├── logs/ │ │ └── .gitignore │ └── manifest.json ├── scripts/ │ ├── effects.py │ ├── instances.py │ ├── jobs.py │ ├── local/ │ │ ├── effects.py │ │ ├── instances.py │ │ ├── ogcd-skills.py │ │ ├── pvp-zones.py │ │ └── skill-indirections.py │ ├── ogcd-skills.py │ ├── pvp-zones.py │ ├── skill-indirections.py │ └── traits.py └── src/ ├── components/ │ ├── EmberComponent.js │ ├── Parser/ │ │ ├── AggroTable/ │ │ │ └── Monster.js │ │ ├── AggroTable.js │ │ ├── Container/ │ │ │ ├── DiscordMenu.js │ │ │ ├── EncounterMenu.js │ │ │ ├── IconButton.js │ │ │ ├── Import.js │ │ │ └── Menu.js │ │ ├── Container.js │ │ ├── Footer.js │ │ ├── GameState.js │ │ ├── Header.js │ │ ├── PercentBar.js │ │ ├── Placeholder/ │ │ │ └── Toggle.js │ │ ├── Placeholder.js │ │ ├── PlayerDetail/ │ │ │ └── HistoryChart.js │ │ ├── PlayerDetail.js │ │ ├── PlayerTable/ │ │ │ ├── OverlayInfo.js │ │ │ └── Player.js │ │ ├── PlayerTable.js │ │ ├── SpellGrid/ │ │ │ └── Spell.js │ │ └── SpellGrid.js │ ├── Parser.js │ ├── Settings/ │ │ ├── About/ │ │ │ └── SocialLink.js │ │ ├── About.js │ │ ├── Donate.js │ │ ├── Export.js │ │ ├── Screen/ │ │ │ ├── Inputs/ │ │ │ │ ├── Slider.js │ │ │ │ ├── Table/ │ │ │ │ │ ├── MetricNameTable.js │ │ │ │ │ ├── SpellsUITable.js │ │ │ │ │ └── TTSRulesTable.js │ │ │ │ └── Table.js │ │ │ └── Section.js │ │ ├── Screen.js │ │ └── Streamers.js │ └── Settings.js ├── constants/ │ ├── Locales.js │ ├── Migrations.js │ ├── PVPZoneData.js │ ├── SampleAggroData.js │ ├── SampleGameData.js │ ├── SampleHistoryData.js │ ├── SettingsSchema.js │ ├── SkillData.js │ ├── ZoneData.js │ └── index.js ├── data/ │ ├── Settings.js │ ├── game/ │ │ ├── buff-jobs.json │ │ ├── debuff-jobs.json │ │ ├── dot-jobs.json │ │ ├── effects.json │ │ ├── instances.json │ │ ├── jobs.json │ │ ├── ogcd-skills.json │ │ ├── pvp-zones.json │ │ └── skill-indirections.json │ └── locales/ │ ├── monster-metrics.json │ ├── overlay.json │ ├── player-metrics.json │ └── settings.json ├── helpers/ │ ├── GameHelper.js │ ├── StringHelper.js │ └── UUIDHelper.js ├── index.css ├── index.js ├── migrations/ │ ├── 01-convert-binary-short-name-setting.js │ ├── 02-store-settings-in-overlayplugin.js │ ├── 03-convert-light-theme.js │ ├── 04-convert-spell-layout.js │ ├── 05-copy-spell-tts.js │ ├── 06-change-critical-hp-setting-key.js │ └── 07-convert-auto-hide-to-options.js ├── processors/ │ ├── GameDataProcessor.js │ ├── MessageProcessor.js │ ├── MonsterProcessor.js │ └── PlayerProcessor.js ├── redux/ │ ├── actions/ │ │ └── index.js │ ├── reducers/ │ │ └── index.js │ └── store/ │ └── index.js ├── semantic-ui/ │ ├── site/ │ │ ├── collections/ │ │ │ ├── breadcrumb.overrides │ │ │ ├── breadcrumb.variables │ │ │ ├── form.overrides │ │ │ ├── form.variables │ │ │ ├── grid.overrides │ │ │ ├── grid.variables │ │ │ ├── menu.overrides │ │ │ ├── menu.variables │ │ │ ├── message.overrides │ │ │ ├── message.variables │ │ │ ├── table.overrides │ │ │ └── table.variables │ │ ├── elements/ │ │ │ ├── button.overrides │ │ │ ├── button.variables │ │ │ ├── container.overrides │ │ │ ├── container.variables │ │ │ ├── divider.overrides │ │ │ ├── divider.variables │ │ │ ├── flag.overrides │ │ │ ├── flag.variables │ │ │ ├── header.overrides │ │ │ ├── header.variables │ │ │ ├── icon.overrides │ │ │ ├── icon.variables │ │ │ ├── image.overrides │ │ │ ├── image.variables │ │ │ ├── input.overrides │ │ │ ├── input.variables │ │ │ ├── label.overrides │ │ │ ├── label.variables │ │ │ ├── list.overrides │ │ │ ├── list.variables │ │ │ ├── loader.overrides │ │ │ ├── loader.variables │ │ │ ├── rail.overrides │ │ │ ├── rail.variables │ │ │ ├── reveal.overrides │ │ │ ├── reveal.variables │ │ │ ├── segment.overrides │ │ │ ├── segment.variables │ │ │ ├── step.overrides │ │ │ └── step.variables │ │ ├── globals/ │ │ │ ├── reset.overrides │ │ │ ├── reset.variables │ │ │ ├── site.overrides │ │ │ └── site.variables │ │ ├── modules/ │ │ │ ├── accordion.overrides │ │ │ ├── accordion.variables │ │ │ ├── chatroom.overrides │ │ │ ├── chatroom.variables │ │ │ ├── checkbox.overrides │ │ │ ├── checkbox.variables │ │ │ ├── dimmer.overrides │ │ │ ├── dimmer.variables │ │ │ ├── dropdown.overrides │ │ │ ├── dropdown.variables │ │ │ ├── embed.overrides │ │ │ ├── embed.variables │ │ │ ├── modal.overrides │ │ │ ├── modal.variables │ │ │ ├── nag.overrides │ │ │ ├── nag.variables │ │ │ ├── popup.overrides │ │ │ ├── popup.variables │ │ │ ├── progress.overrides │ │ │ ├── progress.variables │ │ │ ├── rating.overrides │ │ │ ├── rating.variables │ │ │ ├── search.overrides │ │ │ ├── search.variables │ │ │ ├── shape.overrides │ │ │ ├── shape.variables │ │ │ ├── sidebar.overrides │ │ │ ├── sidebar.variables │ │ │ ├── sticky.overrides │ │ │ ├── sticky.variables │ │ │ ├── tab.overrides │ │ │ ├── tab.variables │ │ │ ├── transition.overrides │ │ │ └── transition.variables │ │ └── views/ │ │ ├── ad.overrides │ │ ├── ad.variables │ │ ├── card.overrides │ │ ├── card.variables │ │ ├── comment.overrides │ │ ├── comment.variables │ │ ├── feed.overrides │ │ ├── feed.variables │ │ ├── item.overrides │ │ ├── item.variables │ │ ├── statistic.overrides │ │ └── statistic.variables │ └── theme.config ├── services/ │ ├── AnimateService.js │ ├── DiscordService.js │ ├── DonationService.js │ ├── LocalizationService.js │ ├── MigrationService.js │ ├── ObjectService.js │ ├── PluginService/ │ │ ├── OverlayPluginService.js │ │ ├── OverlayProcService.js │ │ ├── PluginServiceAbstract.js │ │ └── SocketService.js │ ├── PluginService.js │ ├── SettingsService.js │ ├── SpellService.js │ ├── TTSService.js │ ├── TabSyncService.js │ ├── ThemeService.js │ ├── TwitchAPIService.js │ ├── UsageService.js │ └── VersionService.js └── styles/ ├── components/ │ ├── parser/ │ │ ├── common/ │ │ │ └── parser.less │ │ └── parser-theme.less │ └── settings/ │ ├── common/ │ │ └── settings.less │ └── settings-theme.less ├── functions/ │ └── common.less └── themes/ └── variables/ ├── ffxiv-classic.less ├── ffxiv-clear-blue.less ├── ffxiv-dark.less └── ffxiv-light.less ================================================ FILE CONTENTS ================================================ ================================================ FILE: .commitlintrc.json ================================================ { "extends": [ "@commitlint/config-conventional" ] } ================================================ FILE: .env-cmdrc.sample ================================================ { "default": { "REACT_APP_ROUTER_BASE": "/path/to/app", "REACT_APP_HTTP_BASE": "/path/to/app", "REACT_APP_REDIRECT_URL": "http://domain.com", "REACT_APP_VERSION": "0.1.0", "REACT_APP_GITHUB_URL": "https://github.com/username/repository", "REACT_APP_DISCORD_URL": "https://discord.gg/invite", "REACT_APP_AUTHOR_URL": "https://yourwebsite.com", "REACT_APP_CHANGELOG_URL": "https://github.com/username/repository/blob/master/CHANGELOG.md", "REACT_APP_TWITCH_API_CLIENT_ID": "your_api_client_id", "REACT_APP_CASH_DONATE_LINK": "https://cash.app/$username", "REACT_APP_PAYPAL_DONATE_LINK": "https://paypal.me/username", "REACT_APP_STREAMLABS_DONATE_LINK": "https://streamlabsurl.com", "REACT_APP_KOFI_DONATE_LINK": "https://ko-fi.com/username", "REACT_APP_PATREON_DONATE_LINK": "https://www.patreon.com/username", "REACT_APP_PAYPAY_DONATE_LINK": "https://qr.paypay.ne.jp/paypay_code", "REACT_APP_PAYPAY_DONATE_ID": "your_paypay_id" }, "development": { "REACT_APP_PAGE_TITLE": "Development Environment", "REACT_APP_GOOGLE_TAG_MANAGER_ID": "GTM-ABCDEF3", "REACT_APP_ENV": "development" }, "staging": { "REACT_APP_PAGE_TITLE": "Staging Environment", "REACT_APP_GOOGLE_TAG_MANAGER_ID": "GTM-ABCDEF2", "REACT_APP_ENV": "staging" }, "production": { "REACT_APP_PAGE_TITLE": "Production Environment", "REACT_APP_GOOGLE_TAG_MANAGER_ID": "GTM-ABCDEF1", "REACT_APP_ENV": "production" }, "nonssl": { "REACT_APP_GOOGLE_TAG_MANAGER_ID": "GTM-ABCDEF4" } } ================================================ FILE: .eslintrc.json ================================================ { "env": { "browser": true, "es2021": true }, "extends": [ "plugin:react/recommended", "xo" ], "overrides": [ ], "parserOptions": { "ecmaVersion": "latest", "sourceType": "module" }, "plugins": [ "react", "align-assignments" ], "rules": { "camelcase": "off", "object-curly-spacing": ["error", "always"], "quotes": ["error", "double"], "key-spacing": [ "error", { "beforeColon": true, "align": { "beforeColon": true, "afterColon": true, "on": "colon" } } ], "no-multi-spaces": "off", "operator-linebreak": [ "error", "after", { "overrides": { "?": "before", ":": "before" } } ], "max-depth": ["warn", 6], "space-before-function-paren": [ "error", { "anonymous": "never", "named": "never", "asyncArrow": "always" } ], "align-assignments/align-assignments": [ "error", { "requiresOnly": false } ], "guard-for-in": "off", "prefer-destructuring": "off", "react/prop-types": "off", "no-negated-condition": "off", "max-params": "off", "new-cap": "off", "no-case-declarations": "off", "complexity": "off", "react/no-string-refs": "off", "no-return-assign": "off", "prefer-promise-reject-errors": "off" }, "settings": { "react": { "version": "detect" } } } ================================================ FILE: .github/FUNDING.yml ================================================ # These are supported funding model platforms github: GoldenChrysus custom: ['https://cash.app/$chrysus', 'https://chrysus.xyz/paypay', 'https://chrysus.live'] ko_fi: goldenchrysus patreon: Chrysus open_collective: # Replace with a single Open Collective username tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry liberapay: # Replace with a single Liberapay username issuehunt: # Replace with a single IssueHunt username otechie: # Replace with a single Otechie username ================================================ FILE: .github/ISSUE_TEMPLATE/bug_report.md ================================================ --- name: Bug report about: Create a report to help us improve title: '' labels: bug assignees: '' --- **Describe the bug** A clear and concise description of what the bug is. **Reproduction steps** Exact steps, both in Ember and within FFXIV, to reproduce the behavior: 1. Open '...' 2. Enable '...' 3. Cast '...' in game **Expected behavior** A clear and concise description of what you expected to happen. **Screenshots** If applicable, add screenshots to help explain the issue. **Settings data** Paste your settings data below. This can be found at ACT > Plugins > OverlayPlugin.dll > (select overlay) > Open DevTools > Application > IndexedDB > localforage > keyvaluepairs > (copy the entire value for `settings_cache`). Replace any sensitive information (such as a webhook URL) with the word "redacted". [paste settings data here] ================================================ FILE: .github/ISSUE_TEMPLATE/feature_request.md ================================================ --- name: Feature request about: Suggest an idea for this project title: '' labels: enhancement assignees: '' --- **Describe the feature you'd like** A clear and concise description of what you want to happen. **Is your feature request related to a problem? Please describe.** A clear and concise description of what the problem is. e.g. "I'm always frustrated when [...]" **Describe alternatives you've considered** A clear and concise description of any alternative solutions or features you've considered. **Additional context** Add any other context or screenshots about the feature request here. ================================================ FILE: .github/workflows/autodeploy.yml ================================================ name: Auto Deployer on: push: branches: [ staging, master ] workflow_dispatch: env: BUILD_NONSSL: ${{ secrets.BUILD_NONSSL }} BUILD_SSL: ${{ secrets.BUILD_SSL }} BUILD_TYPE: ${{ secrets.BUILD_TYPE }} DESTINATION_SUBDIR: ${{ secrets.DESTINATION_SUBDIR }} FTP_HOST: ${{ secrets.FTP_HOST }} FTP_PASS: ${{ secrets.FTP_PASS }} FTP_USER: ${{ secrets.FTP_USER }} GIT_DESTINATION_REPO: ${{ secrets.GIT_DESTINATION_REPO }} GIT_EMAIL: ${{ secrets.GIT_EMAIL }} GIT_ORIGIN_BRANCH: ${{ secrets.GIT_ORIGIN_BRANCH }} GIT_ORIGIN_REPO: ${{ secrets.GIT_ORIGIN_REPO }} GIT_TOKEN: ${{ secrets.GIT_TOKEN }} GIT_USER: ${{ secrets.GIT_USER }} REACT_APP_AUTHOR_URL: ${{ secrets.REACT_APP_AUTHOR_URL }} REACT_APP_CASH_DONATE_LINK: ${{ secrets.REACT_APP_CASH_DONATE_LINK }} REACT_APP_CHANGELOG_URL: ${{ secrets.REACT_APP_CHANGELOG_URL }} REACT_APP_DISCORD_URL: ${{ secrets.REACT_APP_DISCORD_URL }} REACT_APP_GITHUB_URL: ${{ secrets.REACT_APP_GITHUB_URL }} REACT_APP_GOOGLE_TAG_MANAGER_ID: ${{ secrets.REACT_APP_GOOGLE_TAG_MANAGER_ID }} REACT_APP_NONSSL_GOOGLE_TAG_MANAGER_ID: ${{ secrets.REACT_APP_NONSSL_GOOGLE_TAG_MANAGER_ID }} REACT_APP_HTTP_BASE: ${{ secrets.REACT_APP_HTTP_BASE }} REACT_APP_KOFI_DONATE_LINK: ${{ secrets.REACT_APP_KOFI_DONATE_LINK }} REACT_APP_PAGE_TITLE: ${{ secrets.REACT_APP_PAGE_TITLE }} REACT_APP_PATREON_DONATE_LINK: ${{ secrets.REACT_APP_PATREON_DONATE_LINK }} REACT_APP_PAYPAL_DONATE_LINK: ${{ secrets.REACT_APP_PAYPAL_DONATE_LINK }} REACT_APP_PAYPAY_DONATE_ID: ${{ secrets.REACT_APP_PAYPAY_DONATE_ID }} REACT_APP_PAYPAY_DONATE_LINK: ${{ secrets.REACT_APP_PAYPAY_DONATE_LINK }} REACT_APP_REDIRECT_URL: ${{ secrets.REACT_APP_REDIRECT_URL }} REACT_APP_STREAMLABS_DONATE_LINK: ${{ secrets.REACT_APP_STREAMLABS_DONATE_LINK }} REACT_APP_TWITCH_API_CLIENT_ID: ${{ secrets.REACT_APP_TWITCH_API_CLIENT_ID }} REACT_APP_VERSION: ${{ secrets.REACT_APP_VERSION }} jobs: build_staging: if: ${{ github.ref == 'refs/heads/staging' }} runs-on: ubuntu-latest environment: staging steps: - name: Push to hosted environments uses: GoldenChrysus/autobuilder@0.1.7 build_production: if: ${{ github.ref == 'refs/heads/master' }} runs-on: ubuntu-latest environment: production steps: - name: Push to hosted environments uses: GoldenChrysus/autobuilder@0.1.7 ================================================ FILE: .github/workflows/code-lint.yml ================================================ name: ESLint on: push: paths: - 'src/**' pull_request: paths: - 'src/**' workflow_dispatch: jobs: eslint: runs-on: ubuntu-latest strategy: matrix: node-version: [14.x] steps: - uses: actions/checkout@v3 - name: Use Node.js ${{ matrix.node-version }} uses: actions/setup-node@v3 with: node-version: ${{ matrix.node-version }} - name: Install dependencies run: npm install - name: Lint source run: npm run eslint ================================================ FILE: .github/workflows/commit-lint.yml ================================================ name: Commitlint on: [ push, pull_request ] jobs: commitlint: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 with: fetch-depth: 0 - uses: wagoid/commitlint-github-action@v5 with: configFile: '.commitlintrc.json' ================================================ FILE: .gitignore ================================================ # See https://help.github.com/articles/ignoring-files/ for more about ignoring files. # dependencies /node_modules /.pnp .pnp.js # testing /coverage # production /build # misc .DS_Store .env.local .env.development.local .env.test.local .env.production.local .env-cmdrc # logs npm-debug.log* yarn-debug.log* yarn-error.log* public/logs/* # lock files yarn.lock package-lock.json # developer junkyard /misc /scripts/local/data /scripts/local/test/**/*.* ================================================ FILE: .husky/commit-msg ================================================ #!/usr/bin/env sh . "$(dirname -- "$0")/_/husky.sh" npx --no -- commitlint --edit ================================================ FILE: .husky/pre-commit ================================================ #!/bin/bash ./node_modules/pre-commit/hook RESULT=$? [ $RESULT -ne 0 ] && exit 1 exit 0 ================================================ FILE: ACT_INSTALLATION.md ================================================ # ACT + OverlayPlugin Installation ## Navigation - Installing ACT - Configuring Windows Permissions - Run as Administrator - Add Firewall Exception - Installing OverlayPlugin - Using the Web Socket - Using in OBS - Running Multiple Modes in OBS ## Installing ACT 1. [Download ACT](https://advancedcombattracker.com/includes/page-download.php?id=56) and run through its installer. 2. Open ACT and follow along through the startup wizard. 3. On the "Parsing Plugin" tab, choose the "FFXIV Parsing Plugin" from the dropdown. Click "Download/Enable Plugin." You should receive a message that the plugin was added and started. ![](https://i.imgur.com/WWkZtAU.png) ![](https://i.imgur.com/d23Kvrm.png) 4. On the "Log File" tab, select "Yes" when asked if ACT will be used for Final Fantasy XIV. The log file should automatically be loaded after doing so. ![](https://i.imgur.com/CqudbIj.png) ![](https://i.imgur.com/xHMVJqX.png) 5. You don't need to make any changes to the "Startup Settings" tab, so you can click "Close" at the bottom of the window. ## Configuring Windows Permissions ACT should always be run as administrator and excepted from Windows Firewall to make sure it works properly. This is because ACT uses memory reading and packet inspection to collect accurate data, which Windows doesn't allow by default. ### Run as Administrator 1. Open your start menu and search for Advanced Combat Tracker. Right-click and choose "Open file location." ![](https://i.imgur.com/VgzfraN.png) 2. Right-click the Advanced Combat Tracker shortcut and choose "Properties." ![](https://i.imgur.com/pqkRIOZ.png) 3. In the window that appears, switch to the "Compatibility" tab, check "Run this program as an administrator," then click "Apply." ![](https://i.imgur.com/3M7gZPR.png) ### Add Firewall Exception 1. Open your start menu and search for "allow app," then choose the "Allow an app through Windows Firewall" setting. ![](https://i.imgur.com/KvqTbBh.png) 2. Click "Change settings" then click "Allow another app..." ![](https://i.imgur.com/dfRRB9j.png) 3. Click "Browse..." then search for your Advanced Combat Tracker folder in your program files, choose the "Advanced Combat Tracker.exe" (you may not see the ".exe" part on your PC), then click "Open." ![](https://i.imgur.com/jeGFmPt.png) 4. Click "Network types..." and ensure both "Private" and "Public" are selected, then click "OK" then click "Add." ![](https://i.imgur.com/znWn9hH.png) 5. In the firewall settings you opened in step 1, click "OK." 6. In ACT, click "Plugins" then "FFXIV Settings" then "Test Game Connection." You should receive a message stating the memory signatures were detected and network data is available. This step must be done while FFXIV is running. ![](https://i.imgur.com/GyW8GAh.png) ## Installing OverlayPlugin OverlayPlugin allows ACT to show your DPS and other metrics in a visually-pleasing manner over your game (hence, overlay). You will need this in order to use overlays such as Ember Overlay (pctured below): ![](https://i.imgur.com/tye5cGJ.png) 1. In ACT, navigate to Plugins > Plugin Listing and choose "Get Plugins..." ![](https://i.imgur.com/hPj8ysg.png) 2. Choose the "[FFXIV+others] Overlay Plugin" option, then click "Download and Enable." ![](https://i.imgur.com/u5y6KTe.png) 3. Your plugin list should list `OverlayPlugin.dll` below `FFXIV_ACT_Plugin.dll`. If it does not, use the up/down arrows to rearrange them accordingly. Rearranging the plugins will require a restart of ACT. ![](https://i.imgur.com/B6EnhwP.png) 4. Navigate to Plugins > OverlayPlugin.dll, click the "New" button, choose the "Ember" preset, and click "OK." ![](https://i.imgur.com/OQa349P.png) 5. Ember Overlay should be visible at this point. Ensure the settings panel for the overlay has the appropriate settings. ![](https://i.imgur.com/1L4cVwo.png) ## Using the Web Socket This section is only for people who wish to use the Web socket with an overlay. This allows you to view the overlay in other ways, such as adding it as an OBS browser source, opening it on your phone, etc. If you don't need to do this, skip this section. 1. In ACT, navigate to Plugins > OverlayPlugin WSServer. Ensure the IP address is set to `127.0.0.1` and the port is set to `10501`. Then click "Start." Note: If you know you want to use a different IP address or port, change them accordingly. IPv6 users may want to use `[::1]` or you may want to bind the socket to all available IP's by using `0.0.0.0` ![](https://i.imgur.com/9RKV5U8.png) 2. Select your desired Web socket overlay from the "Overlay" dropdown. The URL provided in the text box is the URL you should use in OBS, on your phone, etc. This URL is different from the one that appears in your OverlayPlugin.dll tab. ![](https://i.imgur.com/s79ArxT.png) ## Using in OBS If you are a streamer, you can display the overlay in OBS. The easiest way to do this is by using window capture to capture your overlay along with your game. However, if you're using game capture or if you want your OBS overlay to have different settings than your personal overlay, follow the instructions below. 1. Ensure you have completed the [Using the Web Socket](#using-the-web-socket) steps above. 2. Add an OBS Browser Source using the URL you copied from the Using the Web Socket section. ![](https://i.imgur.com/AZHouEn.png) ![](https://i.imgur.com/IuyOAoF.png) 3. If you wish to resize the source, modify the width/height values directly in the source properties (the window where you enter the URL) instead of resizing the source visually in your scene. ![](https://i.imgur.com/cJxfmNy.png) 4. You can interact with the overlay (to change tabs, etc.) by right-clicking the overlay in your OBS scene stage and choosing "Interact." ![](https://i.imgur.com/hpK4XtP.png) 5. To import settings into the overlay (if you have your tables, CSS, etc. customized): 1. Export the settings from a non-OBS overlay (gear icon > Export > copy big block of text). ![](https://i.imgur.com/ZG2DHB2.png) 2. Interact with the OBS overlay. Once interacting, right-click the overlay, and choose "Import." ![](https://i.imgur.com/OytsHEB.png) 3. Paste the text you just copied and click the "Import" button. ![](https://i.imgur.com/8HjM5P9.png) 4. Done! In this example, I imported an overlay with the zoom setting at 150% so that it appears more clearly in OBS. ![](https://i.imgur.com/NgiggHz.png) ### Running Multiple Modes in OBS When normally used in OverlayPlugin, Ember automatically handles running multiple instances in different modes. For example, you could have one overlay in parser/stats mode and one overlay in spell timer mode. However, when using multiple instances of Ember in OBS, the overlays will not be able to remember which mode they are supposed to be in. Therefore, you will need to modify the URL of each overlay a bit. Follow these steps: 1. Get your existing OBS overlay url. It's usually something like: `https://goldenchrysus.github.io/ffxiv/ember-overlay/?HOST_PORT=ws://127.0.0.1/ws` 2. Your URL will either say `?HOST_PORT` or `?OVERLAY_WS` somewhere in the URL. You will be changing this part. 3. After the `?`, add the following: `mode=your_mode&` 4. The URL should now look something like: `https://goldenchrysus.github.io/ffxiv/ember-overlay/?mode=your_mode&HOST_PORT=ws://127.0.0.1/ws` 5. The available modes are `stats` (for the normal parsing overlay) and `spells` (for spell timers). Change `your_mode` to one of these options. For example, my final URL's for each mode would be: 1. Parsing overlay: `https://goldenchrysus.github.io/ffxiv/ember-overlay/?mode=stats&HOST_PORT=ws://127.0.0.1/ws` 2. Spell timers: `https://goldenchrysus.github.io/ffxiv/ember-overlay/?mode=spells&HOST_PORT=ws://127.0.0.1/ws` 6. Use your final URL's in OBS to ensure your instances always load the mode you want them to be in. ================================================ FILE: CHANGELOG.md ================================================ # Changelog ## 1.9.7 **Released: 2025-04-03** ### Bug Fixes - N/A ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - Updated game data through FFXIV patch 7.2 ## 1.9.6 **Released: 2024-11-12** ### Bug Fixes - N/A ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - Updated game data through FFXIV patch 7.1 ## 1.9.5 **Released: 2024-08-29** ### Bug Fixes - N/A ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - Updated game data through FFXIV patch 7.05 ## 1.9.4 **Released: 2024-08-01** ### Bug Fixes - Resolved issue where some SAM and BLM actions did not use post-trait cooldowns ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - N/A ## 1.9.3 **Released: 2024-07-13** ### Bug Fixes - Resolved issue where some buffs, debuffs, and DOTs were not attributed to their relevant classes/jobs ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - N/A ## 1.9.2 **Released: 2024-07-10** ### Bug Fixes - Resolved issue with deprecated skills/effects causing spell timer overlay to fail ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - N/A ## 1.9.1 **Released: 2024-07-01** ### Bug Fixes - N/A ### Features - Detect when overlay is being previewed in order to show sample spell timers ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - N/A ## 1.9.0 **Released: 2024-06-27** ### Bug Fixes - Resolved issue where overlay became unusable when enabling horizontal mode while viewing the raid or aggro tabs ### Features - Added Dawntrail actions (spells), statuses (effects), and zones - Added footer button to toggle the horizontal overlay mode ### UI Changes - Improved spell timer image and countdown positioning - Improved appearance of encounter timer in right-aligned horizontal overlay ### Code Changes - N/A ### Miscellaneous - N/A ## 1.8.1 **Released: 2024-06-13** ### Bug Fixes - N/A ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - Added Pictomancer and Viper jobs ## 1.8.0 **Released: 2024-06-13** ### Bug Fixes - N/A ### Features - Added options to specify metrics and sort order at Settings > Discord Webhook ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - N/A ## 1.7.1 **Released: 2024-06-11** ### Bug Fixes - Resolved issue where overlay did not unhide after auto-hiding and resuming combat ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - N/A ## 1.7.0 **Released: 2024-06-09** ### Bug Fixes - N/A ### Features - Added options to minimize overlay instead of fully hiding when inactive at Settings > Interface > "Auto-Hide Overlay After Inactivity" ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - N/A ## 1.6.1 **Released: 2024-05-09** ### Bug Fixes - Fixed missing image issue in FFXIV Clear Blue theme minimized placeholder ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - N/A ## 1.6.0 **Released: 2024-05-01** ### Bug Fixes - N/A ### Features - Added FFXIV Clear Blue theme ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - Updated game data through FFXIV patch 6.58 ## 1.5.3 **Released: 2023-09-13** ### Bug Fixes - Fixed broken Discord URL ### Features - Updated max spell warning threshold to 30 seconds ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - N/A ## 1.5.2 **Released: 2023-08-18** ### Bug Fixes - N/A ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - Updated game data through FFXIV patch 6.48 ## 1.5.1 **Released: 2023-06-25** ### Bug Fixes - Resolved invalid state fetch error ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - N/A ## 1.5.0 **Released: 2023-06-03** ### Bug Fixes - N/A ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - Updated game data through FFXIV patch 6.4 ## 1.4.1 **Released: 2023-03-07** ### Bug Fixes - Resolved issue where player charts would disappear when an encounter ended ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - N/A ## 1.4.0 **Released: 2023-01-16** ### Bug Fixes - N/A ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - Updated game data through FFXIV patch 6.3 ## 1.3.0 **Released: 2022-12-18** ### Bug Fixes - N/A ### Features - Added "Job" as a selectable column/metric at Settings > Player Table and Settings > Player Detail ### UI Changes - N/A ### Code Changes - All code in `src/` is now linted with ESLint ### Miscellaneous - N/A ## 1.2.1 **Released: 2022-09-04** ### Bug Fixes - Resolved issue with some oGCD actions causing other actions to start their cooldown timers (via action indirections) ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - N/A ## 1.2.0 **Released: 2022-08-26** ### Bug Fixes - N/A ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - Updated game data through FFXIV patch 6.2 ## 1.1.1 **Released: 2022-08-13** ### Bug Fixes - Resolved issue with inactive encounter replacing sample game data due to ACT plugin constantly sending inactive encounter data ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - N/A ## 1.1.0 **Released: 2022-05-31** ### Bug Fixes - N/A ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - Updated game data through FFXIV patch 6.11a ## 1.0.5 **Released: 2022-05-16** ### Bug Fixes - Resolved issue where performance bars were overlapping in raid view ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - N/A ## 1.0.4 **Released: 2022-04-28** ### Bug Fixes - Resolved issue where overlay does not auto hide due to ACT plugin constantly sending inactive encounter data ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - N/A ## 1.0.3 **Released: 2022-03-22** ### Bug Fixes - Resolved misaligned rank in overlay header ### Features - N/A ### UI Changes - Updated Chinese translations ### Code Changes - N/A ### Miscellaneous - N/A ## 1.0.2 **Released: 2022-02-18** ### Bug Fixes - Resolved typo in job names ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - N/A ## 1.0.0 **Released: 2022-01-17** ### Bug Fixes - Resolved issue where spell timers do not reset on party wipe ### Features - Added horizontal overlay - Added setting at Interface > Horizontal > "Use Horizontal Overlay" to enable overlay - Added setting at Interface > Horizontal > "Shrink Width" to only use as much horizontal space as necessary to display game data - Added setting at Interface > Horizontal > "Alignment" to choose if the overlay should be left, right, or center aligned - Choosing "Right" also makes the overlay display from right to left - Metrics displayed in the overlay are controlled by the column settings at Player Table - Metrics displayed in the player tooltips are controlled by the metric settings at Player Detail - Added setting at Interface > Theme > "Text Scale" to adjust the text zoom without affecting most of the UI elements ### UI Changes - N/A ### Code Changes - Updated most pixel-based font sizes to `rem` sizes - Changed performance bars from using `background-size` to using `width` to determine the size of the bar ### Miscellaneous - Updated donor credits ## 0.33.1-alpha **Released: 2022-01-04** ### Bug Fixes - Fixed cooldown calculation for spells with charges ### Features - N/A ### UI Changes - Made spell timer glow more noticeable ### Code Changes - N/A ### Miscellaneous - Updated donor credits - Updated effect and instance data for FFXIV patch 6.05 ## 0.33.0-alpha **Released: 2021-12-06** ### Bug Fixes - N/A ### Features - Added ability to track debuffs - Added Endwalker actions (spells), statuses (effects), and zones ### UI Changes - Updated action and effect icons ### Code Changes - N/A ### Miscellaneous - N/A ## 0.32.3-alpha **Released: 2021-12-04** ### Bug Fixes - N/A ### Features - N/A ### UI Changes - Added Russian translations - Updated French translations - Updated Reaper and Sage job icons ### Code Changes - N/A ### Miscellaneous - N/A ## 0.32.2-alpha **Released: 2021-12-02** ### Bug Fixes - N/A ### Features - N/A ### UI Changes - Updated Chinese, Portuguese, German, Korean, and Ukrainian translations ### Code Changes - Added Reaper and Sage job icons ### Miscellaneous - N/A ## 0.32.1-alpha **Released: 2021-11-15** ### Bug Fixes - Fixed Lightspeed cooldown for characters with Hyper Lightspeed - Fixed issue with overlay crashing in certain scenarios when job name display is enabled ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - N/A ## 0.32.0-alpha **Released: 2021-10-08** ### Bug Fixes - ? ### Features - Added setting at Settings > Interface > "Use Job Names Instead of Player Names" to display job name instead of player name - Added TTS alert for low mana ### UI Changes - N/A ### Code Changes - Added debuff data ### Miscellaneous - N/A ## 0.31.0-alpha **Released: 2021-08-18** ### Bug Fixes - N/A ### Features - Added ability to trigger TTS alerts when self buffs or party buffs are received or when a party member casts a spell ### UI Changes - Added ad support option ### Code Changes - N/A ### Miscellaneous - N/A ## 0.30.1-alpha **Released: 2021-08-17** ### Bug Fixes - Resolved issue where visual timer does not tick down for items with special characters in their name - Resolved issue where permanent timers would not retain their static positions or permanency once invoked ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - N/A ## 0.30.0-alpha **Released: 2021-08-16** ### Bug Fixes - Resolved issue where visual timer does not tick down for items with spaces in their name when in compact or normal mode ### Features - Added swings metric ### UI Changes - N/A ### Code Changes - Updated error logging ### Miscellaneous - N/A ## 0.29.1-alpha **Released: 2021-07-12** ### Features - N/A ### UI Changes - N/A ### Bug Fixes - N/A ### Code Changes - Increased verbosity of Promise errors ### Miscellaneous - N/A ## 0.29.0-alpha **Released: 2021-06-13** ### Features - Added spell timer support for actions that change into other actions (e.g. a Samurai can now track Tsubame-gaeshi instead of Kaeshi: Setsugekka) ### UI Changes - N/A ### Bug Fixes - Resolved issue where health-based TTS alerts would never trigger ### Code Changes - N/A ### Miscellaneous - N/A ## 0.28.3-alpha **Released: 2021-05-24** ### Features - N/A ### UI Changes - N/A ### Bug Fixes - Resolved issue where a jobless combatant (e.g. Limit Breaks) would sometimes crash the overlay ### Code Changes - N/A ### Miscellaneous - N/A ## 0.28.2-alpha **Released: 2021-05-06** ### Features - N/A ### UI Changes - N/A ### Bug Fixes - Resolved issue where some jobless combatants would appear in the overlay when collapsed ### Code Changes - N/A ### Miscellaneous - N/A ## 0.28.1-alpha **Released: 2021-05-05** ### Features - N/A ### UI Changes - N/A ### Bug Fixes - Resolved issue where some effect timers appeared too many times - Resolved issue where some stack-based effects would reset to the maximum duration when a stack was lost ### Code Changes - N/A ### Miscellaneous - N/A ## 0.28.0-alpha **Released: 2021-05-02** ### Features - Added setting "Show Names When Hovering Over Timer" in Spell Designer > General to enable timer name tooltips - Added spell timer support for PVP skills ### UI Changes - Added translations for Ukrainian - Updated translations for German - Changed Interface > Decimal Accuracy setting to slider for UI consistency ### Bug Fixes - Resolved issue where some buffs were missing from the available options - Resolved issue where "Invert Vertical" setting did not align timers to bottom of UI Builder sections - Resolved issue where TTS alerts would include punctuation in some Windows voices - Resolved issue where disabling UI Builder while in "Edit UI" did not remove the UI Builder grid - Resolved issue where Dualcast would not be included in permanent timers for Red Mage ### Code Changes - N/A ### Miscellaneous - N/A ## 0.27.2-alpha **Released: 2021-04-26** ### Bug Fixes - Resolved issue where clicking the highlighted settings cog did not remove the highlight ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - N/A ## 0.27.1-alpha **Released: 2021-04-26** ### Bug Fixes - Resolved issue where adding timers may not work until the overlay is reloaded ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - N/A ## 0.27.0-alpha **Released: 2021-04-25** ### Bug Fixes - Resolved issue with reordering multiple-select dropdowns in settings - Resolved issue where cooldowns would be inaccurate for Contre Sixte, Manafication, and Sharpcast if your character has the recast reduction traits - Resolved issue where timer indicator was shifted right by 3 pixels when setting to hide icons was enabled - Resolved issue where resizing a spell timer UI section would move it back to its original position ### Features - Added setting "Display Permanently" for each timer type in Settings > Spell Timers - Added setting "Use Static Positions for Permanent Timers" for each timer type in Settings > Spell Timers - Added setting "Use Text to Speech" at Settings > Party Spell Timers - Added setting "Only Track in These Instances" at Settings > Party Spell Timers - Added spell timer preview when in Edit UI mode - Added Discord webhook support at setting tab "Discord Webhook" ### UI Changes - Made parser footer more responsive at small overlay sizes (less than or equal to 350 pixels wide) ### Code Changes - Consolidated duplicated localization texts - Removed unnecessary setting schema value lookup functions - Made settings saving more graceful ### Miscellaneous - N/A ## 0.26.0-alpha **Released: 2021-04-22** ### Bug Fixes - Resolved issue where context menu was misplaced when using a non-100 zoom setting ### Features - Added setting "Text to Speech Trigger" to allow choosing when the TTS alert should trigger - Added new setting tab "Party Spell Timers" to set spells that should be tracked for other party/alliance members - Added icon-only spell timer layout at Spell Timers > Layout; enabling this will override the setting to show/hide spell icons - Added new setting tab "Spell Designer" for customizing the appearance of timers - Added spell timer custom UI builder - New setting tab "UI Builder" allows creation of spell timer sections that track only the spell types you choose - Setting "Use UI Builder" in the UI Builder tab must be enabled for changes to take effect - In the overlay, right clicking and choosing "Edit UI" will allow you to drag and resize the spell timer sections you created - UI position/size edits are saved after right clicking and choosing "Save UI" - If you are unable to right click on your overlay (i.e. the overlay is empty), you can either: - Cast a spell that you're already tracking, then you will be able to right click on the spell timer - In OverlayPlugin, turn off the "Lock overlay" option or turn on the "Force white background" option - Be sure to turn off the white background or lock your overlay once you've chosen "Edit UI" or opened your settings - A warning will appear asking you to lock your overlay again once you choose "Edit UI" after unlocking the overlay ### UI Changes - Setting at Spell Timers > Use Minimal Layout has been renamed to "Layout" to allow for the icon-only layout ### Code Changes - N/A ### Miscellaneous - N/A ## 0.25.1-alpha **Released: 2021-04-14** ### Bug Fixes - Resolved issue where spell timer cooldowns are incorrect when system time does not match game time ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - N/A ## 0.25.0-alpha **Released: 2021-04-10** ### Bug Fixes - Resolved issue where settings did not simultaneously distribute if multiple overlays were open ### Features - Added spell timers (for skills, buffs, and DOT's) - Right-click on overlay and choose "Mode: Spell Timers" - Setup can be accessed at Settings > Spell Timers - Settings cog is moved to the top right of the overlay when in spell timer mode - "Use Text to Speech" setting causes the spell name to be said when it's ready - "Minimal Layout" setting turns the spell timers into compact bars - "Warning Threshold" setting causes the spell to begin flashing when the duration is expiring - The "Reverse" options cause the cooldown bar to deplete left-to-right instead of right-to-left - "Invert Vertical" causes the spells to stack bottom-to-top instead of top-to-bottom - "Invert Horizontal" causes the spells to stack right-to-left instead of left-to-right - Added classic theme - Setting to enable is located at Settings > Interface > Theme ### UI Changes - Theme setting (Settings > Interface > Theme) is now a select dropdown - Default theme is "FFXIV Dark" - Previous "Use Light Theme" setting now corresponds to "FFXIV Light" - New classic theme is "FFXIV Classic" ### Code Changes - N/A ### Miscellaneous - N/A ## 0.24.0-alpha **Released: 2021-03-28** ### Bug Fixes - Resolved issue where overlay would sometimes crash when restoring settings from OverlayPlugin ### Features - Added text-to-speech alerts at Settings > Text to Speech - Added numeric-only max hit metric ### UI Changes - N/A ### Code Changes - Abstracted some `MetricNameTable` logic to `Table` in order to share it with the TTS rules table ### Miscellaneous - Updated donor credits - Added PayPay donation option ## 0.23.3-alpha **Released: 2021-01-02** ### Bug Fixes - N/A ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - Updated donor credits ## 0.23.2-alpha **Released: 2020-11-05** ### Bug Fixes - N/A ### Features - N/A ### UI Changes - Player names are now layered above the performance bars in the DOM for style and color consistency ### Code Changes - N/A ### Miscellaneous - Updated donor credits ## 0.23.1-alpha **Released: 2020-09-06** ### Bug Fixes - Resolved issue where overlay may crash if a metric rename uses an emoji ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - N/A ## 0.23.0-alpha **Released: 2020-09-06** ### Bug Fixes - Resolved issue where table header language did not update immedidately upon changing language - Resolved issue where changelog on overlay load would show changes from every existing version instead of only the most recent versions ### Features - Settings silently restore from OverlayPlugin's data store (if present) when settings cannot be found in browser cache - Added "Import from OverlayPlugin" button for Web socket users at right-click > Import - Will pull current settings from OverlayPlugin (if present) and import them into the current overlay - Will only pull settings from like-enviroments (i.e. a production overlay will only pull production settings and a staging overlay only pulls staging settings) ### UI Changes - Updated translations for Japanese and Chinese ### Code Changes - Refactored event subscription logic for performance - Settings now back up to OverlayPlugin's own data store ### Miscellaneous - N/A ## 0.22.0-alpha **Released: 2020-08-16** ### Bug Fixes - N/A ### Features - Settings page now works independently of the main overlay (parser) - Previously, settings would only save if you opened the settings page from the parser and kept the parser open - Can navigate directly to `https://goldenchrysus.github.io/ffxiv/ember-overlay/#/settings/about` without the parser open to make changes - Useful in programs like Streamlabs OBS where pasting usually does not work so settings are difficult to import; can modify settings directly in the Browser Source now - Added setting to prioritize party at top of player list - Intended for alliance raids, your party will be listed before all other raid members - Rankings and performance bars will still be relative to the entire raid's performance - Accessible at Settings > Player Table > Prioritize Party Members at Top of List or Settings > Raid View > Prioritize Party Members at Top of List ### UI Changes - N/A ### Code Changes - Player rows now have HTML attributes `data-party="1"` or `data-party="0"` to indicate if a given player is or isn't in your party, respectively - Performance improvements ### Miscellaneous - N/A ## 0.21.0-alpha **Released: 2020-08-09** ### Bug Fixes - N/A ### Features - Added ability to drag and drop player table columns, player detail metrics, and raid view metrics in settings to allow easy reordering - Added shield per second metric ### UI Changes - Added translations for Korean - Updated translations for Chinese - Changed colors of player detail chart - Red for DPS - Green for HPS - Blue for DTPS - Reordered max hit and max heal metrics so numeric value displays before skill name ### Code Changes - N/A ### Miscellaneous - Updated README feature images ## 0.20.3-alpha **Released: 2020-08-02** ### Bug Fixes - N/A ### Features - N/A ### UI Changes - Updated translations for Chinese ### Code Changes - N/A ### Miscellaneous - N/A ## 0.20.2-alpha **Released: 2020-08-02** ### Bug Fixes - Fixed issue where max DPS would carry over from previous encounter ### Features - N/A ### UI Changes - Made performance bar backgrounds slightly lighter in the light theme ### Code Changes - N/A ### Miscellaneous - Updated sample data - Updated README feature images ## 0.20.1-alpha **Released: 2020-08-01** ### Bug Fixes - Fixed issue where max DPS is sometimes not registered correctly due to incorrect data types ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - N/A ## 0.20.0-alpha **Released: 2020-07-26** ### Bug Fixes - Fixed issue where rank was higher than it should be if player is in last place - Fixed issue with overlay crashing in some cases when an monster's target had not yet been processed in the combatant tables ### Features - Added new player metric: Max Damage Per Second - "Max Damage Per Second" is each combatant's ongoing max recorded DPS after at least 30 seconds have elapsed in the encounter - Added pet and companion support - Pets and companions will appear below the main player table - Each pet or companion counts towards the overall combatant count - Your combatant rank/performance is based on your character's DPS/HPS/etc. not the DPS/HPS/etc. of your pets or companions - This functionality is directly tied to the ACT setting located at Plugins > FFXIV Settings > Disable Combine Pets with Owner - Ember does not provide any pet merging functionality outside of the standard ACT merging functionality ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - N/A ## 0.19.0-alpha **Released: 2020-07-19** ### Bug Fixes - Fixed issue with Twitch streamers list not loading in settings menu ### Features - Added new player metrics: Heal Count, Shields, and Parry %. - "Heal Count" is the number of heals (not the health value of heals) casted - "Shields" is health value of shielding casted - "Parry %" is the frequency of parrying, similar to "Block %" ### UI Changes - Renamed "Select All" in Settings > Export to "Copy" -- button now automatically initiates a copy of all of the export text ### Code Changes - N/A ### Miscellaneous - Added welcome message in OverlayPlugin logs ## 0.18.0-alpha **Released: 2020-07-05** ### Bug Fixes - N/A ### Features - Added minimal theme - Enable the minimal theme in Settings > Interface > Theme ### UI Changes - Shortened English "Death" table title to "Dth" ### Code Changes - Added `data-role` attribute (enum: `dps`, `heal`, `tank`) to player row `
` for easier role-wide CSS styling ### Miscellaneous - Reorganized "Interface" settings section ## 0.17.0-alpha **Released: 2020-06-07** ### Bug Fixes - N/A ### Features - Added encounter history - Encounter history can be accessed by clicking the rewind clock icon in the bottom-right of the overlay - Up to five encounters will be stored at a time, including the active encounter - If viewing a previous encounter while in an active encounter, the previous encounter will continue to display until the user manually switches back to the active encounter - Active encounter will continue to accurately parse in the background when viewing a previous encounter - Previous encounters store: table data, player detail (including graphs), enmity data, and the aggro list ### UI Changes - Renamed "Aggro" tab to "Agg" to save space ### Code Changes - N/A ### Miscellaneous - N/A ## 0.16.0-alpha **Released: 2020-05-30** ### Bug Fixes - Fixed 404 error for resize handle image ### Features - Added enmity and aggro data for ngld OverlayPlugin users - Added "Enmity" metric to table and detail settings - "Aggro" tab automatically available for ngld OverlayPlugin users - TODO: Add "copy" and "paste" buttons for exporting/importing settings data ### UI Changes - New-version indicator (colored gear) will no longer trigger when overlay is running in OBS ### Code Changes - `/src/data/locales/metrics.json` renamed to `player-metrics.json` - `/src/data/locales/monster-metrics.json` added - `/src/processors/SocketMessageProcessor.js` renamed to `MessageProcessor.js` - Modified `/src/services/PluginService.js` to utilize the aforementioned `MessageProcessor` ### Miscellaneous - N/A ## 0.15.3-alpha **Released: 2020-02-09** ### Bug Fixes - N/A ### Features - N/A ### UI Changes - Updated translations for Portuguese and Japanese ### Code Changes - N/A ### Miscellaneous - N/A ## 0.15.2-alpha **Released: 2020-01-26** ### Bug Fixes - Fixed issue causing DPS, HPS, damage taken, heals taken, and deaths to not always sum in the table footer depending on which overlay tab was active ### Features - N/A ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - N/A ## 0.15.1-alpha **Released: 2020-01-15** ### Bug Fixes - N/A ### Features - Added better support for ngld OverlayPlugin Web sockets - Alternative URL for Ember Overlay is `http://http.chrysus.xyz/ffxiv/ember-overlay/` - Users on ngld OverlayPlugin using Web sockets will automatically redirect to this URL; no plugin setup changes are necessary ### UI Changes - N/A ### Code Changes - Added redirect to non-SSL site for Web socket users on ngld OverlayPlugin - Added build variants `nonssl` and `nonssl-staging` for building the non-SSL site code - `npm run build:nonssl` - `npm run build:nonssl-staging` ### Miscellaneous - Created new ACT/OverlayPlugin installation guide ## 0.15.0-alpha **Released: 2020-01-12** ### Bug Fixes - N/A ### Features - Added setting page to rename metrics - Accessible at Settings > Metric Names - Add new metric name by choosing an existing metric, entering custom names, and clicking "Add" - Custom names can be deleted by clicking "Delete" on the row - Must click "Save" for your custom names to update ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - Added PayPal donation option - Corrected changelogs for previous versions ## 0.14.0-alpha **Released: 2019-12-23** ### Bug Fixes - N/A ### Features - Added setting to auto-hide the overlay after a period of inactivity - The method for calculating inactivity is subject to change; please report issues in the Discord ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - N/A ## 0.13.0-alpha **Released: 2019-12-01** ### Bug Fixes - Resolved issue where imported settings would sometimes not save ### Features - N/A ### UI Changes - Added French and Spanish translations - Fixed some translation errors - Updated some translation items for all languages ### Code Changes - N/A ### Miscellaneous - Corrected changelogs for previous versions ## 0.12.1-alpha **Released: 2019-11-04** ### Bug Fixes - Resolved issue where encounter history graph would reset after 100 seconds ### Features - N/A ### UI Changes - Updated some translations for Chinese ### Code Changes - N/A ### Miscellaneous - N/A ## 0.12.0-alpha **Released: 2019-09-29** ### Bug Fixes - Resolved issue where decimal accuracy of 0 would not be saved ### Features - Added setting to blur job icons when blurring player names ### UI Changes - Updated some translations for Chinese ### Code Changes - N/A ### Miscellaneous - N/A ## 0.11.0-alpha **Released: 2019-09-15** ### Bug Fixes - N/A ### Features - Added setting to specify decimal accuracy (0, 1, or 2 - default) - Added setting to shorten thousands to "K" ### UI Changes - N/A ### Code Changes - N/A ### Miscellaneous - N/A ## 0.10.0-alpha **Released: 2019-09-02** ### Bug Fixes - Resolved issue where custom CSS code editor wouldn't expand vertically to accommodate several lines of CSS - HOTFIX: Resolved issue where overlay would instantiate infinite WebSocket clients, causing high CPU usage on some machines - Resolved issue where the overlay couldn't be collapsed as normal upon first load before an encounter had begun ### Features - Added translation system - Languages - Português - 中文 - 日本語 - Deutsch - To do: - README - Changelogs - Donation page - New text added since the translation process began ### UI Changes - Removed decimals from death metric ### Code Changes - Added translation data at `/src/data/locales/*.json` - Translations are generated by new service at `/src/services/LocalizationService.js` - Added `react-string-replace` to help dynamically replace placeholder text in translation templates with React components ### Miscellaneous - Added credits to "About" and "Donate" pages in settings ## 0.9.0-alpha **Released: 2019-08-25** ### Bug Fixes - Resolved issue where saved CSS would not appear in code editor on subsequent loads of the settings window - HOTFIX: Resolved issue where calculating effective healing metrics may cause an error ### Features - Added setting to display total DPS (rDPS) in overlay footer - Added setting to show overlay footer when collapsed - Added setting to show performance background bars - Added setting to specify current player's name - Converted on/off player name shortening setting to setting with four options - Options are: No shortening, First L., F. Last, and F. L. ### UI Changes - Renamed "TPS" (Tank Per Second) to "DTPS" (Damage Taken Per Second) - Changed blur intensity when blurring player names - Added value indicator to settings sliders - Added donation info to overlay startup screen and settings window ### Code Changes - Added migration system to convert old data to new data - File structure is as follows: - `/src/constants/Migrations.js` lists the available migrations in order of creation - `/src/migrations/*` contains each migration file and its logic - `/src/services/MigrationService.js` handles running any pending migrations - Migration process is initiated from `/src/index.js` - Implemented scaling reconnect delay when a connection to ACTWebSocket fails or closes ### Miscellaneous - Updated README with OverlayPlugin version requirement - Updated README with ACTWebSocket version requirement ## 0.8.0-alpha **Released: 2019-08-18** ### Bug Fixes - N/A ### Features - Added new metric "tank per second" - Shows damage tanked per second (TPS) - Added graphs to the player detail view - Graphs display DPS, HPS, and TPS - Added setting to move table footer row to top of table - ON HOLD: Add setting to display total DPS in bottom right of overlay - ON HOLD: Add setting to show bottom of overlay when collapsed ### UI Changes - Added "View Encounter Detail" to right-click menu ### Code Changes - Added `lodash.mergewith` to customize the way arrays are merged for settings ### Miscellaneous - Update sample data to add history data for charts ## 0.7.0-alpha **Released: 2019-08-11** ### Bug Fixes - Resolved issue where table summation did not work for some regions - Resolved issue where changing multiple settings simultaneously wouldn't update all settings ### Features - Added settings import/export - To export, open the settings window, navigate to the "Export" page, and copy the export key - To import, right click on the overlay, choose "Import," and paste the exported key - Added streamers panel at Settings > Streamers - If streamers are live, only live streamers are featured - If all streamers are offline, all streamers are featured - Streamer display order is random for fairness - Added light theme - Setting to enable is located at Settings > Interface > "Use Light Theme" ### UI Changes - Right-click menu is now more organized with group dividers ### Code Changes - Added `lodash.shuffle` as a convenient Fisher-Yates shuffle implementation - Used to shuffle the streamer list for fair, random display orders - Added LESS functions file at `/src/styles/functions/common.less` to support theme-specific CSS - Refactored several LESS files within `/src/styles/components` ### Miscellaneous - N/A ## 0.6.0-alpha **Released: 2019-08-04** ### Bug Fixes - Long-pressing left click will no longer trigger the context menu - Numbers for max hit/heal in certain regions will no longer result in "NaN" - Changelog sections will no longer display in "About" if they contain no changes ### Features - Added button to toggle collapsed state - Added setting to make overlay collapse downwards - Added settings to change player names to short names - Added setting for overlay zoom - Overlay can be minimized in the bottom corners ### UI Changes - Changed player table "CH DH %" header to "CDH %" for critical direct hits - Moved minimize buttons to the corners of the overlay - Added tooltips on hover to all icon buttons to make their purpose clearer - Made settings page accessible from right-click menu - Converted custom CSS input box to a code input box - Encounter time is now listed at the beginning of the encounter info - Encounters titled "Encounter" will simply list the zone name rather than displaying "Encounter" first ### Code Changes - Added `react-tooltip` package for icon button tooltips - Added `react-simple-code-editor` package to convert CSS textarea to styled code input ### Miscellaneous - Added staging site info to README ## 0.5.0-alpha **Released: 2019-07-28** ### Bug Fixes - N/A ### Features - Adding settings system - Overlay will remember which tab user was viewing and if they had the overlay collapsed - User can specify the opacity (transparency) of the overlay - User can specify if their party rank should display in the top-right corner - For each table tab, the user can specify the columns that appear, default sorting, and whether the footer row shows - For the player detail, the user can specify the metrics that appear for each role type - For the raid view, the user can specify the default sorting and the metrics that appear for each role type - User can blur other players' names (eye icon in bottom right of overlay) - User can provide custom CSS that will affect the overlay - Will not affect settings page - Updated sample data to eight players instead of four ### UI Changes - N/A ### Code Changes - Added middleware to Redux store to listen for state changes from other instances of the same session - For syncing setting changes from the settings interface to the active overlay - Added `semantic-ui-less` and `semantic-ui-react` - Refactored all CSS colors into LESS variables for future light theme - Added `changelog-parser` to help auto-create user-friendly changelogs based on user's last version - Added some `lodash` packages for easier state management - Added `jquery-ui` package for slider - Added `compare-versions` to perform version comparison logic - Refactored lots of code ### Miscellaneous - N/A ## 0.4.0-alpha **Released: 2019-07-21** ### Bug Fixes - N/A ### Features - Added 24-person overlay tab - Sorting is by total damage descending - Currently shows DPS and HPS as metrics - Metric types are prioritized by job role (i.e. healers display HPS before DPS) ### UI Changes - N/A ### Code Changes - Added `GameJobs` constant comprising job data (roles, currently) indexed by class/job key ### Miscellaneous - Corrected changelogs for previous versions ## 0.3.0-alpha **Released: 2019-07-20** ### Bug Fixes - Resolved issue where encounter is always listed as inactive - Fixed table sorting for scenarios when primary sort values for two players are equal ### Features - Added ability to split encounter when using OverlayProc - Click the scissors icon in the bottom right of the overlay, or right-click and choose "Split Encounter" ### UI Changes - Improved automatic resizing of table columns ### Code Changes - Updated router to `HashRouter` - Added default environment variables - `package.json` and `.env-cmdrc.sample` files were updated to reflect this - Added staging environment to build options ### Miscellaneous - Updated README ## 0.2.0-alpha **Released: 2019-07-20** ### Bug Fixes - Cursor will no longer change to a text cursor when hovering over text in an OverlayProc window - Corrected issues presented by React console errors - Resolved issue where socket disconnect would throw a JavaScript error - Resolved issue where numbers with decimals ending in 0 may be formatted differently than other numbers - RESOLVES: 0.1.2-alpha bug: "Inconsistent number formatting for certain regions" ### Features - Added ability to split encounter when using OverlayPlugin - Click the scissors icon in the bottom right of the overlay, or right-click and choose "Split Encounter" ### UI Changes - Added Font Awesome icon package ### Code Changes - Implemented `react-router-dom` route matching in order to support planned settings dialog - Restructured file tree of the `Parser` component ### Miscellaneous - Implemented Semantic versioning ## 0.1.2-alpha **Released: 2019-07-19** ### Bug Fixes - IN PROGRESS: Inconsistent number formatting for certain regions ### Features - Navigation footer will not be shown in collapsed mode ### UI Changes - Removed title bar - Removed italics from encounter info bar - Encounter info is now prefixed with "Inactive:" when the encounter is inactive - Made "DPS," "Heal," and "Tank" buttons at bottom of overlay smaller ### Code Changes - Changed some component file tree organization - Defined build environment variables in `.env-cmdrc` - Modified build commands to accommodate production and development build enviroments ### Miscellaneous - Added changelog - Added changelog info to readme - Updated README build steps ================================================ FILE: LICENSE ================================================ GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . ================================================ FILE: README.md ================================================ # FFXIV Ember Overlay & Spell Timers Powerful, data-focused DPS overlay and spell timers for Final Fantasy XIV. Can be used with the [OverlayPlugin](https://github.com/ngld/OverlayPlugin/releases) and [ACTWebSocket](https://github.com/ZCube/ACTWebSocket) plugins for [Advanced Combat Tracker](https://advancedcombattracker.com/download.php). ### Updated for Dawntrail. [![GitHub](https://img.shields.io/github/license/GoldenChrysus/ffxiv-ember-overlay.svg?style=flat-square)](https://github.com/GoldenChrysus/ffxiv-ember-overlay/blob/master/LICENSE) ![GitHub package.json version](https://img.shields.io/github/package-json/v/GoldenChrysus/ffxiv-ember-overlay/master.svg?style=flat-square) ![GitHub last commit (branch)](https://img.shields.io/github/last-commit/GoldenChrysus/ffxiv-ember-overlay/bleeding-edge.svg?style=flat-square) [![Works with OverlayPlugin](https://img.shields.io/badge/works%20with-OverlayPlugin-blue.svg?style=flat-square)](https://github.com/ngld/OverlayPlugin) [![Works with ACTWebSocket](https://img.shields.io/badge/works%20with-ACTWebSocket-blue.svg?style=flat-square)](https://github.com/ZCube/ACTWebSocket) [![Discord](https://img.shields.io/discord/603399999723929600.svg?style=flat-square&logo=discord)](https://discord.gg/7Kdpw6C) ![GitHub package.json dynamic](https://img.shields.io/github/package-json/keywords/GoldenChrysus/ffxiv-ember-overlay.svg?style=flat-square) #### Funding Donate on Cash App Donate at PayPal ペイペイで施してください Donate at Ko-fi Become a Patron Donate at Streamlabs ## Usage with OverlayPlugin Create a new overlay from one of the Ember presets. Alternatively, 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.gg/7Kdpw6C](https://discord.gg/7Kdpw6C) ## Navigation - Features - Installation - Changelog - Staging Site - Credits - Building - Contributing - License - Copyright ## Features ### Informative tabs for damage, healing, tanking, raiding, and aggro. ![DPS tab](https://i.imgur.com/EjRWhdU.png "DPS tab") ![Healing tab](https://i.imgur.com/TxqEJ1t.png "Healing tab") ![Tanking tab](https://i.imgur.com/uMXYkyu.png "Tanking tab") ![Raid tab](https://i.imgur.com/8pKG0uC.png "Raid tab") ![Aggro tab](https://i.imgur.com/H79KkfB.png "Aggro tab") ### Click on any player's name to view detailed statistics. ![Detailed statistics](https://i.imgur.com/EzR299y.gif "Detailed statistics") ### Optional minimal, Light, Classic, and Clear Blue themes (minimal can be combined with any theme). ![Minimal theme](https://i.imgur.com/psPV5yL.png "Minimal theme") ![Light theme](https://i.imgur.com/HJTyGqJ.png "Light theme") ![Classic theme](https://i.imgur.com/wq65hM7.png "Classic theme") ![Clear Blue theme](https://i.imgur.com/vHWhxp4.png "Clear Blue theme") ### Compact yet fully-featured horizontal layout available for every theme combination. ![Horizontal layout](https://i.imgur.com/S58QK2m.png "Horizontal layout") ### Spell timers. **Spell, buff, DOT, and debuff timers.** ![Spell, buff, DOT, and debuff timers](https://i.imgur.com/7qNwV06.gif "Spell, buff, DOT, and debuff timers") **Optional minimal layout.** ![Minimal layout](https://i.imgur.com/KM1bQdr.png "Minimal layout") **Flexible layout options.** ![Flexible layout](https://i.imgur.com/eluTIe2.png "Flexible layout") ![Icon layout](https://i.imgur.com/eEWwUfi.png "Icon layout") **Powerful but easy spell timer setup.** ![Powerful but easy setup](https://i.imgur.com/z8UPg7u.png "Powerful but easy setup") ### Text to speech alerts. ![Customizable text to speech alerts](https://i.imgur.com/cMj0OJF.png "Customizable text to speech alerts") ### Powerful overlay and data settings. ![Customizable overlay](https://i.imgur.com/Kpq8ZPb.gif "Customizable overlay") ### Quality of life features. **Collapsible interface to save space and show only your stats.** ![Collapsible interface](https://i.imgur.com/7MDEnJm.gif "Collapsible interface") **Blur player names for privacy (optionally blur job icons).** ![Blur player names](https://i.imgur.com/AWHwZ03.gif "Blur player names") **Browse encounter history (up to five encounters).** ![View encounter history](https://i.imgur.com/HfAq3kc.png "View encounter history") **Minimize the entire overlay to the left or right when not in use to free up screen space.** ![Minimize when not in use](https://i.imgur.com/HSiTNCF.gif "Minimize when not in use") **Share customizable stats with your party or raid group on Discord.** ![Discord webhook](https://i.imgur.com/IX8w7Ly.png "Discord webhook") ### Easily see the recent changes since your last visit. ![About and changelog](https://i.imgur.com/fgZgoN4.gif "About and changelog") ### Clear encounter data or load sample data to perfect your setup. ![Clear encounter and load sample data](https://i.imgur.com/hfvn80v.gif "Clear encounter and load sample data") ![Load sample spell data](https://i.imgur.com/FTVyfGt.gif "Load sample spell data") ## Installation #### Other Languages Available - [日本語：Onlinegaming.life](https://onlinegaming.life/ff14/ember-overlay/) To use this overlay, you need Advanced Combat Tracker (ACT) and OverlayPlugin. Please follow the guide based on your situation: ### You don't have ACT or OverlayPlugin Please follow [the ACT + OverlayPlugin installation guide](https://github.com/GoldenChrysus/ffxiv-ember-overlay/blob/bleeding-edge/ACT_INSTALLATION.md) from the beginning. ### You already have ACT but need OverlayPlugin Please follow [the OverlayPlugin installation guide](https://github.com/GoldenChrysus/ffxiv-ember-overlay/blob/bleeding-edge/ACT_INSTALLATION.md#installing-overlayplugin). ### You already have ACT and OverlayPlugin Choose the guide based on your version of OverlayPlugin: #### ngld OverlayPlugin 1. Within ACT, navigate to Plugins > OverlayPlugin.dll. 2. Set your overlay URL to https://goldenchrysus.github.io/ffxiv/ember-overlay/ or add a new overlay with the Ember preset selected (presets available in ngld OverlayPlugin 0.13.0 or later). #### hibiyasleep or RainbowMage OverlayPlugin 1. Within ACT, navigate to Plugins > OverlayPlugin.dll > Mini Parse. 2. Set the URL to https://goldenchrysus.github.io/ffxiv/ember-overlay/ 3. Click "Reload overlay," and the overlay should now be visible in your FFXIV game. ### Older Guides (ACTWebSocket and 0.3.4.0 OverlayPlugin) If you need to see the old ACTWebSocket or 0.3.4.0 OverlayPlugin guides, they can be accessed [here](https://github.com/GoldenChrysus/ffxiv-ember-overlay/tree/0.15.0-alpha#installation). ## Changelog View the full changelog [here](/CHANGELOG.md). ## 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](https://discord.gg/7Kdpw6C). When viewing the [changelog](/CHANGELOG.md), 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 - [**ShadyWhite**](https://github.com/ShadyWhite) - Chinese - **Gusma** - Portuguese - **The_X** - Portuguese - [**okuRaku**](https://github.com/okuRaku) - Japanese - **Astriel** - German - **Claud** - Spanish - **Okâme** - French - **Tsunari96** - Tsunari96#8491 (Discord) - Korean - [**justscribe**](https://github.com/justscribe) - [Twitch](https://www.twitch.tv/justscribe), [Website](https://ffxiv.gaming4eternity.online/) - Ukrainian - **Gisar** - Russian ### Featured Donors - Pimpy Shortstocking - FortiusTTV - [Twitch](https://www.twitch.tv/fortiusttv) - loski3 - Vale Alania ### Donors - Amneamnius - Vulasuw - Jessica - mehdont - Tomo ### Misc. - [canisminor1990/ffxiv-cmskin](https://github.com/canisminor1990/ffxiv-cmskin) - CSS styling ## 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` - If new to or unfamiliar with git, reference GitHub's article on [cloning a repository](https://help.github.com/en/articles/cloning-a-repository). - Alternatively, you can [download the ZIP file](https://github.com/GoldenChrysus/ffxiv-ember-overlay/archive/bleeding-edge.zip) for the repository. 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 0. For new features, it would be best to first discuss your plans in an issue. This is to ensure that I haven't already completed a similar feature locally, that I agree with your approach, and that your feature aligns with the overall vision of the project. Bypassing this and sending new features straight to pull may result in pull rejection. 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](/LICENSE) ## Copyright Copyright (C) 2019-2021, Patrick Golden. All rights reserved. Copyrights licensed under GNU General Public License v3.0 only. See the accompanying [LICENSE](/LICENSE) file for terms. ================================================ FILE: craco.config.js ================================================ const { getLoader, loaderByName, throwUnexpectedConfigError } = require("@craco/craco"); module.exports = { babel : { plugins : ["@babel/plugin-transform-optional-chaining"], }, webpack : { alias : { "../../theme.config$" : require("path").join(__dirname, "/src/semantic-ui/theme.config"), }, }, plugins : [ { plugin : require("craco-less"), options : { lessLoaderOptions : { javascriptEnabled : true, }, }, }, { plugin : { overrideWebpackConfig({ context, webpackConfig }) { const { isFound, match: fileLoaderMatch } = getLoader( webpackConfig, loaderByName("file-loader"), ); if (!isFound) { throwUnexpectedConfigError({ message : `Can't find file-loader in the ${context.env} webpack config!`, }); } fileLoaderMatch.loader.exclude.push(/theme.config$/); fileLoaderMatch.loader.exclude.push(/\.variables$/); fileLoaderMatch.loader.exclude.push(/\.overrides$/); if (["development", "staging"].indexOf(process.env.REACT_APP_ENV) !== -1) { webpackConfig.mode = "development"; webpackConfig.optimization.minimize = false; webpackConfig.optimization.runtimeChunk = false; webpackConfig.optimization.splitChunks = { cacheGroups : { default : false, }, }; webpackConfig.output.filename = "[name].js"; } return webpackConfig; }, }, }, ], eslint : { enable : false, }, }; ================================================ FILE: package.json ================================================ { "name": "ffxiv-ember-overlay", "description": "React + Redux overlay for the OverlayPlugin and ACTWebSocket plugins for Advanced Combat Tracker for use with Final Fantasy XIV.", "license": "GPL-3.0-only", "version": "1.9.7", "keywords": [ "ffxiv", "dawntrail", "ffxiv-overlays", "ffxiv-act", "overlayplugin", "overlayplugin-skin", "actwebsocket", "ember", "endwalker" ], "private": true, "dependencies": { "@babel/plugin-transform-optional-chaining": "^7.24.7", "changelog-parser": "^2.8.0", "chart.js": "^2.8.0", "compare-versions": "^3.5.0", "env-cmd": "^9.0.3", "jquery": "^3.4.1", "jquery-ui": "^1.12.1", "localforage": "^1.7.3", "lodash.clonedeep": "^4.5.0", "lodash.isequal": "^4.5.0", "lodash.mergewith": "^4.6.2", "lodash.shuffle": "^4.2.0", "react": "^16.8.6", "react-chartjs-2": "^2.7.6", "react-contextmenu": "^2.11.0", "react-dom": "^16.8.6", "react-redux": "^7.1.0", "react-rnd": "^10.2.4", "react-router-dom": "^5.0.1", "react-scripts": "3.0.1", "react-simple-code-editor": "^0.9.14", "react-string-replace": "^0.4.4", "react-tooltip": "^4.2.7", "redux": "^4.0.4", "redux-promise-middleware": "^6.1.1", "semantic-ui-react": "^0.87.3", "sortablejs": "^1.10.2" }, "scripts": { "copy:changelog": "cp CHANGELOG.md public/logs/", "prestart": "npm run copy:changelog", "start": "env-cmd -e default,development craco start", "prebuild:development": "npm run copy:changelog", "build:development": "env-cmd -e default,development craco build", "prebuild:staging": "npm run copy:changelog", "build:staging": "env-cmd -e default,staging craco build", "prebuild:nonssl-staging": "npm run copy:changelog", "build:nonssl-staging": "env-cmd -e default,staging,nonssl craco build", "prebuild:nonssl": "npm run copy:changelog", "build:nonssl": "env-cmd -e default,production,nonssl craco build", "prebuild": "npm run copy:changelog", "build": "env-cmd -e default,production craco build", "test": "craco test", "eject": "craco eject", "eslint": "npx eslint src" }, "eslintConfig": { "extends": "react-app" }, "browserslist": { "production": [ ">0.2%", "not dead", "not op_mini all" ], "development": [ "last 1 chrome version", "last 1 firefox version", "last 1 safari version" ] }, "homepage": ".", "devDependencies": { "@commitlint/cli": "^17.1.2", "@commitlint/config-conventional": "^17.1.0", "@craco/craco": "5.2.4", "craco-less": "1.9.0", "eslint": "^8.26.0", "eslint-config-xo": "^0.42.0", "eslint-formatter-summary-chart": "^0.2.1", "eslint-plugin-align-assignments": "^1.1.2", "eslint-plugin-react": "^7.31.10", "husky": "^8.0.1", "pre-commit": "^1.2.2", "semantic-ui-less": "2.4.1" }, "pre-commit": [ "eslint" ] } ================================================ FILE: public/data/streamers.txt ================================================ chrysus,manachase,fullburner,gunlancewyvern,michael_lightning,fzzld,xantaravictori,lumms,vaiur_,kimiie,astraleah,zapxthebestx,cerila,awsome26,cocomisu,zarrzarr,neocis75,trollance,gummy_kitteh,tyronesama,hanzo_j2c,oathkeeper_sora_xiii,docblank,mrarca9,ironpandemonium,chompytv,physcor,monkeypinata,sablecentaur,fishkumi,DrD1sconnect,fortiusttv,keanecat,bokusplayground,bimbas,mashiesmashie,cryzorbr,yuonemi,kdean19,sestralsr,tampe0n,manbeardgames,dannizgaming,bulbaworld,holddownback,kaysershinya,misterwashburn,quepasajose ================================================ FILE: public/index.html ================================================ %REACT_APP_PAGE_TITLE%
================================================ FILE: public/logs/.gitignore ================================================ !.gitignore ================================================ FILE: public/manifest.json ================================================ { "short_name": "Ember Overlay", "name": "Ember Overlay for Advanced Combat Tracker", "icons": [ { "src": "favicon.ico", "sizes": "64x64 32x32 24x24 16x16", "type": "image/x-icon" } ], "start_url": ".", "display": "standalone", "theme_color": "#000000", "background_color": "#ffffff" } ================================================ FILE: scripts/effects.py ================================================ import json import os.path import requests import shutil from os import path def getPage(page_num): url = "https://xivapi.com/search?page=" + str(page_num) + "&indexes=Status" res = requests.get(url = url) return res.json() def getEffect(id): url = "https://xivapi.com/Status/" + str(id) res = requests.get(url = url) return res.json() def saveImage(id, xiv_path): local_path = "../public/img/icons/effects/" + str(id) + ".jpg" if (path.exists(local_path)): return url = "https://xivapi.com/" + xiv_path res = requests.get(url, stream = True) if res.status_code == 200: res.raw.decode_content = True with open(local_path, "wb") as file: shutil.copyfileobj(res.raw, file) file.close() def saveEffects(effects): with open("../src/data/game/effects.json", "w", encoding = "utf8") as file: json.dump(effects, file, indent = "\t", separators = (",", " : "), ensure_ascii = False) file.close() def loadEffects(): with open("../src/data/game/effects.json") as file: data = json.load(file) file.close() return data def loadDots(): with open("../src/data/game/dot-jobs.json") as file: data = json.load(file) file.close() return data def loadBuffs(): with open("../src/data/game/buff-jobs.json") as file: data = json.load(file) file.close() return data def loadDebuffs(): with open("../src/data/game/debuff-jobs.json") as file: data = json.load(file) file.close() return data page = 1 effects = {} existing_effects = loadEffects() dots = loadDots() buffs = loadBuffs() debuffs = loadDebuffs() while (True): page_data = getPage(page) page = page_data["Pagination"]["PageNext"] for effect in page_data["Results"]: id = effect["ID"] if str(id) in existing_effects: if (existing_effects[str(id)]["locales"]["name"]["en"] != existing_effects[str(id)]["locales"]["name"]["jp"]): effects[id] = existing_effects[str(id)] continue effect_data = getEffect(id) item_type = "effect" if (effect_data["Name_en"] == effect_data["Name_ja"]): continue if (effect_data["Category"] == 2): if effect_data["InflictedByActor"] == 1: continue elif "over time" not in effect_data["Description_en"]: item_type = "debuff" else: item_type = "dot" effects[id] = { "type" : item_type, "dot" : (item_type == "dot"), "debuff" : (item_type == "debuff"), "jobs" : [], "locales" : { "name" : { "en" : effect_data["Name_en"], "de" : effect_data["Name_de"], "fr" : effect_data["Name_fr"], "jp" : effect_data["Name_ja"] } } } if effect_data["Name_en"] in dots: effects[id]["jobs"] = dots[effect_data["Name_en"]] elif effect_data["Name_en"] in buffs: effects[id]["jobs"] = buffs[effect_data["Name_en"]] elif effect_data["Name_en"] in debuffs: effects[id]["jobs"] = debuffs[effect_data["Name_en"]] saveImage(id, effect_data["Icon"]) if (page == None or page <= page_data["Pagination"]["Page"]): saveEffects(effects) break ================================================ FILE: scripts/instances.py ================================================ import json import os.path import requests import shutil from os import path def getPage(page_num): url = "https://xivapi.com/InstanceContent?page=" + str(page_num) + "" res = requests.get(url = url) return res.json() def getInstance(id): url = "https://xivapi.com/InstanceContent/" + str(id) res = requests.get(url = url) return res.json() def saveInstances(instances): with open("../src/data/game/instances.json", "w", encoding = "utf8") as file: json.dump(instances, file, indent = "\t", separators = (",", " : "), ensure_ascii = False) file.close() page = 1 instances = {} while (True): page_data = getPage(page) page = page_data["Pagination"]["PageNext"] for record in page_data["Results"]: id = record["ID"] instance_data = getInstance(id) if (instance_data["ContentFinderCondition"] == None): continue instances[id] = { "zone_id" : instance_data["ContentFinderCondition"]["TerritoryType"]["ID"], "locales" : { "name" : { "en" : instance_data["Name_en"], "de" : instance_data["Name_de"], "fr" : instance_data["Name_fr"], "jp" : instance_data["Name_ja"] } } } if (page == None or page <= page_data["Pagination"]["Page"]): saveInstances(instances) break ================================================ FILE: scripts/jobs.py ================================================ import json import os.path import requests import shutil from os import path def getPage(page_num): url = "https://xivapi.com/ClassJob?page=" + str(page_num) + "" res = requests.get(url = url) return res.json() def getItem(id): url = "https://xivapi.com/ClassJob/" + str(id) res = requests.get(url = url) return res.json() def saveData(records): with open("../src/data/game/jobs.json", "w", encoding = "utf8") as file: json.dump(records, file, indent = "\t", separators = (",", " : "), ensure_ascii = False) file.close() page = 1 records = {} while (True): page_data = getPage(page) page = page_data["Pagination"]["PageNext"] for job in page_data["Results"]: id = job["ID"] record_data = getItem(id) records[id] = { "abbreviation" : record_data["Abbreviation_en"] } if (page == None or page <= page_data["Pagination"]["Page"]): saveData(records) break ================================================ FILE: scripts/local/effects.py ================================================ import json import os.path import re import shutil from os import path def saveData(effects): with open("../../src/data/game/effects.json", "w", encoding = "utf8") as file: # with open("test/effects.json", "w", encoding = "utf8") as file: json.dump(effects, file, indent = "\t", separators = (",", " : "), ensure_ascii = False) file.close() def saveImage(id): desto = "../../public/img/icons/effects/" + str(id) + ".jpg" # desto = "test/effects/" + str(id) + ".jpg" origin = "data/img/status/" + str(id) + ".png" if (path.exists(desto)): return if (path.exists(origin) == False): return shutil.copyfile(origin, desto) def loadLocal(): with open("data/statuses.json") as file: data = json.load(file) file.close() return data def loadEffects(): with open("../../src/data/game/effects.json") as file: data = json.load(file) file.close() return data def loadDots(): with open("../../src/data/game/dot-jobs.json") as file: data = json.load(file) file.close() return data def loadBuffs(): with open("../../src/data/game/buff-jobs.json") as file: data = json.load(file) file.close() return data def loadDebuffs(): with open("../../src/data/game/debuff-jobs.json") as file: data = json.load(file) file.close() return data def cleanText(s): return re.sub("<[A-Za-z]+/>", "", s) effects = {} local = loadLocal() existing_effects = loadEffects() dots = loadDots() buffs = loadBuffs() debuffs = loadDebuffs() for key in local: record = local[key] id = record["ID"] if str(id) in existing_effects: if (existing_effects[str(id)]["locales"]["name"]["en"] != existing_effects[str(id)]["locales"]["name"]["jp"]): effects[id] = existing_effects[str(id)] continue item_type = "effect" if (record["Name"]["en"] == record["Name"]["ja"]): continue if (record["Category"] == 2): if record["InflictedByActor"] == True: continue elif "over time" not in record["Description"]["en"]: item_type = "debuff" else: item_type = "dot" effects[id] = { "type" : item_type, "dot" : (item_type == "dot"), "debuff" : (item_type == "debuff"), "jobs" : [], "locales" : { "name" : { "en" : cleanText(record["Name"]["en"]), "de" : cleanText(record["Name"]["de"]), "fr" : cleanText(record["Name"]["fr"]), "jp" : cleanText(record["Name"]["ja"]) } } } if record["Name"]["en"] in dots: effects[id]["jobs"] = dots[record["Name"]["en"]] elif record["Name"]["en"] in buffs: effects[id]["jobs"] = buffs[record["Name"]["en"]] elif record["Name"]["en"] in debuffs: effects[id]["jobs"] = debuffs[record["Name"]["en"]] saveImage(id) saveData(effects) ================================================ FILE: scripts/local/instances.py ================================================ import json import os.path import re import shutil from os import path def saveData(instances): with open("../../src/data/game/instances.json", "w", encoding = "utf8") as file: # with open("test/instances.json", "w", encoding = "utf8") as file: json.dump(instances, file, indent = "\t", separators = (",", " : "), ensure_ascii = False) file.close() def loadLocal(): with open("data/instances.json") as file: data = json.load(file) file.close() return data def cleanText(s): return re.sub("<[A-Za-z]+/>", "", s) instances = {} local = loadLocal(); for key in local: record = local[key] id = record["ID"] instances[id] = { "zone_id" : record["ZoneID"], "locales" : { "name" : { "en" : cleanText(record["Name"]["en"]), "de" : cleanText(record["Name"]["de"]), "fr" : cleanText(record["Name"]["fr"]), "jp" : cleanText(record["Name"]["ja"]) } } } saveData(instances) ================================================ FILE: scripts/local/ogcd-skills.py ================================================ import json import os.path import re import shutil from os import path def saveImage(id): desto = "../../public/img/icons/skills/" + str(id) + ".jpg" # desto = "test/skills/" + str(id) + ".jpg" origin = "data/img/action/" + str(id) + ".png" if (path.exists(desto)): return if (path.exists(origin) == False): return shutil.copyfile(origin, desto) def saveData(skills): with open("../../src/data/game/ogcd-skills.json", "w", encoding = "utf8") as file: # with open("test/ogcd-skills.json", "w", encoding = "utf8") as file: json.dump(skills, file, indent = "\t", separators = (",", " : "), ensure_ascii = False) file.close() def loadLocal(): with open("data/actions.json") as file: data = json.load(file) file.close() return data def loadTraits(): with open("data/traits.json") as file: data = json.load(file) file.close() return data def cleanText(s): return re.sub("<[A-Za-z]+/>", "", s) skills = {} recast_traits = {} charge_traits = {} local = loadLocal() local_traits = loadTraits() for key in local_traits: record = local_traits[key] trait_skills = record["Action"].split("::") level = record["Level"] for skill in trait_skills: if record["Type"] == "Recast": recast = int(record["Time"]) / 1.0 if skill not in recast_traits: recast_traits[skill] = [] recast_traits[skill].append({ "level" : level, "recast" : recast }) elif record["Type"] == "Charge": if skill not in charge_traits: charge_traits[skill] = [] charge_traits[skill].append({ "level" : level, "charges" : record["Charges"] }) for key in local: record = local[key] if (record["RecastMs"] < 10000 or record["Jobs"] == ""): continue id = record["ID"] english_name = record["Name"]["en"] classes = record["Jobs"] pvp = ("", " (PVP)")[record["IsPVP"] == True] if cleanText(record["Name"]["en"]) == '': continue skills[id] = { "recast" : record["RecastMs"] / 1000.0, "charges" : record["MaxCharges"], "level_recasts" : sorted(recast_traits[english_name], key = lambda item: item["level"], reverse = True) if english_name in recast_traits else None, "level_charges" : sorted(charge_traits[english_name], key = lambda item: item["level"], reverse = True) if english_name in charge_traits else None, "jobs" : ("*", classes.split())[classes != "All Classes"], "pvp" : record["IsPVP"], "locales" : { "name" : { "en" : cleanText(record["Name"]["en"]) + pvp, "de" : cleanText(record["Name"]["de"]) + pvp, "fr" : cleanText(record["Name"]["fr"]) + pvp, "jp" : cleanText(record["Name"]["ja"]) + pvp } } } saveImage(id) saveData(skills) ================================================ FILE: scripts/local/pvp-zones.py ================================================ import json import os.path import shutil from os import path def saveData(data): with open("../../src/data/game/pvp-zones.json", "w", encoding = "utf8") as file: # with open("test/pvp-zones.json", "w", encoding = "utf8") as file: json.dump(data, file, indent = "\t", separators = (",", " : "), ensure_ascii = False) file.close() def loadLocal(): with open("data/pvp-zones.json") as file: data = json.load(file) file.close() return data records = [] local = loadLocal(); for key in local: record = local[key] records.append(record["ID"]) saveData(records) ================================================ FILE: scripts/local/skill-indirections.py ================================================ import json import os.path import shutil from os import path def saveData(data): with open("../../src/data/game/skill-indirections.json", "w", encoding = "utf8") as file: # with open("test/skill-indirections.json", "w", encoding = "utf8") as file: json.dump(data, file, indent = "\t", separators = (",", " : "), ensure_ascii = False) file.close() def loadLocal(): with open("data/actions.json") as file: data = json.load(file) file.close() return data records = {} local = loadLocal() for key in local: record = local[key] id = record["ID"] if (record["RecastMs"] < 10000 or record["IsPlayerAction"] == True or record["Indirection"] == None or record["Indirection"] == 0): continue previous = local[str(record["Indirection"])] if (previous["RecastMs"] < 10000 or previous["RecastMs"] != record["RecastMs"]): continue records[id] = record["Indirection"] saveData(records) ================================================ FILE: scripts/ogcd-skills.py ================================================ import json import os.path import re import requests import shutil from os import path def getTraitPage(page_num): url = "https://xivapi.com/search?page=" + str(page_num) + "&indexes=Trait&string=recast%20time&string_column=Description_en" res = requests.get(url = url) return res.json() def getActionPage(page_num): url = "https://xivapi.com/search?page=" + str(page_num) + "&filters=ClassJobCategory!,Recast100ms>=100" res = requests.get(url = url) return res.json() def getItem(item_type, id): url = "https://xivapi.com/" + item_type + "/" + str(id) res = requests.get(url = url) return res.json() def saveImage(id, xiv_path): local_path = "../public/img/icons/skills/" + str(id) + ".jpg" if (path.exists(local_path)): return url = "https://xivapi.com/" + xiv_path res = requests.get(url, stream = True) if res.status_code == 200: res.raw.decode_content = True with open(local_path, "wb") as file: shutil.copyfileobj(res.raw, file) file.close() def saveSkills(skills): with open("../src/data/game/ogcd-skills.json", "w", encoding = "utf8") as file: json.dump(skills, file, indent = "\t", separators = (",", " : "), ensure_ascii = False) file.close() page = 1 skills = {} traits = {} while (True): page_data = getTraitPage(page) page = page_data["Pagination"]["PageNext"] for item in page_data["Results"]: id = item["ID"] item_data = getItem("Trait", id) regex = re.compile(r"([:\w ]+)<\/span> recast timer? to (\d+) seconds") match = regex.findall(item_data["Description_en"]) if (len(match) == 0): continue skill = match[0][0] recast = int(match[0][1]) / 1.0 level = item_data["Level"] if skill not in traits: traits[skill] = [] traits[skill].append({ "level" : level, "recast" : recast }) if (page == None or page <= page_data["Pagination"]["Page"]): break while (True): page_data = getActionPage(page) page = page_data["Pagination"]["PageNext"] for item in page_data["Results"]: id = item["ID"] item_data = getItem("Action", id) english_name = item_data["Name_en"] classes = item_data["ClassJobCategory"]["Name_en"] pvp = ("", " (PVP)")[item_data["IsPvP"] == 1] skills[id] = { "recast" : item_data["Recast100ms"] / 10.0, "level_recasts" : sorted(traits[english_name], key = lambda item: item["level"], reverse = True) if english_name in traits else None, "jobs" : ("*", classes.split())[classes != "All Classes"], "pvp" : (False, True)[item_data["IsPvP"] == 1], "locales" : { "name" : { "en" : item_data["Name_en"] + pvp, "de" : item_data["Name_de"] + pvp, "fr" : item_data["Name_fr"] + pvp, "jp" : item_data["Name_ja"] + pvp } } } saveImage(id, item_data["Icon"]) if (page == None or page <= page_data["Pagination"]["Page"]): saveSkills(skills) break ================================================ FILE: scripts/pvp-zones.py ================================================ import json import os.path import requests import shutil from os import path def getPage(page_num): url = "https://xivapi.com/search?page=" + str(page_num) + "&indexes=Map&filters=TerritoryType.IsPvpZone=1" res = requests.get(url = url) return res.json() def getItem(id): url = "https://xivapi.com/Map/" + str(id) res = requests.get(url = url) return res.json() def saveData(data): with open("../src/data/game/pvp-zones.json", "w", encoding = "utf8") as file: json.dump(data, file, indent = "\t", separators = (",", " : "), ensure_ascii = False) file.close() page = 1 records = [] while (True): page_data = getPage(page) page = page_data["Pagination"]["PageNext"] for record in page_data["Results"]: id = record["ID"] record_data = getItem(id) records.append(record_data["TerritoryType"]["ID"]) if (page == None or page <= page_data["Pagination"]["Page"]): saveData(records) break ================================================ FILE: scripts/skill-indirections.py ================================================ import json import os.path import requests import shutil from os import path def getPage(page_num): url = "https://xivapi.com/ActionIndirection?page=" + str(page_num) res = requests.get(url = url) return res.json() def getItem(id): url = "https://xivapi.com/ActionIndirection/" + str(id) res = requests.get(url = url) return res.json() def saveData(data): with open("../src/data/game/skill-indirections.json", "w", encoding = "utf8") as file: json.dump(data, file, indent = "\t", separators = (",", " : "), ensure_ascii = False) file.close() page = 1 records = {} while (True): page_data = getPage(page) page = page_data["Pagination"]["PageNext"] for record in page_data["Results"]: id = record["ID"] record_data = getItem(id) if (record_data["NameTarget"] != "Action" or record_data["NameTargetID"] == None or record_data["NameTargetID"] == 0 or record_data["Name"]["Recast100ms"] < 100): continue if (record_data["PreviousComboActionTarget"] != "Action" or record_data["PreviousComboActionTargetID"] == None or record_data["PreviousComboActionTargetID"] == 0 or record_data["PreviousComboAction"]["Recast100ms"] < 100): continue records[record_data["NameTargetID"]] = record_data["PreviousComboActionTargetID"] if (page == None or page <= page_data["Pagination"]["Page"]): saveData(records) break ================================================ FILE: scripts/traits.py ================================================ import json import re import requests from typing import Dict, List, Optional def getTraitPage(after: int) -> List: url = f'https://beta.xivapi.com/api/1/sheet/Trait?version=6.58x2&limit=500&after={after}' res = requests.get(url = url) return res.json()['rows'] def getTrait(id: int): url = f'https://beta.xivapi.com/api/1/sheet/Trait/{id}?version=6.58x2' res = requests.get(url = url) return res.json()['fields'] def saveTraits(traits): with open("./local/data/traits-api.json", "w", encoding = "utf8") as file: json.dump(traits, file, indent = "\t", separators = (",", " : "), ensure_ascii = False) file.close() def tryRecast(trait: Dict) -> Optional[Dict]: pattern = re.compile(r"([:\w ]+)<\/span> recast timer? to (\d+) seconds") match = pattern.findall(trait['description']) if not match: return None action = match[0][0] recast = int(match[0][1]) return { 'Type': 'Recast', 'Action': action, 'Time': recast, } def tryCharges(trait: Dict) -> Optional[Dict]: data = { 'Type': 'Charge', } pattern = r'a ([\w]+) charge of ([:\w ]+)\.' match = re.findall(pattern, trait['description']) if match: charges = 0 charge_match = match[0][0] if charge_match == 'second': charges = 2 elif charge_match == 'third': charges = 3 elif charge_match == 'fourth': charges = 4 else: raise ValueError(f'Unknown charge match: "{charge_match}"') data['Action'] = match[0][1] data['Charges'] = charges return data pattern = r'accumulation of charges for consecutive uses of ([:\w ]+)\.' match = re.findall(pattern, trait['description']) if match: data['Action'] = match[0][0] pattern = r'Maximum Charges: ([\d]+)' match = re.findall(pattern, trait['description']) data['Charges'] = int(match[0][0]) return data def main(): after = 0 traits = {} while True: rows = getTraitPage(after) if not rows: break for row in traits: trait = getTrait(row['row_id']) data = { 'Level': trait['Level'], } if (recast := tryRecast(trait)) is not None: data.update(recast) elif (charges := tryCharges(trait)) is not None: data.update(charges) else: continue traits[trait['Name']] = data saveTraits(traits) if __name__ == '__main__': main() ================================================ FILE: src/components/EmberComponent.js ================================================ import React from "react"; import isEqual from "lodash.isequal"; class EmberComponent extends React.Component { shouldComponentUpdate(next_props, next_state) { for (const i in this.props) { if (typeof this.props[i] === "function") { continue; } if (typeof this.props[i] !== "object") { if (this.props[i] !== next_props[i]) { return true; } continue; } if (!isEqual(this.props[i], next_props[i])) { return true; } } return !isEqual(this.state, next_state); } } export default EmberComponent; ================================================ FILE: src/components/Parser/AggroTable/Monster.js ================================================ import React from "react"; import PlayerProcessor from "../../../processors/PlayerProcessor"; import MonsterProcessor from "../../../processors/MonsterProcessor"; import PercentBar from "../PercentBar"; class Monster extends React.Component { render() { const fallback_player = { Job : "", Name : "", name : "" }; const monster = this.props.monster; const player = monster.Target || fallback_player; const player_type = (monster._is_current) ? "active" : "other"; const columns = []; const stat_columns = this.props.columns; for (let key of stat_columns) { let processor = MonsterProcessor; let object = monster; const raw_key = key; const name_blur = (this.props.blur && key === "player_Name") ? "blur" : ""; if (key.substring(0, 7) === "player_") { key = key.substring(7); processor = PlayerProcessor; object = player; object[key.toLowerCase()] = object[key]; } let value = processor.getDataValue(key, object); if (key === "health_percent") { columns.push(
); } else { if (raw_key === "player_Name") { let player = this.props.encounter.Combatant[value]; if (monster._is_current && !player) { player = this.props.encounter.Combatant.YOU; } if (!player) { player = fallback_player; } const job = player.Job.toUpperCase(); const icon_blur = (this.props.blur && this.props.icon_blur) ? "blur" : ""; const icon_style = (icon_blur) ? { WebkitFilter : "blur(4px)" } : {}; const icon_image = (job) ? {job : ""; const icon =
{icon_image}
; if (this.props.short_names !== "no_short") { value = PlayerProcessor.getShortName(value, this.props.short_names); } columns.push(icon); } columns.push(
{value}
, ); } } return (
{columns}
); } } export default Monster; ================================================ FILE: src/components/Parser/AggroTable.js ================================================ import React from "react"; import { connect } from "react-redux"; import LocalizationService from "../../services/LocalizationService"; import Monster from "./AggroTable/Monster"; import OverlayInfo from "./PlayerTable/OverlayInfo"; class AggroTable extends React.Component { render() { const header = [
, ]; const rows = []; const player_blur = (this.props.player_blur); const short_names = this.props.table_settings.general.table.short_names; const columns = [ "Name", "health_percent", "CurrentHP", "player_Name", ]; const monsters = (!this.props.encounter.Combatant || this.props.overlayplugin_author !== "ngld") ? [] : this.props.monsters; for (const key of columns) { const title = LocalizationService.getMonsterDataTitle(key, "short"); if (key === "player_Name") { header.push(
, ); } header.push(
{title}
, ); } for (const monster of monsters) { monster._is_current = (monster.Target && monster.Target.isMe); const blur = (player_blur && !monster._is_current); rows.push( , ); } const overlay_info = (this.props.collapsed || (this.props.monsters && this.props.monsters.length)) ? "" : ; return (
{header}
{rows}
{overlay_info} ); } } const mapStateToProps = state => ({ encounter : state.internal.game, overlayplugin_author : state.internal.overlayplugin_author, player_blur : state.settings.intrinsic.player_blur, icon_blur : state.settings.interface.blur_job_icons, table_settings : state.settings.table_settings, collapsed : state.settings.intrinsic.collapsed, }); export default connect(mapStateToProps)(AggroTable); ================================================ FILE: src/components/Parser/Container/DiscordMenu.js ================================================ import React from "react"; import { ContextMenu, MenuItem } from "react-contextmenu"; import DiscordService from "../../../services/DiscordService"; import LocalizationService from "../../../services/LocalizationService"; class DiscordMenu extends React.Component { render() { const options = [ {LocalizationService.getOverlayText("join_discord")} , ]; if (this.props.webhook) { options.push( {LocalizationService.getOverlayText("discord_webhook")} , ); } return (
{options}
); } } export default DiscordMenu; ================================================ FILE: src/components/Parser/Container/EncounterMenu.js ================================================ import React from "react"; import { connect } from "react-redux"; import { ContextMenu, MenuItem } from "react-contextmenu"; import { loadHistoryEntry } from "../../../redux/actions/index"; class EncounterMenu extends React.Component { render() { const options = []; let i = 0; for (const encounter of this.props.history) { if (!encounter.game.Encounter) { continue; } let title = []; title.push((encounter.game.Encounter.title !== "Encounter") ? encounter.game.Encounter.title : encounter.game.Encounter.CurrentZoneName); title.push(encounter.game.Encounter.duration); title = title.join(" - "); options.push( {title} , ); i++; } if (!options.length) { options.push( No encounters available. , ); } return (
{options}
); } loadHistoryEntry(index) { this.props.loadHistoryEntry(index); } } const mapDispatchToProps = dispatch => ({ loadHistoryEntry(data) { dispatch(loadHistoryEntry(data)); }, }); const mapStateToProps = state => ({ history : state.internal.encounter_history, }); export default connect(mapStateToProps, mapDispatchToProps)(EncounterMenu); ================================================ FILE: src/components/Parser/Container/IconButton.js ================================================ import React from "react"; import { Icon } from "semantic-ui-react"; import ReactTooltip from "react-tooltip"; class IconButton extends React.Component { componentDidMount() { ReactTooltip.rebuild(); } render() { const icon_attributes = { name : this.props.icon, alt : this.props.title, "data-tip" : this.props.title, title : this.props.title, }; if (this.props.no_container) { icon_attributes.onClick = this.props.onClick; } const additional_class = this.props.class || ""; const icon = ; return ( (this.props.no_container) ? icon :
{icon}
); } } export default IconButton; ================================================ FILE: src/components/Parser/Container/Import.js ================================================ import React from "react"; import { connect } from "react-redux"; import { Form, Input, Button } from "semantic-ui-react"; import $ from "jquery"; import LocalizationService from "../../../services/LocalizationService"; class Import extends React.Component { render() { const allow_overlayplugin_import = (this.props.plugin_service.is_websocket && this.props.author === "ngld"); const overlayplugin_button = (!allow_overlayplugin_import) ? "" : ; const overlayplugin_text = (!allow_overlayplugin_import) ? "" : (

Ember has detected you are using OverlayPlugin. You can attempt to import automatically from OverlayPlugin by clicking "{LocalizationService.getOverlayText("import")} from OverlayPlugin" below. Otherwise, follow the import steps as normal.

); return (
{LocalizationService.getOverlayText("import_settings")}
{overlayplugin_text}

{LocalizationService.getOverlayText("import_instructions")}

{overlayplugin_button}
); } getButtons() { return $(document).find("button.import"); } getButton(e) { return $(e.target); } getInput(e, button) { const $button = button || this.getButton(e); return $button.closest(".field").find("input"); } handlePaste(e) { const $input = this.getInput(e); $input[0].focus(); document.execCommand("paste"); } enableButtons($clicked_button, button_text) { const $buttons = this.getButtons(); $clicked_button.text(button_text); $buttons.attr("disabled", false); } handleImport(overlayplugin, event) { const $button = this.getButton(event); const $buttons = this.getButtons(); const value = this.getInput(event, $button).val(); const initial_text = $button.text(); let promise = null; $buttons.attr("disabled", true); $button.text("Importing..."); if (!overlayplugin) { promise = this.props.settings_data.importSettings(value); } else { promise = this.props.settings_data.restoreFromOverlayPlugin(); } promise .then(() => { $button.text("Imported!"); setTimeout(this.enableButtons.bind(this, $button, initial_text), 4000); }) .catch(e => { console.error(JSON.stringify(e)); $button.text("Import has failed..."); setTimeout(this.enableButtons.bind(this, $button, initial_text), 4000); }); } } const mapStateToProps = state => ({ author : state.internal.overlayplugin_author, language : state.settings.interface.language, settings_data : state.settings_data, plugin_service : state.plugin_service, }); export default connect(mapStateToProps)(Import); ================================================ FILE: src/components/Parser/Container/Menu.js ================================================ import React from "react"; import { connect } from "react-redux"; import { ContextMenu, MenuItem } from "react-contextmenu"; import { changeCollapse, loadSampleGameData, clearGameData, changeViewing, changeDetailPlayer, changeMode, changeUIBuilder } from "../../../redux/actions/index"; import SettingsService from "../../../services/SettingsService"; import LocalizationService from "../../../services/LocalizationService"; class Menu extends React.Component { render() { return (
{this.getModesSection()} {this.getQuickCommandsSection()} {this.getEncounterSection()} {this.getUIBuilderSection()} {LocalizationService.getOverlayText("settings")} {LocalizationService.getOverlayText("import")}
); } getUIBuilderSection() { if (this.props.overlayplugin_author !== "ngld" || !this.props.use_ui_builder || this.props.mode !== "spells") { return; } const text = (this.props.ui_builder) ? LocalizationService.getMisc("save_ui") : LocalizationService.getMisc("edit_ui"); const items = [ {text} ,
, ]; return items; } getModesSection() { if (this.props.overlayplugin_author !== "ngld") { return; } const mode_text = LocalizationService.getOverlayText("mode"); const modes = [ {mode_text}: {LocalizationService.getOverlayText("parser")} , {mode_text}: {LocalizationService.getOverlayText("spell_timers")} ,
, ]; return modes; } getQuickCommandsSection() { const plugin_service = this.props.plugin_service; const collapse_item = () => { if (this.props.mode === "spells") { return ""; } const text = LocalizationService.getOverlayText((this.props.collapsed) ? "uncollapse" : "collapse"); const data = { state : !this.props.collapsed }; return ( {text} ); }; const plugin_actions = () => { if (this.props.mode === "spells") { return ""; } return ( {LocalizationService.getOverlayText("split_encounter")} ); }; const items = [collapse_item(), plugin_actions()].filter(x => Boolean(x)); if (items.length) { items.push(
); } return items; } getEncounterSection() { const items = []; if (this.props.mode === "stats") { items.push( {LocalizationService.getOverlayText("view_encounter")} , ); } items.push( {LocalizationService.getOverlayText("load_sample")} , ); if (this.props.mode === "stats") { items.push( {LocalizationService.getOverlayText("clear_encounter")} , ); } items.push(
); return items; } changeCollapse(e, data) { this.props.changeCollapse(data.state); } loadSampleGameData() { this.props.loadSampleGameData(); } clearGameData() { this.props.clearGameData(); } changeMode(mode) { this.props.changeMode(mode); } changeViewing(type, player) { if (!player) { return; } this.props.changeViewing(type); this.props.changeDetailPlayer(player); } changeUIBuilder() { this.props.changeUIBuilder(this.props.getUIData()); } } const mapDispatchToProps = dispatch => ({ changeCollapse(data) { dispatch(changeCollapse(data)); }, loadSampleGameData() { dispatch(loadSampleGameData()); }, clearGameData() { dispatch(clearGameData()); }, changeViewing(data) { dispatch(changeViewing(data)); }, changeDetailPlayer(data) { dispatch(changeDetailPlayer(data)); }, changeMode(data) { dispatch(changeMode(data)); }, changeUIBuilder(data) { dispatch(changeUIBuilder(data)); }, }); const mapStateToProps = state => ({ plugin_service : state.plugin_service, language : state.settings.interface.language, collapsed : state.settings.intrinsic.collapsed, overlayplugin : state.internal.overlayplugin, overlayplugin_author : state.internal.overlayplugin_author, encounter : state.internal.game.Encounter, mode : state.internal.mode, ui_builder : state.internal.ui_builder, use_ui_builder : state.settings.spells_mode.ui.use, }); export default connect(mapStateToProps, mapDispatchToProps)(Menu); ================================================ FILE: src/components/Parser/Container.js ================================================ import React from "react"; import { connect } from "react-redux"; import { ContextMenuTrigger } from "react-contextmenu"; import ReactTooltip from "react-tooltip"; import { Rnd } from "react-rnd"; import clone from "lodash.clonedeep"; import isEqual from "lodash.isequal"; import { updateSetting } from "../../redux/actions/index"; import EmberComponent from "../EmberComponent"; import ContextMenu from "./Container/Menu"; import Import from "./Container/Import"; import GameState from "./GameState"; import PlayerTable from "./PlayerTable"; import PlayerDetail from "./PlayerDetail"; import Footer from "./Footer"; import PlaceholderToggle from "./Placeholder/Toggle"; import AggroTable from "./AggroTable"; import SpellGrid from "./SpellGrid"; import SpellService from "../../services/SpellService"; import TTSService from "../../services/TTSService"; import LocalizationService from "../../services/LocalizationService"; class Container extends EmberComponent { constructor(props) { super(props); this.timer = null; this.no_footer_modes = [ "spells", ]; this.mounted = false; this.state = { locked : true, spells_sections : this.props.spells_sections, spells : (new Date()).getTime(), }; } componentDidUpdate(prev_props) { let need_state = false; const state = {}; if (this.processSpellSectionProps(state)) { need_state = true; } if (prev_props.mode !== this.props.mode) { this.stopAll(); if (this.props.mode === "spells") { need_state = true; state.spells = (new Date()).getTime(); this.startSpells(); } else if (this.props.mode === "stats") { this.startStats(); } } else if (this.props.mode === "spells") { this.setSpellsSettings(); let new_spells = false; let lost_spells = false; let changed_default = false; for (const i in this.props.spells_in_use) { if ( !prev_props.spells_in_use[i] || prev_props.spells_in_use[i].time < this.props.spells_in_use[i].time || !SpellService.hasDefaultedSpell(i, this.props.spells_in_use[i]) ) { if (!new_spells) { new_spells = {}; } new_spells[i] = this.props.spells_in_use[i]; } else if ( prev_props.spells_in_use[i].defaulted !== this.props.spells_in_use[i].defaulted || prev_props.spells_in_use[i].type_position !== this.props.spells_in_use[i].type_position ) { if (!changed_default) { changed_default = {}; } changed_default[i] = { defaulted : this.props.spells_in_use[i].defaulted, position : this.props.spells_in_use[i].type_position, }; } } for (const i in prev_props.spells_in_use) { if (!this.props.spells_in_use[i]) { if (!lost_spells) { lost_spells = {}; } lost_spells[i] = true; } } if (new_spells || lost_spells || changed_default) { need_state = true; SpellService.processSpells(new_spells || {}, lost_spells || {}, changed_default || {}); state.spells = (new Date()).getTime(); } } if (need_state) { this.setState(state); } } componentDidMount() { if (this.props.mode === "stats") { this.startStats(); } else if (this.props.mode === "spells") { SpellService.processSpells(this.props.spells_in_use); this.startSpells(); this.setState({ spells : (new Date()).getTime(), }); } document.addEventListener("onOverlayStateUpdate", this.toggleHandle.bind(this)); this.props.plugin_service.subscribe(); this.mounted = true; } clearTimer() { if (this.timer !== null) { clearInterval(this.timer); this.timer = null; } } startStats() { TTSService.start(); } startSpells() { this.setSpellsSettings(); this.timer = setInterval( () => { if (!SpellService.updateCooldowns()) { return; } this.setState({ spells : (new Date()).getTime(), }); }, 250, ); } stopAll() { this.clearTimer(); TTSService.stop(); SpellService.stop(); } setSpellsSettings() { SpellService.setSettings( this.props.spells_settings.use_tts, this.props.spells_settings.party_use_tts, this.props.spells_settings.tts_trigger, this.props.spells_settings.warning_threshold, this.props.spells_settings.tts_on_effect, this.props.spells_settings.party_tts_on_effect, this.props.spells_settings.party_tts_on_skill, ); } render() { const encounter = this.props.encounter || {}; const active = (["true", true].indexOf(this.props.encounter_active) !== -1); const viewing = this.props.viewing; let content; switch (this.props.mode) { case "stats": switch (viewing) { case "tables": if (this.props.table_type !== "aggro") { content = ; } else { content = ; } break; case "player": content = ; break; case "import": content = ; break; default: break; } break; case "spells": switch (viewing) { case "import": content = ; break; default: const settings = this.props.spells_settings; const invert_vertical = settings.invert_vertical; if (this.props.spells_settings.ui.use) { content = []; for (const uuid in this.props.spells_sections) { const section = this.state.spells_sections[uuid]; if (!section) { continue; } const section_settings = clone(settings); const layout = section.layout; if (layout.spells_per_row !== -1) { section_settings.spells_per_row = layout.spells_per_row; } if (layout.layout !== "default") { section_settings.layout = layout.layout; } section_settings.uuid = uuid; if (this.props.ui_builder) { if (this.state.locked) { content.push( , ); } else { content =
{LocalizationService.getMisc("please_lock")}
; break; } } else { const spells = SpellService.filterSpells(section, section_settings, true); const css = { position : "absolute", top : layout.y + "px", left : layout.x + "px", width : layout.width + "px", maxHeight : layout.height + "px" }; if (invert_vertical) { css.height = layout.height + "px"; } content.push( , ); } } } else { const spells = SpellService.filterSpells({}, settings, false); content = ; } break; } break; default: break; } let footer = []; if ( this.no_footer_modes.indexOf(this.props.mode) === -1 && ( !this.props.collapsed || viewing !== "tables" || this.props.footer_when_collapsed ) ) { footer = [
,