Skip to content

Commit

Permalink
docs: cleanup old links (#561)
Browse files Browse the repository at this point in the history
Cleans up some old links to the quisquous repository, and some old
directory paths.
  • Loading branch information
xiashtra authored Jan 12, 2025
1 parent 2eb5326 commit 465a519
Show file tree
Hide file tree
Showing 13 changed files with 46 additions and 32 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Select `Cactbot` and then click `Download and Enable`.
![cactbot selection screenshot](screenshots/get_plugins_cactbot.png)

This will download the cactbot into
`%APPDATA%\Advanced Combat Tracker\Plugins\cactbot-version\cactbot`
`%APPDATA%\Advanced Combat Tracker\Plugins\cactbot\cactbot`
and enable `CactbotOverlay.dll` in the list of plugins.

### Plugin Load Order
Expand Down Expand Up @@ -247,7 +247,7 @@ for more details about using Webpack.

The [ui/](ui/) directory contains cactbot's overlays.
If you installed cactbot following the instructions above,
this will most likely be `%APPDATA%\Advanced Combat Tracker\Plugins\cactbot-version\cactbot\ui\`.
this will most likely be `%APPDATA%\Advanced Combat Tracker\Plugins\cactbot\cactbot\ui\`.

Each cactbot overlay should be added as a separate overlay.
See the [Adding Overlays](#adding-overlays) section for more details about setup.
Expand Down
2 changes: 1 addition & 1 deletion docs/CactbotCustomization.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ If you haven't selected one,
it will try to select one based on where you have installed cactbot on disk.

Ideally, you should select the `cactbot/user` folder from your cactbot installation.
This is often in `%APPDATA%\Advanced Combat Tracker\Plugins\cactbot-version\cactbot\user`.
This is often in `%APPDATA%\Advanced Combat Tracker\Plugins\cactbot\cactbot\user`.
[This folder](../user) has example customization files.

## Customizing Appearance
Expand Down
2 changes: 1 addition & 1 deletion docs/ko-KR/CactbotCustomization.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ ACT -> Plugins -> OverlayPlugin.dll -> Cactbot -> Cactbot 사용자 디렉토리
cactbot이 설치된 경로가 기본값으로 설정됩니다.

가능하면 cactbot이 설치된 `cactbot/user`를 사용하는 것이 좋습니다.
보통은 `%APPDATA%\Advanced Combat Tracker\Plugins\cactbot-version\cactbot\user`
보통은 `%APPDATA%\Advanced Combat Tracker\Plugins\cactbot\cactbot\user`
(해루봇을 사용한다면, `ACT 설치 경로\Plugins\cactbot\user`)입니다.

하지만 해루봇을 사용하신다면, cactbot 업데이트시 cactbot 폴더 내 내용이
Expand Down
4 changes: 2 additions & 2 deletions docs/ko-KR/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Startup Wizard에서,
![cactbot selection 스크린샷](../../screenshots/get_plugins_cactbot.png)

이렇게 해서 cactbot을
`%APPDATA%\Advanced Combat Tracker\Plugins\cactbot-version\cactbot`에 다운로드하고
`%APPDATA%\Advanced Combat Tracker\Plugins\cactbot\cactbot`에 다운로드하고
`CactbotOverlay.dll`을 플러그인 리스트에서 활성화합니다.

**참고**: ACT가 기대하는 압축 파일 구조와
Expand Down Expand Up @@ -246,7 +246,7 @@ Webpack에 대해 더 자세히 알고 싶다면

[ui/](../../ui/) 디렉토리는 cactbot의 ui 모듈을 가지고 있습니다.
만약 cactbot을 상기 설명에 따라 설치했다면,
이 디렉토리는 `%APPDATA%\Advanced Combat Tracker\Plugins\cactbot-version\cactbot\ui\`에 있을 것입니다.
이 디렉토리는 `%APPDATA%\Advanced Combat Tracker\Plugins\cactbot\cactbot\ui\`에 있을 것입니다.

각각의 cactbot ui 모듈은 분리된 오버레이로 따로 추가해야 합니다.
더욱 자세한 오버레이 설치 방법을 확인하려면 [오버레이 모듈 추가하기](#오버레이-모듈-추가하기) 문단을 확인하세요.
Expand Down
2 changes: 1 addition & 1 deletion docs/zh-CN/CactbotCustomization.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Cactbot 将按照字母顺序优先加载用户文件夹中的子文件夹里的

如果没有选择,Cactbot 将自动选择其安装目录下的默认文件夹。

建议你选择 Cactbot 安装目录下的 `cactbot/user` 文件夹。该文件夹通常为位于 `%APPDATA%\Advanced Combat Tracker\Plugins\cactbot-version\cactbot\user`。 有部分示例配置文件位于 [此文件夹](../../user) 下。
建议你选择 Cactbot 安装目录下的 `cactbot/user` 文件夹。该文件夹通常为位于 `%APPDATA%\Advanced Combat Tracker\Plugins\cactbot\cactbot\user`。 有部分示例配置文件位于 [此文件夹](../../user) 下。

## 样式自定义

Expand Down
4 changes: 2 additions & 2 deletions docs/zh-CN/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Cactbot 提供以下悬浮窗:

![Cactbot 选择屏幕截图](../../screenshots/get_plugins_cactbot.png)

这会将 Cactbot 下载到 `%APPDATA%\Advanced Combat Tracker\Plugins\Cactbot-version\Cactbot` 文件夹中,并在插件列表中启用 `CactbotOverlay.dll`
这会将 Cactbot 下载到 `%APPDATA%\Advanced Combat Tracker\Plugins\cactbot\cactbot` 文件夹中,并在插件列表中启用 `CactbotOverlay.dll`

### 插件加载顺序

Expand Down Expand Up @@ -211,7 +211,7 @@ Cactbot 理应在 Node LTS 版本运行,若你在 LTS 上遇到问题,请提

## 悬浮窗概述

Cactbot 的所有 UI 模块都包含在 [ui/](ui/) 文件夹中。如果你按照上述说明安装了 Cactbot,则很有可能是 `%APPDATA%\Advanced Combat Tracker\Plugins\cactbot-version\Cactbot\ui\`
Cactbot 的所有 UI 模块都包含在 [ui/](ui/) 文件夹中。如果你按照上述说明安装了 Cactbot,则很有可能是 `%APPDATA%\Advanced Combat Tracker\Plugins\cactbot\cactbot\ui\`

每个 Cactbot UI 模块都应当作为单独的悬浮窗添加。有关配置的更多信息,请参见 [添加悬浮窗模块](#添加悬浮窗模块) 部分。

Expand Down
2 changes: 1 addition & 1 deletion docs/zh-TW/CactbotCustomization.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ cactbot將按照字母順序優先載入user資料夾中的子資料夾裡的檔

如果沒有選擇,cactbot將自動選擇其安裝目錄下的預設資料夾。

建議您選擇cactbot安裝目錄下的 `cactbot/user` 資料夾。 該資料夾通常為位於 `%APPDATA%\Advanced Combat Tracker\Plugins\cactbot-version\cactbot\user`。 有部分示例配置檔案位於 [此資料夾](../../user) 下。
建議您選擇cactbot安裝目錄下的 `cactbot/user` 資料夾。 該資料夾通常為位於 `%APPDATA%\Advanced Combat Tracker\Plugins\cactbot\cactbot\user`。 有部分示例配置檔案位於 [此資料夾](../../user) 下。

## 樣式自定義

Expand Down
2 changes: 1 addition & 1 deletion user/README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ layout/style settings where <module> is the name of the module that will
load the config.

Copy and rename the <module>-example.js file to <module>.js for an easy
starting point.
starting point.
16 changes: 11 additions & 5 deletions user/jobs-example.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
// Rename this file to `jobs.js` and edit it to change the jobs ui.
// Rename this file to `jobs.js` and edit it to change the jobs UI.

// This file is JavaScript. Anything after "//" on a line is a comment.
// If you edit this file, remember to reload ACT or click the "Reload overlay"
// button on the jobs overlay.
// If there are errors in this file, they will appear in the OverlayPlugin.dll
// log window in ACT.

// List of jobs to show an hp value for.
Options.ShowHPNumber = ['PLD', 'WAR', 'DRK', 'GNB', 'WHM', 'SCH', 'AST', 'SGE', 'BLU'];
Expand All @@ -9,19 +15,19 @@ Options.ShowMPNumber = ['PLD', 'DRK', 'WHM', 'SCH', 'AST', 'SGE', 'BLM', 'BLU'];
// List of jobs to show an mp ticker for.
Options.ShowMPTicker = ['BLM'];

// The distance that mp bar turn orange for caster,
// The distance that the mp bar turns orange for a caster,
// indicating target out of range for casters.
Options.FarThresholdOffence = 24;

// When MP falls below this, the MP bar turn blue/red for for paladin.
// When MP falls below this, the MP bar turns blue/red for for paladin.
Options.PldMediumMPThreshold = 5399;
Options.PldLowMPThreshold = 3599;

// When MP falls below this, the MP bar turn blue/red for dark knight.
// When MP falls below this, the MP bar turns blue/red for dark knight.
Options.DrkMediumMPThreshold = 5999;
Options.DrkLowMPThreshold = 2999;

// When MP falls below this, the MP bar turn blue/red for black mage.
// When MP falls below this, the MP bar turns blue/red for black mage.
Options.BlmMediumMPThreshold = 3999;
Options.BlmLowMPThreshold = 2399;

Expand Down
12 changes: 9 additions & 3 deletions user/oopsyraidsy-example.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
// Rename this file to `oopsyraidsy.js` then edit to change the oopsyraidsy ui.
// Rename this file to `oopsyraidsy.js` then edit to change the oopsyraidsy UI.

// This file is JavaScript. Anything after "//" on a line is a comment.
// If you edit this file, remember to reload ACT or click the "Reload overlay"
// button on the oopsyraidsy overlay.
// If there are errors in this file, they will appear in the OverlayPlugin.dll
// log window in ACT.

// A set of triggers to be ignored. The key is the 'id' of the trigger, and
// the value should be true if the trigger is to be ignored, whereas false
// will have no effect. The trigger ids can be found in the trigger files for
// each fight in the files inside of this directory:
// https://github.com/quisquous/cactbot/tree/main/ui/oopsyraidsy/data/
// https://github.com/OverlayPlugin/cactbot/tree/main/ui/oopsyraidsy/data
Options.DisabledTriggers = {
'General Rabbit Medium': true,
'General Early Pull': true,
Expand All @@ -28,7 +34,7 @@ Options.PlayerNicks = {
Options.AbilityIdNameMap['26CA'] = 'White Swirly';

// An array of user-defined triggers, in the format defined in the readme:
// https://github.com/quisquous/cactbot/tree/main/docs/OopsyraidsyGuide.md
// https://github.com/OverlayPlugin/cactbot/blob/main/docs/OopsyraidsyGuide.md
//
// Here's an example trigger to show a line in the mistake log when
// you crit adlo yourself in Summerford Farms.
Expand Down
7 changes: 4 additions & 3 deletions user/radar-example.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
// Rename this file to `radar.js` and edit it to change the radar ui.
// This file is Javascript. Anything after "//" on a line is a comment.
// Rename this file to `radar.js` and edit it to change the radar UI.

// This file is JavaScript. Anything after "//" on a line is a comment.
// If you edit this file, remember to reload ACT or click the "Reload overlay"
// button on the raidboss CactbotOverlay.
// button on the radar overlay.
// If there are errors in this file, they will appear in the OverlayPlugin.dll
// log window in ACT.

Expand Down
17 changes: 9 additions & 8 deletions user/raidboss-example.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
// Rename this file to `raidboss.js` and edit it to change the raidboss ui.
// This file is Javascript. Anything after "//" on a line is a comment.
// Rename this file to `raidboss.js` and edit it to change the raidboss UI.

// This file is JavaScript. Anything after "//" on a line is a comment.
// If you edit this file, remember to reload ACT or click the "Reload overlay"
// button on the raidboss overlay.
// If there are errors in this file, they will appear in the OverlayPlugin.dll
// log window in ACT.
// See: http://github.com/quisquous/cactbot/blob/main/docs/CactbotCustomization.md#check-the-overlayplugin-log-for-errors
// See: https://github.com/OverlayPlugin/cactbot/blob/main/docs/CactbotCustomization.md#check-the-overlayplugin-log-for-errors

// Path to sound played for info-priority text popups, or when "Info" is
// specified as the sound name.
Expand All @@ -26,19 +27,19 @@ Options.LongSound = '../../resources/sounds/BigWigs/Long.webm';
Options.PullSound = '../../resources/sounds/freesound/sonar.webm';

// A set of nicknames to use for players, when trying to shorten names.
// See: https://github.com/quisquous/cactbot/blob/main/docs/CactbotCustomization.md#customizing-behavior
// See: https://github.com/OverlayPlugin/cactbot/blob/main/docs/CactbotCustomization.md#customizing-behavior
Options.PlayerNicks = {
'Captain Jimmy': 'Jimmy',
'Pipira Pira': 'Fish',
};

// An array of user-defined triggers, in the format defined in the trigger guide:
// See: https://github.com/quisquous/cactbot/blob/main/docs/CactbotCustomization.md#overriding-raidboss-triggers
// See also: https://github.com/quisquous/cactbot/tree/main/docs/RaidbossGuide.md
// See: https://github.com/OverlayPlugin/cactbot/blob/main/docs/CactbotCustomization.md#overriding-raidboss-triggers
// See also: https://github.com/OverlayPlugin/cactbot/blob/main/docs/RaidbossGuide.md

// Here's an example of overriding a trigger.
// This overrides the "Test Poke" trigger from:
// https://github.com/quisquous/cactbot/blob/main/ui/raidboss/data/00-misc/test.js
// https://github.com/OverlayPlugin/cactbot/blob/main/ui/raidboss/data/00-misc/test.txt

Options.Triggers.push({
zoneId: ZoneId.MiddleLaNoscea,
Expand Down Expand Up @@ -88,7 +89,7 @@ Options.Triggers.push({
triggers: [
// A more complicated regen trigger.
{
// This is a made up id that does not exist in cactbot.
// This is a made up id that does not exist in Cactbot.
id: 'User Example Regen',
// This will match log lines from ACT that look like this:
// "Nacho Queen gains the effect of Regen from Taco Cat for 21.00 Seconds."
Expand Down
4 changes: 2 additions & 2 deletions user/test-override.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# This is an example of how to override your timeline.
#
# The original file is in:
# https://github.com/quisquous/cactbot/blob/main/ui/raidboss/data/00-misc/test.txt
# https://github.com/OverlayPlugin/cactbot/blob/main/ui/raidboss/data/00-misc/test.txt

0 "--Reset--" sync /You bid farewell to the striking dummy/ window 10000 jump 0

Expand All @@ -16,4 +16,4 @@
14 "the test timeline"
15 "with user/raidboss.js"
25 "Final Sting X"
40 "Death"
40 "Death"

0 comments on commit 465a519

Please sign in to comment.