diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index afc7fe3..aa0b8c8 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,18 +1,24 @@ +# How to Contribute + ## Issues/Feedback/Requests + - Create a new issue [here](https://github.com/obs-websocket-community-projects/obs-websocket-js/issues/new), please be as descriptive as possible. ## Building the Project Locally -- Install [node.js](http://nodejs.org) + +- Install [node.js v20 or greater](http://nodejs.org) - Clone/Fork the repo - Install dependencies with `npm install` - Generate the browser distributable Javascript file with `npm run build` - Or `npm run watch` to automatically build when files are modified. -- This project makes use of eslint, run `npm run test:static` for linting and `npm run test:ava` for basic unit testing. If you have the types compiled you can also run `npm run test:types`. +- This project makes use of eslint, run `npm run lint` for linting and `npm run test` for basic unit testing. ## Building Typings Locally + - Export GH_TOKEN as an environment variable, using a generated Personal Access Token. - `npm run build:types` ## Contributing Guidelines + - Please use descriptive commit messages. - When submitting a Pull Request, reference related [Issues](https://github.com/obs-websocket-community-projects/obs-websocket-js/issues) if any exist. diff --git a/src/types.ts b/src/types.ts index c611b40..5f50a25 100644 --- a/src/types.ts +++ b/src/types.ts @@ -718,6 +718,12 @@ export interface OBSEventTypes { */ outputPath: string; }; + RecordFileChanged: { + /** + * File name that the output has begun writing to + */ + newOutputPath: string; + }; ReplayBufferStateChanged: { /** * Whether the output is active @@ -1858,6 +1864,14 @@ export interface OBSRequestTypes { ToggleRecordPause: never; PauseRecord: never; ResumeRecord: never; + SplitRecordFile: never; + CreateRecordChapter: { + /** + * Name of the new chapter + * @defaultValue Unknown + */ + chapterName?: string; + }; GetSceneItemList: { /** * Name of the scene to get the items of @@ -3001,6 +3015,8 @@ export interface OBSResponseTypes { ToggleRecordPause: undefined; PauseRecord: undefined; ResumeRecord: undefined; + SplitRecordFile: undefined; + CreateRecordChapter: undefined; GetSceneItemList: { /** * Array of scene items in the scene