Skip to content

Commit

Permalink
resources/docs: change quisquous => OverlayPlugin
Browse files Browse the repository at this point in the history
  • Loading branch information
quisquous committed Dec 21, 2023
1 parent 4c5cf21 commit 47c5f40
Show file tree
Hide file tree
Showing 39 changed files with 241 additions and 230 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ assignees: ''
Please include as much information as possible, this information allows cactbot maintainers to diagnose (and fix!) your issue as quickly as possible.
Useful Links:
- Common Issues and Workarounds: https://github.com/quisquous/cactbot#potential-errors-and-workarounds
- Common Issues and Workarounds: https://github.com/OverlayPlugin/cactbot#potential-errors-and-workarounds
- ACT Discord: https://discord.gg/ahFKcmx
Before opening a new issue, please search existing issues: https://github.com/quisquous/cactbot/issues
Before opening a new issue, please search existing issues: https://github.com/OverlayPlugin/cactbot/issues
-->

## Description
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ assignees: ''
Please include as much information as possible, such as example behavior and motivation behind the change.
Useful Links:
- Contribution Guidelines: https://github.com/quisquous/cactbot/blob/main/CONTRIBUTING.md
- Code of Conduct: https://github.com/quisquous/cactbot/blob/main/CODE_OF_CONDUCT.md
- Contribution Guidelines: https://github.com/OverlayPlugin/cactbot/blob/main/CONTRIBUTING.md
- Code of Conduct: https://github.com/OverlayPlugin/cactbot/blob/main/CODE_OF_CONDUCT.md
Before opening a new issue, please search existing issues: https://github.com/quisquous/cactbot/issues
Before opening a new issue, please search existing issues: https://github.com/OverlayPlugin/cactbot/issues
Please note: Not every feature request will be added to cactbot, but hearing about what you want out of cactbot is important. Please don't be afraid to add a feature request!
-->
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ assignees: ''

<!--
NOTE: GitHub issues are NOT the recommended method of asking general questions about cactbot.
General questions are allowed but generally discouraged due to adding noise to the project's issue page. Please look at the documentation below or join the ACT Discord for any generic questions or reach out in a related issue. If all else fails, please open an issue here.
Useful Links:
- Common Issues and Workarounds: https://github.com/quisquous/cactbot#potential-errors-and-workarounds
- Common Issues and Workarounds: https://github.com/OverlayPlugin/cactbot#potential-errors-and-workarounds
- ACT Discord: https://discord.gg/ahFKcmx
Before opening a new issue, please search existing issues: https://github.com/quisquous/cactbot/issues
Before opening a new issue, please search existing issues: https://github.com/OverlayPlugin/cactbot/issues
-->

