1.0.2 • Published 1 year ago

@swalls/audiotrip-choreo-utils v1.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

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/SWalls/audiotrip-choreo-utils.git
$ cd audiotrip-choreo-utils

Or download repository with ZIP:

$ curl -LO https://github.com/SWalls/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 :heart: 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

1.0.2

1 year ago

1.0.1

1 year ago

1.0.0

1 year ago

1.0.0-alpha

3 years ago