Skip to content

MaikoTan/cactbot-highlight

Repository files navigation

Cactbot Highlight

Visual Studio Market Downloads Open VSX Version Open VSX Downloads

Build Lint Test

A VSCode extension for developing cactbot modules.

Features

Raidboss Timeline

Syntax Highlight

If you didn't see the syntax highlight in your timeline files, please check the FAQ.

Time Adjustment

adjust-time

Translation Validation

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 Triggers

Code Snippets

Snippet Example
ca-r-init
initiate a complete trigger set
import ZoneId from '../../../../../resources/zone_id'
import { RaidbossData } from '../../../../../types/data'
import { TriggerSet } from '../../../../../types/trigger'

export type Data = RaidbossData

const triggerSet: TriggerSet<Params> = {
  zoneId: ZoneId.TheBindingCoilOfBahamutTurn4,
  timelineFile: 't13.txt',
  timelineTriggers: [],
  triggers: [],
  timelineReplace: [],
}

export default triggerSet
ca-r-timeline-trigger
initiate a timeline trigger
{
  id: 'T13 Phase 2',
  regex: /Regex/,
  beforeSeconds: 5,
}
ca-r-trigger
initiate a trigger
{
  id: 'T13 Gigaflare',
  type: 'Ability',
  netRegex: NetRegexes.ability({ }),
},
ca-r-timeline-replace
initiate a timeline replace section
{
  'locale': 'de',
  'replaceSync': {},
  'replaceText': {},
},
ca-r-timeline-replace-all
initiate timeline replace
sections with all languages
{
  '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.

Localisation

This extension supports multi-language.

Translators are listed below. Thanks for your contribution!

If you want to add a new language, or contribute to the existing ones, please visit our project on Crowdin.

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 to see if your language is supported or not.

Contributing

See CONTRIBUTING.md

License

This project is licensed under the MIT license, see LICENSE for more detail.