Skip to content

Commit

Permalink
docs: update timeline guide (#6051)
Browse files Browse the repository at this point in the history
  • Loading branch information
quisquous authored Dec 18, 2023
1 parent 9d37c2d commit 261a217
Show file tree
Hide file tree
Showing 5 changed files with 105,580 additions and 1,040 deletions.
13 changes: 1 addition & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -252,13 +252,7 @@ See: [Raidboss Guide](docs/RaidbossGuide.md#trigger-guidelines)

## Timeline Guidelines

* Use the existing scripts in the `util/` directory to make timelines.
* Prefer using `sync` with the default time for all abilities.
* Prefer to use actual ability names for the timeline text.
* If ability names are confusing or long, consider abbreviating.
* When using `jump`, prefer to jump to a time that has a timeline entry on it.
* When adding a loop, add at least 30 seconds of fake abilities, and make sure these abilities line up with where the loop jumps to.
* As always, be consistent with other timelines.
See: [Timeline Guide](docs/TimelineGuide.md#cactbot-style-guide)

## Oopsy Guidelines

Expand All @@ -269,8 +263,3 @@ See: [Oopsy Guide](docs/OopsyraidsyGuide.md#overview)
* Improvements and additions to documentation are always welcome.
* Use [semantic line breaks](https://sembr.org/).
* As always, be consistent!

## Roadmap

If you're curious what is coming in the future,
here is a [rough roadmap](https://gist.github.com/quisquous/85b85338b7a87ca6bad98e793d159fdf).
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ Support is continually added over time (patches welcome!)
but a lot of old content may not be supported yet.

Fight timelines are provided in files designed for the [ACT Timeline](https://github.com/grindingcoil/act_timeline)
plugin, [documented here](http://dtguilds.enjin.com/forum/m/37032836/viewthread/26353492-act-timeline-plugin)
plugin, [documented here](https://web.archive.org/web/20230426121530/https://dtguilds.enjin.com/forum/m/37032836/viewthread/26353492-act-timeline-plugin)
with [some extensions](docs/TimelineGuide.md).

There are three levels of text alerts, in order of escalating importance: `info`, `alert`, and `alarm`.
Expand Down
2 changes: 1 addition & 1 deletion docs/RaidbossGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -736,7 +736,7 @@ These reports have several different categories of errors:

- other: general miscellaneous errors, usually not related to any line
- code: a block of TypeScript code is missing a translation
- sync: a trigger or a timeline `sync /something/` line is missing a translation
- sync: a trigger or a timeline `Ability { source: "something" }` line is missing a translation
- text: timeline text (e.g. `2.0 "text"`) is missing a translation

### Code Translations
Expand Down
Loading

0 comments on commit 261a217

Please sign in to comment.