Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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: 3 months ago
JSON representation

A VSCode extension for developing cactbot modules.

Awesome Lists containing this project

README 

        
# Cactbot Highlight






[![Visual Studio Market](https://img.shields.io/visual-studio-marketplace/v/MaikoTan.cactbot-highlight?color=green&label=Visual%20Studio%20Market)](https://marketplace.visualstudio.com/items?itemName=MaikoTan.cactbot-highlight)

[![Downloads](https://img.shields.io/visual-studio-marketplace/d/MaikoTan.cactbot-highlight?color=green)](https://marketplace.visualstudio.com/items?itemName=MaikoTan.cactbot-highlight)

[![Open VSX Version](https://img.shields.io/open-vsx/v/MaikoTan/cactbot-highlight?label=Open%20VSX&color=green)](https://open-vsx.org/extension/MaikoTan/cactbot-highlight)

[![Open VSX Downloads](https://img.shields.io/open-vsx/dt/MaikoTan/cactbot-highlight)](https://open-vsx.org/extension/MaikoTan/cactbot-highlight)



[![Build](https://github.com/MaikoTan/cactbot-highlight/actions/workflows/build.yml/badge.svg)](https://github.com/MaikoTan/cactbot-highlight/actions/workflows/build.yml)

[![Lint](https://github.com/MaikoTan/cactbot-highlight/actions/workflows/eslint.yml/badge.svg)](https://github.com/MaikoTan/cactbot-highlight/actions/workflows/eslint.yml)

[![Test](https://github.com/MaikoTan/cactbot-highlight/actions/workflows/test.yml/badge.svg)](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



![adjust-time](images/adjust-time.gif)



#### Translation Validation



![translate-timeline.gif](images/translate-timeline.gif)



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.