## Question
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ These workflows should appear within pull requests as status indicators
that denote "pending”, “success”, “failure”, or “error",
and should contain detail links to view the workflows and their individual steps therein.
Additionally, these workflow runs should be visible by clicking
the [Actions](https://github.com/quisquous/cactbot/actions) tab
the [Actions](https://github.com/OverlayPlugin/cactbot/actions) tab
in the repository's menu at the top of the repository's main page.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The code of conduct for cactbot can be found here:

Please file all issues with cactbot on github,
via this url:
<https://github.com/quisquous/cactbot/issues/new/choose>
<https://github.com/OverlayPlugin/cactbot/issues/new/choose>

## Pull Requests

Expand Down Expand Up @@ -138,7 +138,7 @@ In order to use the main cactbot repository as your cactbot's source URL,
simply enter the cactbot module's full HTML filepath
instead of the HTML file included in the cactbot download.

For example, <https://quisquous.github.io/cactbot/ui/raidboss/raidboss.html>
For example, <https://overlayplugin.github.io/cactbot/ui/raidboss/raidboss.html>
will use the latest changes for the `raidboss` module pushed to GitHub.

When making changes, it may be helpful to reference your personal fork
Expand Down Expand Up @@ -229,7 +229,7 @@ the complete list of commands being run in CI are found within
and can be run locally without needing to commit changes just to test them.
If it is not obvious *which* command is failing,
you can click the workflow in the
[GitHub Actions](https://github.com/quisquous/cactbot/actions)
[GitHub Actions](https://github.com/OverlayPlugin/cactbot/actions)
page and click `Workflow file` to see the exact list of commands being run.
The majority of this file is setting up the workflow runner, and the command
that is failing is most likely going to be found at the bottom,
Expand All @@ -246,8 +246,8 @@ If you are wondering how to contribute to cactbot,
here's a set of features that will almost always be needed:

* fixing bugs
* [issues marked "help wanted"](https://github.com/quisquous/cactbot/issues?utf8=%E2%9C%93&q=label%3A%22help+wanted%22)
* [adding missing timelines](https://github.com/quisquous/cactbot/issues/414)
* [issues marked "help wanted"](https://github.com/OverlayPlugin/cactbot/issues?utf8=%E2%9C%93&q=label%3A%22help+wanted%22)
* [adding missing timelines](https://github.com/OverlayPlugin/cactbot/issues/414)
* missing translations
* [trigger future work](docs/RaidbossGuide.md#future-work)
* [timeline future work](docs/TimelineGuide.md#future-work)
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2017-2021 https://github.com/quisquous/cactbot
Copyright 2017-2023 https://github.com/OverlayPlugin/cactbot

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

<img align="right" src="https://raw.githubusercontent.com/quisquous/cactbot/main/screenshots/cactbot-logo-320x320.png">

[![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/quisquous/cactbot/test.yml?branch=main)](https://github.com/quisquous/cactbot/actions?query=workflow%3ATest+branch%3Amain)
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/quisquous/cactbot?color=brightgreen&sort=semver)](https://github.com/quisquous/cactbot/releases/latest)
[![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/quisquous/cactbot/test.yml?branch=main)](https://github.com/OverlayPlugin/cactbot/actions?query=workflow%3ATest+branch%3Amain)
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/quisquous/cactbot?color=brightgreen&sort=semver)](https://github.com/OverlayPlugin/cactbot/releases/latest)

🌎 [**English**] [[简体中文](docs/zh-CN/README.md)] [[한국어](docs/ko-KR/README.md)]

Expand Down Expand Up @@ -263,7 +263,7 @@ timeline, or come from log messages that occur in the game, similar to ACT's "Cu
The overlay is designed to look and feel similar to the
[BigWigs Bossmods](https://www.curseforge.com/wow/addons/big-wigs) addon for World of Warcraft.

[This page](https://quisquous.github.io/cactbot/util/coverage/coverage.html) lists
[This page](https://overlayplugin.github.io/cactbot/util/coverage/coverage.html) lists
the currently supported set of content in cactbot.
Support is continually added over time (patches welcome!)
but a lot of old content may not be supported yet.
Expand Down Expand Up @@ -302,10 +302,10 @@ you can start a local development server via `npm run start`
and load the overlay in Chrome via `http://127.0.0.1:8080/ui/raidboss/raidemulator.html?OVERLAY_WS=ws://127.0.0.1:10501/ws`

If you're developing user triggers,
you can load the overlay in Chrome via `https://quisquous.github.io/cactbot/ui/raidboss/raidemulator.html?OVERLAY_WS=ws://127.0.0.1:10501/ws`
you can load the overlay in Chrome via `https://overlayplugin.github.io/cactbot/ui/raidboss/raidemulator.html?OVERLAY_WS=ws://127.0.0.1:10501/ws`

If you're trying to reproduce an issue,
you can load the overlay in Chrome via `https://quisquous.github.io/cactbot/ui/raidboss/raidemulator.html`.
you can load the overlay in Chrome via `https://overlayplugin.github.io/cactbot/ui/raidboss/raidemulator.html`.
You don't need the WS Server running in this case.

Once you've got the overlay loaded, you can follow these instructions to use the emulator.
Expand Down Expand Up @@ -518,7 +518,7 @@ international (English, German, French, Japanese) version,
the current Chinese version,
and the current Korean version.
Some translations are still a work in progress.
See the [cactbot coverage page](https://quisquous.github.io/cactbot/util/coverage/coverage.html) for more details.
See the [cactbot coverage page](https://overlayplugin.github.io/cactbot/util/coverage/coverage.html) for more details.

## Licensing, Trademarks, Copyright

Expand Down
10 changes: 5 additions & 5 deletions docs/CactbotCustomization.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ ACT -> Plugins -> OverlayPlugin.dll -> your overlay -> Open DevTools.
This is because they use custom elements,
and they don't expose a lot of knobs to tune.
If you have particular things you want to change about the timeline bars that you can't,
please feel free to submit a [github issue](https://github.com/quisquous/cactbot/issues/new/choose).
please feel free to submit a [github issue](https://github.com/OverlayPlugin/cactbot/issues/new/choose).

**Warning**: cactbot makes no guarantees about preserving CSS backwards compatability.
Future changes to cactbot may rearrange elements,
Expand All @@ -203,7 +203,7 @@ and how long they stay on screen,
and anything else.

You can see readable JavaScript versions of all of the cactbot triggers
in this branch: <https://github.com/quisquous/cactbot/tree/triggers>
in this branch: <https://github.com/OverlayPlugin/cactbot/tree/triggers>
This is the preferred reference to use for viewing, copying, and pasting.
Triggers in the main branch
or shipped in a cactbot release are often in unreadable bundles
Expand Down Expand Up @@ -243,7 +243,7 @@ Modify the `zoneId` line to have the zone id for the zone you care about,
usually from the top of the cactbot trigger file.
[This file](../resources/zone_id.ts) has a list of all the zone ids.
If you specify one incorrectly, you will get a warning in the OverlayPlugin log window.
Then, [copy the trigger text](https://github.com/quisquous/cactbot/tree/triggers) into this block.
Then, [copy the trigger text](https://github.com/OverlayPlugin/cactbot/tree/triggers) into this block.
Edit as needed.
Repeat for all the triggers you want to modify.
Reload your raidboss overlay to apply your changes.
Expand All @@ -266,7 +266,7 @@ you could do this via [Changing Trigger Text with the cactbot UI](#changing-trig

One way to adjust this is to edit the trigger output for this trigger.
You can find the original fireball #1 trigger in
[ui/raidboss/data/04-sb/ultimate/unending_coil_ultimate.js](https://github.com/quisquous/cactbot/blob/triggers/04-sb/ultimate/unending_coil_ultimate.js#:~:text=UCU%20Nael%20Fireball%201).
[ui/raidboss/data/04-sb/ultimate/unending_coil_ultimate.js](https://github.com/OverlayPlugin/cactbot/blob/triggers/04-sb/ultimate/unending_coil_ultimate.js#:~:text=UCU%20Nael%20Fireball%201).

This chunk of code is what you would paste into the bottom of your user-defined js file.

Expand Down Expand Up @@ -301,7 +301,7 @@ This edit also removed languages other than English.
Currently, provoke only works for players in your alliance and not for all jobs.
This example shows how to make it work for all players.
The provoke trigger can be found in
[ui/raidboss/data/00-misc/general.js](https://github.com/quisquous/cactbot/blob/triggers/00-misc/general.js#:~:text=General%20Provoke).
[ui/raidboss/data/00-misc/general.js](https://github.com/OverlayPlugin/cactbot/blob/triggers/00-misc/general.js#:~:text=General%20Provoke).

Here is a modified version with a different `condition` function.
Because this shares the same `General Provoke` id with the built-in cactbot trigger,
Expand Down
10 changes: 5 additions & 5 deletions docs/FAQ-Troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ It takes time and effort to add support for new content to cactbot.
If it just came out in the last week or few,
it's possible that there is not support for it yet.

Check <https://quisquous.github.io/cactbot/util/coverage/coverage.html> for the latest list of supported content.
Check <https://overlayplugin.github.io/cactbot/util/coverage/coverage.html> for the latest list of supported content.
It is possible that support for content has been added to cactbot but not released.
You can check the release notes for more details.

Expand Down Expand Up @@ -248,10 +248,10 @@ If you get an error in the OverlayPlugin console similar to `System.MissingMetho
If you get an error that says `Plugin Load Failure` and `The downloaded file did not contain a plugin that could be loaded`,
there could be several potential issues.

- Make sure you have [installed OverlayPlugin](https://github.com/quisquous/cactbot#install-overlayplugin).
- Make sure you have [installed OverlayPlugin](https://github.com/OverlayPlugin/cactbot#install-overlayplugin).
- Check your OverlayPlugin version in **Plugins** -> **Plugin Listing** -> **OverlayPlugin.dll**.
If this is not the same version as [this release](https://github.com/OverlayPlugin/OverlayPlugin/releases/latest),
then remove it and re-follow the [installation instructions](https://github.com/quisquous/cactbot#install-overlayplugin).
then remove it and re-follow the [installation instructions](https://github.com/OverlayPlugin/cactbot#install-overlayplugin).
- Make sure you are running x64 ACT (`Advanced Combat Tracker.exe`) and not x86 ACT (`ACTx86.exe`).
- Finally, make sure you have reloaded ACT once you have installed OverlayPlugin.

Expand All @@ -278,7 +278,7 @@ See: [Fixing Chat Log Problems](#fixing-chat-log-problems).
## Places to Get Help

- ask in the [FFXIV ACT discord](https://discord.gg/ahFKcmx) #troubleshooting channel
- open a [github issue](https://github.com/quisquous/cactbot/issues)
- open a [github issue](https://github.com/OverlayPlugin/cactbot/issues)

It is highly recommended that you ask in the FFXIV ACT discord first for most troubleshooting issues.
You should also read the #troubleshooting channel pins first.
Expand Down Expand Up @@ -312,7 +312,7 @@ upload the files there,
and then attach the link.

If you want to split a log to only include a particular fight,
you can use the [log splitter](https://quisquous.github.io/cactbot/util/logtools/splitter.html)
you can use the [log splitter](https://overlayplugin.github.io/cactbot/util/logtools/splitter.html)
by dragging a network log file to the page and selecting the fights you want.

If you are trying to debug something, it is usually better to not split the log.
8 changes: 4 additions & 4 deletions docs/Headmarkers.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,15 @@ and then comparing to the expected first headmarker to calculate the offset.

If the encounter does not have headmarker offsets,
please use headmarker ids directly in triggers,
e.g. [p9n](https://github.com/quisquous/cactbot/blob/7b904e35c7d678013d229080c858f19d35510ac1/ui/raidboss/data/06-ew/raid/p9n.ts#L33-L38).
e.g. [p9n](https://github.com/OverlayPlugin/cactbot/blob/7b904e35c7d678013d229080c858f19d35510ac1/ui/raidboss/data/06-ew/raid/p9n.ts#L33-L38).

### Same first headmarker

Most of the time,
if the encounter does have headmarker offsets,
the first headmarker id will always be the same.

Most trigger sets do something like [p11s](https://github.com/quisquous/cactbot/blob/3ca3589/ui/raidboss/data/06-ew/raid/p11s.ts).
Most trigger sets do something like [p11s](https://github.com/OverlayPlugin/cactbot/blob/3ca3589/ui/raidboss/data/06-ew/raid/p11s.ts).

There's a helper function to set the headmarker offset if it's not found,
and return the true headmarker id.
Expand Down Expand Up @@ -108,7 +108,7 @@ In rare cases, the first headmarker is not consistent.
As cactbot resets all trigger info (including recorded headmarker offset) on wipe,
any trigger file must handle the first headmarker from any door boss and final boss simultaneously.
For example, [P12S](https://github.com/quisquous/cactbot/blob/4700770/ui/raidboss/data/06-ew/raid/p12s.ts#L159-L179)
For example, [P12S](https://github.com/OverlayPlugin/cactbot/blob/4700770/ui/raidboss/data/06-ew/raid/p12s.ts#L159-L179)
has a door boss with two different first headmarkers (bottom left / bottom right wing)
and a final boss with one first headmarker.
Expand All @@ -124,7 +124,7 @@ or alternatively you can browse the Lockon table online here: <https://github.co
Headmarkers are 2 byte hex values,
and the `key` field in the `Lockon` is the decimal representation of that hex value.
Here is some code from: <https://github.com/quisquous/cactbot/blob/main/ui/raidboss/data/06-ew/raid/p9s.ts>
Here is some code from: <https://github.com/OverlayPlugin/cactbot/blob/main/ui/raidboss/data/06-ew/raid/p9s.ts>
```typescript
const headmarkers = {
Expand Down
2 changes: 1 addition & 1 deletion docs/LogGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -1567,7 +1567,7 @@ Interpreting these [values](https://github.com/goaaats/Dalamud/blob/4ad5bee0c621

There are a number of references for job gauge memory:

1) [cactbot FFXIVProcess code](https://github.com/quisquous/cactbot/blob/a4d27eca3628d397cb9f5638fad97191566ed5a1/CactbotOverlay/FFXIVProcessIntl.cs#L267)
1) [cactbot FFXIVProcess code](https://github.com/OverlayPlugin/cactbot/blob/a4d27eca3628d397cb9f5638fad97191566ed5a1/CactbotOverlay/FFXIVProcessIntl.cs#L267)
1) [Dalamud code](https://github.com/goaaats/Dalamud/blob/4ad5bee0c62128315b0a247466d28f42264c3069/Dalamud/Game/ClientState/Structs/JobGauge/NINGauge.cs#L15)

Unfortunately, network data about other player's gauge is not sent.
Expand Down
2 changes: 1 addition & 1 deletion docs/MemorySignatures.md
Original file line number Diff line number Diff line change
Expand Up @@ -360,7 +360,7 @@ Thus, our final signature is: `488B0D????????4885C974B8488B05`

The address that contains the pointer we care about is the four bytes in the question mark.

You can see this [in cactbot itself](https://github.com/quisquous/cactbot/blob/df176c4feff81bab356a8e5e6e6b453e94626320/CactbotOverlay/FFXIVProcess.cs#L189).
You can see this [in cactbot itself](https://github.com/OverlayPlugin/cactbot/blob/df176c4feff81bab356a8e5e6e6b453e94626320/CactbotOverlay/FFXIVProcess.cs#L189).

It's important to do a [scan for existing memory signatures](#scan-for-existing-memory-signatures) to make sure that this signature is unique.

Expand Down
Loading

0 comments on commit 47c5f40

Please sign in to comment.