https://github.com/maikotan/cactbot-highlight
A VSCode extension for developing cactbot modules.
https://github.com/maikotan/cactbot-highlight
advanced-combat-tracker cactbot cactbot-highlight ffxiv final-fantasy-xiv highlight snippets timeline trigger visual-studio-code vscode vsix
Last synced: about 2 months ago
JSON representation
A VSCode extension for developing cactbot modules.
- Host: GitHub
- URL: https://github.com/maikotan/cactbot-highlight
- Owner: MaikoTan
- License: other
- Created: 2020-10-06T09:33:44.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-11-18T23:12:14.000Z (7 months ago)
- Last Synced: 2024-11-24T20:13:00.484Z (7 months ago)
- Topics: advanced-combat-tracker, cactbot, cactbot-highlight, ffxiv, final-fantasy-xiv, highlight, snippets, timeline, trigger, visual-studio-code, vscode, vsix
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=MaikoTan.cactbot-highlight
- Size: 5.61 MB
- Stars: 15
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Cactbot Highlight
[](https://marketplace.visualstudio.com/items?itemName=MaikoTan.cactbot-highlight)
[](https://marketplace.visualstudio.com/items?itemName=MaikoTan.cactbot-highlight)
[](https://open-vsx.org/extension/MaikoTan/cactbot-highlight)
[](https://open-vsx.org/extension/MaikoTan/cactbot-highlight)
[](https://github.com/MaikoTan/cactbot-highlight/actions/workflows/build.yml)
[](https://github.com/MaikoTan/cactbot-highlight/actions/workflows/eslint.yml)
[](https://github.com/MaikoTan/cactbot-highlight/actions/workflows/test.yml)
A VSCode extension for developing [cactbot](https://github.com/OverlayPlugin/cactbot/) modules.
- [Features](#features)
- [Raidboss Timeline](#raidboss-timeline)
- [Syntax Highlight](#syntax-highlight)
- [Time Adjustment](#time-adjustment)
- [Translation Validation](#translation-validation)
- [Raidboss Triggers](#raidboss-triggers)
- [Code Snippets](#code-snippets)
- [FAQ](#faq)
- [Localisation](#localisation)
- [Contributing](#contributing)
- [License](#license)
## Features
### [Raidboss](https://github.com/OverlayPlugin/cactbot#raidboss-overlay) Timeline
#### Syntax Highlight
If you didn't see the syntax highlight in your timeline files,
please check the [FAQ](https://github.com/MaikoTan/cactbot-highlight/blob/master/FAQ.md#why-isnt-my-timeline-files-not-highlighted).
#### Time Adjustment
#### Translation Validation
To use this feature, you should make sure your active file
is a valid timeline file or trigger file that there are a valid
timeline file which has the same name in the same directory,
also make sure you are in the cactbot repository.
Click the `Translate Current Timeline` button on the top-right corner to translate the active file.
### [Raidboss](https://github.com/OverlayPlugin/cactbot#raidboss-overlay) Triggers
#### Code Snippets
Snippet
Example
ca-r-init
initiate a complete trigger set
```ts
import ZoneId from '../../../../../resources/zone_id'
import { RaidbossData } from '../../../../../types/data'
import { TriggerSet } from '../../../../../types/trigger'
export type Data = RaidbossData
const triggerSet: TriggerSet = {
zoneId: ZoneId.TheBindingCoilOfBahamutTurn4,
timelineFile: 't13.txt',
timelineTriggers: [],
triggers: [],
timelineReplace: [],
}
export default triggerSet
```
ca-r-timeline-trigger
initiate a timeline trigger
```ts
{
id: 'T13 Phase 2',
regex: /Regex/,
beforeSeconds: 5,
}
```
ca-r-trigger
initiate a trigger
```ts
{
id: 'T13 Gigaflare',
type: 'Ability',
netRegex: NetRegexes.ability({ }),
},
```
ca-r-timeline-replace
initiate a timeline replace section
```ts
{
'locale': 'de',
'replaceSync': {},
'replaceText': {},
},
```
ca-r-timeline-replace-all
initiate timeline replace
sections with all languages
```ts
{
'locale': 'en',
'replaceSync': {},
'replaceText': {},
},
{
'locale': 'de',
'missingTranslations': true,
'replaceSync': {},
'replaceText': {},
},
// ...
{
'locale': 'ko',
'missingTranslations': true,
'replaceSync': {},
'replaceText': {},
},
```
## FAQ
You can find the FAQ in [FAQ.md](https://github.com/MaikoTan/cactbot-highlight/blob/master/FAQ.md).
## Localisation
This extension supports multi-language.
Translators are listed below. Thanks for your contribution!
- English (US) - [@MaikoTan](https://github/MaikoTan)
- Simplified Chinese - [@ShadyWhite](https://github.com/ShadyWhite) [@DeepseaXX](https://github.com/DeepseaXX)
- Traditional Chinese - [@MaikoTan](https://github.com/MaikoTan)
- Japanese - [@MaikoTan](https://github.com/MaikoTan) [@DeepseaXX](https://github.com/DeepseaXX)
- French - [@MaikoTan](https://github.com/MaikoTan) [@wuasar42](https://crowdin.com/profile/wuasar42)
- Korean - [@Bing-su](https://github.com/Bing-su)
If you want to add a new language, or contribute to the existing ones,
please visit [our project on Crowdin](https://crowdin.com/project/cactbot-highlight).
If you want to add a new language, you should make sure that the language is supported by VSCode officially.
You can search for the language name in the Extensions Marketplace,
or access [microsoft/vscode-loc](https://github.com/microsoft/vscode-loc) to see if your language is supported or not.
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md)
## License
This project is licensed under the MIT license,
see [LICENSE](LICENSE.md) for more detail.