Skip to content

Useful functions for easily reading, parsing, and manipulating .ats choreography files for AudioTrip VR.

License

Notifications You must be signed in to change notification settings

dinosoeren/audiotrip-choreo-utils

Repository files navigation

audiotrip-choreo-utils

version build status coverage status dependency status minzipped size downloads GitHub Action: Push

Useful functions for easily reading, parsing, and manipulating .ats choreography files for AudioTrip VR.

Install

Use npm or yarn

  • npm install @swalls/audiotrip-choreo-utils or
  • yarn add @swalls/audiotrip-choreo-utils

From sources

Clone repository with Git:

$ git clone https://github.com/DinoSoeren/audiotrip-choreo-utils.git
$ cd audiotrip-choreo-utils

Or download repository with ZIP:

$ curl -LO https://github.com/DinoSoeren/audiotrip-choreo-utils/archive/master.zip
$ unzip master.zip
$ rm master.zip
$ cd audiotrip-choreo-utils

Reinitialize Git repository:

$ rm -rf .git
$ git init

Install package dependencies:

$ npm install

Use

import * as ChoreoUtils from '@swalls/audiotrip-choreo-utils';

const choreo = ChoreoUtils.readAtsFile('/path/to/choreo.ats');

Test

Run tests:

$ npm test

Run tests in watch mode:

$ npm run test:watch

Run tests with coverage:

$ npm run test:coverage

View coverage in browser:

$ npm run test:coverage
$ open coverage/index.html

Lint files:

$ npm run lint

Fix lint errors:

$ npm run lint:fix

Contribute

  • yarn set version latest
  • yarn up "*" "@*/*"
  • If you use VIM, run yarn sdks vim.
  • If you use Visual Studio Code, run yarn sdks vscode.

Special Thanks

Support

This free open-source software was made with ❤️ by a real person - me! If you found this tool useful, please consider tipping any amount you feel is appropriate for the value you received. :)

License

MIT

About

Useful functions for easily reading, parsing, and manipulating .ats choreography files for AudioTrip VR.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published