refactor: Sceneify rebrand

.github/workflows/CI.yml

@@ -68,7 +68,7 @@ jobs:
   publish:
     name: 'Publish to NPM'
     runs-on: ubuntu-latest
-    if: github.event_name == 'push' && github.repository == 'brendonovich/simple-obs'
+    if: github.event_name == 'push' && github.repository == 'brendonovich/sceneify'
     needs: [build, test]
     steps:
       - uses: actions/checkout@v2
@@ -96,7 +96,7 @@ jobs:
 
       - name: Publish main to npm
         if: github.ref == 'refs/heads/main'
-        run: pnpm publish -r ${TAG} --no-git-checks --filter "@simple-obs/*" --access public
+        run: pnpm publish -r ${TAG} --no-git-checks --filter "@sceneify/*" --access public
         env:
           TAG: ${{ (github.ref == 'refs/heads/main' && '--tag=main') || '' }}
           NPM_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
@@ -107,7 +107,7 @@ jobs:
 
       - name: Publish release to npm
         if: github.ref_type == 'tag'
-        run: pnpm publish -r ${TAG} --no-git-checks --filter "@simple-obs/*" --access public
+        run: pnpm publish -r ${TAG} --no-git-checks --filter "@sceneify/*" --access public
         env:
           TAG: ${{ (contains(github.ref_name, '-beta.') && '--tag=beta') || ''}}
           NPM_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

@@ -1,61 +1,37 @@
 <p align="center">
-<img src="website/static/img/logo.png" alt="Simple OBS logo" height="150"/>
 </p>
 
-<h1 align="center">Simple OBS</h1>
-<p align="center">The simplest way to control OBS from JavaScript</p>
+<h1 align="center">Sceneify</h1>
+<p align="center">The easiest way to control OBS from JavaScript</p>
 
 <p align="center">
-<a href="https://www.npmjs.com/package/@simple-obs/core">
-   <img src="https://img.shields.io/npm/dt/simple-obs?style=flat&colorA=000000&colorB=000000" alt="Downloads">
+<a href="https://www.npmjs.com/package/@sceneify/core">
+   <img src="https://img.shields.io/npm/dt/sceneify?style=flat&colorA=000000&colorB=000000" alt="Downloads">
 </a>
-<a href="https://www.npmjs.com/package/@simple-obs/core">
-   <img src="https://img.shields.io/npm/v/@simple-obs/core?label=core&style=flat&colorA=000000&colorB=000000" alt="Core Version">
+<a href="https://www.npmjs.com/package/@sceneify/core">
+   <img src="https://img.shields.io/npm/v/@sceneify/core?label=core&style=flat&colorA=000000&colorB=000000" alt="Core Version">
 </a>
-<a href="https://bundlephobia.com/result?p=@simple-obs/core">
-   <img src="https://img.shields.io/bundlephobia/min/@simple-obs/core?label=bundle%20size&style=flat&colorA=000000&colorB=000000" alt="Build Size">
+<a href="https://bundlephobia.com/result?p=@sceneify/core">
+   <img src="https://img.shields.io/bundlephobia/min/@sceneify/core?label=bundle%20size&style=flat&colorA=000000&colorB=000000" alt="Build Size">
 </a>
 </p>
 
 Translations: [Spanish](translations/README_es.md) | {Add your language translation}
 
 Using `obs-websocket` can be difficult. Small manipulations of scenes and scene items are manageable, but keeping track of scenes, sources, settings, filters and more can quickly become a daunting task.
 
-Simple OBS aims to fix this. By working with `Scene`, `Source`, and `SceneItem` objects, you can have unparalleled control over your OBS layouts.
-
-If you're familiar with databases, it's like an ORM for OBS!
+Sceneify aims to fix this. By working with `Scene`, `Source`, and `SceneItem` objects, you can have unparalleled control over your OBS layouts.
 
 # Beta Warning
 
-This library is not well tested and is still under heavy development. Feel free to use it, but make sure you make a backup of your scene collections before doing anything with Simple OBS.
+This library is not well tested and is still under heavy development. Feel free to use it, but make sure you make a backup of your scene collections before doing anything with Sceneify.
 
 ## Features
 
 - Persistence across code reloads, so scenes and items aren't deleted and recreated each time you run your code
 - `Scene`, `Source` and `SceneItem` are designed to be overridden, allowing for complex layouts to be abstracted into subclasses
-- Easy integration into existing layouts with `Scene.link()`, allowing for incremental migration to Simple OBS without handing over your entire layout to your code
-
-## Installation
-
-1. Install the [fork of `obs-websocket`](https://github.com/MemedowsTeam/obs-websocket/releases)
-
-   Simple OBS exposes some functionality (eg. `obs.clean()`, `Scene.remove()`) that requires installing a custom fork of `obs-websocket`. This fork simply adds support for removing scenes, retaining all other previous functionality. Simple OBS will support `obs-websocket` v5 when it is released, which has native support for removing scenes, and also v4 for backwards compatibility.
-
-2. Install `@simple-obs/core`
-
-   ```
-   yarn add @simple-obs/core
-   ```
-
-   or npm
-
-   ```
-   npm install @simple-obs/core
-   ```
-
-   If using typescript, make sure you are at least using `[email protected]`, as `@simple-obs/core` uses some features of it to provide more accurate types for requests and events.
+- Easy integration into existing layouts with `Scene.link()`, allowing for incremental migration to Sceneify without handing over your entire layout to your code.
 
-3. Connect to OBS. See the [example](https://github.com/Brendonovich/simple-obs/blob/master/packages/core/example/index.ts) for more info.
 
 ## Acknowledgements
 

examples/animation/index.ts

@@ -1,5 +1,5 @@
-import { Alignment, ColorCorrectionFilter, ColorSource, OBS, Scene } from "@simple-obs/core";
-import { Easing, keyframe, animate } from "@simple-obs/animation";
+import { Alignment, ColorCorrectionFilter, ColorSource, OBS, Scene } from "@sceneify/core";
+import { Easing, keyframe, animate } from "@sceneify/animation";
 
 async function main() {
   const obs = new OBS();

examples/animation/package.json

@@ -14,8 +14,8 @@
     "@types/node": "^16.9.3"
   },
   "dependencies": {
-    "@simple-obs/animation": "*",
-    "@simple-obs/core": "*",
-    "@simple-obs/sources": "*"
+    "@sceneify/animation": "*",
+    "@sceneify/core": "*",
+    "@sceneify/sources": "*"
   }
 }

examples/basic/index.ts

@@ -1,6 +1,6 @@
-import { Alignment, OBS, Scene } from "@simple-obs/core";
-// import { ColorCorrectionFilter } from "@simple-obs/filters";
-import { ColorSource } from "@simple-obs/sources";
+import { Alignment, OBS, Scene } from "@sceneify/core";
+// import { ColorCorrectionFilter } from "@sceneify/filters";
+import { ColorSource } from "@sceneify/sources";
 
 // README
 // Running this code requies that you create a scene named "Linked Scene" with a single

examples/basic/package.json

@@ -14,8 +14,8 @@
     "ts-node": "^10.2.1"
   },
   "dependencies": {
-    "@simple-obs/core": "*",
-    "@simple-obs/filters": "*",
-    "@simple-obs/sources": "*"
+    "@sceneify/core": "*",
+    "@sceneify/filters": "*",
+    "@sceneify/sources": "*"
   }
 }

package.json

@@ -1,10 +1,10 @@
 {
-  "name": "simple-obs-root",
+  "name": "sceneify-root",
   "version": "1.0.0-beta.2",
   "private": true,
   "repository": {
     "type": "git",
-    "url": "https://github.com/Brendonovich/simple-obs"
+    "url": "https://github.com/Brendonovich/sceneify"
   },
   "workspaces": {
     "packages": [

packages/animation/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@simple-obs/animation",
+  "name": "@sceneify/animation",
   "version": "1.0.0-beta.0",
   "description": "",
   "main": "./lib/node/index.js",
@@ -10,7 +10,7 @@
   "license": "ISC",
   "dependencies": {
     "@datastructures-js/queue": "^4.1.3",
-    "@simple-obs/core": "*"
+    "@sceneify/core": "*"
   },
   "devDependencies": {
     "jest": "^27.4.5"

packages/animation/src/index.ts

@@ -1,6 +1,6 @@
 export * from "./easing";
 
-import { Filter, Input, SceneItem, SceneItemTransform } from "@simple-obs/core";
+import { Filter, Input, SceneItem, SceneItemTransform } from "@sceneify/core";
 import { Queue } from "@datastructures-js/queue";
 
 import { performance } from "./performance";

packages/animation/tests/index.test.ts

@@ -1,5 +1,5 @@
 import { Queue } from "@datastructures-js/queue";
-import { CustomInputArgs, Input } from "@simple-obs/core";
+import { CustomInputArgs, Input } from "@sceneify/core";
 
 import { Keyframe, processTimeline, subjectKeyframes, Easing } from "../src";
 

packages/core/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@simple-obs/core",
+  "name": "@sceneify/core",
   "version": "1.0.0-beta.0",
   "description": "",
   "main": "./cjs/index.cjs",

packages/core/src/OBS.ts

@@ -37,7 +37,7 @@ export class OBS {
   }
 
   /**
-   * Goes though each source in OBS and removes it if Simple OBS owns it,
+   * Goes though each source in OBS and removes it if Sceneify owns it,
    * and there are no references to the source in code.
    */
   async clean() {

packages/core/src/Scene.ts

@@ -46,7 +46,7 @@ export class Scene<
   /**
    * MAIN METHODS
    *
-   * Methods that provide functionality specific to simple-obs.
+   * Methods that provide functionality specific to sceneify.
    */
 
   /**  */

packages/filters/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@simple-obs/filters",
+  "name": "@sceneify/filters",
   "version": "1.0.0-beta.0",
   "description": "",
   "main": "./cjs/index.cjs",
@@ -12,7 +12,7 @@
     "test": "jest -i"
   },
   "dependencies": {
-    "@simple-obs/core": "*"
+    "@sceneify/core": "*"
   },
   "devDependencies": {
     "jest": "^27.4.5"

packages/filters/src/ApplyLUT.ts

@@ -1,4 +1,4 @@
-import { CustomFilterArgs, Filter, Source } from "@simple-obs/core";
+import { CustomFilterArgs, Filter, Source } from "@sceneify/core";
 
 export type ApplyLUTFilterSettings = {
   image_path: string;

packages/filters/src/AspectRatio.ts

@@ -1,4 +1,4 @@
-import { CustomFilterArgs, Filter, Source } from "@simple-obs/core";
+import { CustomFilterArgs, Filter, Source } from "@sceneify/core";
 
 export type AspectRatioFilterSettings = {
   resolution: string;

packages/filters/src/ChromaKey.ts

@@ -1,4 +1,4 @@
-import { CustomFilterArgs, Filter, Source } from "@simple-obs/core";
+import { CustomFilterArgs, Filter, Source } from "@sceneify/core";
 
 export enum ChromaKeyColorType {
   Green = "green",

packages/filters/src/ColorCorrection.ts

@@ -1,4 +1,4 @@
-import { CustomFilterArgs, Filter, Source } from "@simple-obs/core";
+import { CustomFilterArgs, Filter, Source } from "@sceneify/core";
 
 export type ColorCorrectionFilterSettings = {
   brightness: number;

packages/filters/src/ColorKey.ts

@@ -1,4 +1,4 @@
-import { CustomFilterArgs, Filter, Source } from "@simple-obs/core";
+import { CustomFilterArgs, Filter, Source } from "@sceneify/core";
 
 export enum ColorKeyColorType {
   Green = "green",

packages/filters/src/Compressor.ts

@@ -1,4 +1,4 @@
-import { CustomFilterArgs, Filter, Source } from "@simple-obs/core";
+import { CustomFilterArgs, Filter, Source } from "@sceneify/core";
 
 export type CompressorFilterSettings = {
   ratio: number;

packages/filters/src/CropPad.ts

@@ -1,4 +1,4 @@
-import { CustomFilterArgs, Filter, Source } from "@simple-obs/core";
+import { CustomFilterArgs, Filter, Source } from "@sceneify/core";
 
 export type CropPadFilterSettings = {
   bottom: number;

packages/filters/src/Expander.ts

@@ -1,4 +1,4 @@
-import { CustomFilterArgs, Filter, Source } from "@simple-obs/core";
+import { CustomFilterArgs, Filter, Source } from "@sceneify/core";
 
 export enum ExpanderDetectorType {
   RMS = "RMS",

packages/filters/src/Gain.ts

@@ -1,4 +1,4 @@
-import { CustomFilterArgs, Filter, Source } from "@simple-obs/core";
+import { CustomFilterArgs, Filter, Source } from "@sceneify/core";
 
 export type GainFilterSettings = { db: number };
 

packages/filters/src/ImageMaskBlend.ts

@@ -1,4 +1,4 @@
-import { CustomFilterArgs, Filter, Source } from "@simple-obs/core";
+import { CustomFilterArgs, Filter, Source } from "@sceneify/core";
 
 export enum MaskBlendType {
   AlphaMaskAlphaChannel = "mask_alpha_filter.effect",

packages/filters/src/InvertPolarity.ts

@@ -1,4 +1,4 @@
-import { CustomFilterArgs, Filter, Source } from "@simple-obs/core";
+import { CustomFilterArgs, Filter, Source } from "@sceneify/core";
 
 export class InvertPolarityFilter<TSource extends Source> extends Filter<
   {},

packages/filters/src/Limiter.ts

@@ -1,4 +1,4 @@
-import { CustomFilterArgs, Filter, Source } from "@simple-obs/core";
+import { CustomFilterArgs, Filter, Source } from "@sceneify/core";
 
 export type LimiterFilterSettings = {
   threshold: number;

packages/filters/src/LumaKey.ts

@@ -1,4 +1,4 @@
-import { CustomFilterArgs, Filter, Source } from "@simple-obs/core";
+import { CustomFilterArgs, Filter, Source } from "@sceneify/core";
 
 type LumaKeyFilterSettings = {
   luma_max: number;

packages/filters/src/NoiseGate.ts

@@ -1,4 +1,4 @@
-import { CustomFilterArgs, Filter, Source } from "@simple-obs/core";
+import { CustomFilterArgs, Filter, Source } from "@sceneify/core";
 
 export type NoiseGateFilterSettings = {
   open_threshold: number;

packages/filters/src/NoiseSuppress.ts

@@ -1,4 +1,4 @@
-import { CustomFilterArgs, Filter, Source } from "@simple-obs/core";
+import { CustomFilterArgs, Filter, Source } from "@sceneify/core";
 
 export enum NoiseSuppressMethod {
   Speex = "speex",

packages/filters/src/RenderDelay.ts

@@ -1,4 +1,4 @@
-import { CustomFilterArgs, Filter, Source } from "@simple-obs/core";
+import { CustomFilterArgs, Filter, Source } from "@sceneify/core";
 
 export type RenderDelayFilterSettings = {
   delay_ms: number;

packages/filters/src/Scroll.ts

@@ -1,4 +1,4 @@
-import { CustomFilterArgs, Filter, Source } from "@simple-obs/core";
+import { CustomFilterArgs, Filter, Source } from "@sceneify/core";
 
 export type ScrollFilterSettings = {
   limit_cx: boolean;

packages/filters/src/Sharpen.ts

@@ -1,4 +1,4 @@
-import { CustomFilterArgs, Filter, Source } from "@simple-obs/core";
+import { CustomFilterArgs, Filter, Source } from "@sceneify/core";
 
 export type SharpenFilterSettings = {
   sharpness: number;

packages/sources/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@simple-obs/sources",
+  "name": "@sceneify/sources",
   "version": "1.0.0-beta.0",
   "description": "",
   "main": "./cjs/index.cjs",
@@ -12,7 +12,7 @@
     "test": "jest -i"
   },
   "dependencies": {
-    "@simple-obs/core": "*"
+    "@sceneify/core": "*"
   },
   "devDependencies": {
     "jest": "^27.4.5"

packages/sources/src/Browser.ts

@@ -5,7 +5,7 @@ import {
   SceneItem,
   Scene,
   CustomInputArgs,
-} from "@simple-obs/core";
+} from "@sceneify/core";
 
 export type BrowserSourceSettings = {
   url: string;

packages/sources/src/Color.ts

@@ -3,7 +3,7 @@ import {
   Input,
   SourceFilters,
   CustomInputArgs,
-} from "@simple-obs/core";
+} from "@sceneify/core";
 
 export type ColorSourceSettings = {
   color: number;

packages/sources/src/DisplayCapture.ts

@@ -1,4 +1,4 @@
-import { Input, SourceFilters, CustomInputArgs } from "@simple-obs/core";
+import { Input, SourceFilters, CustomInputArgs } from "@sceneify/core";
 
 export type DisplayCaptureSourceSettings = {
   monitor: number;

packages/sources/src/FreetypeText.ts

@@ -1,4 +1,4 @@
-import { Input, SourceFilters, CustomInputArgs } from "@simple-obs/core";
+import { Input, SourceFilters, CustomInputArgs } from "@sceneify/core";
 
 export type FreetypeTextSourceSettings = {
   text: string;

packages/sources/src/GDIPlusText.ts

@@ -1,4 +1,4 @@
-import { Input, SourceFilters, CustomInputArgs } from "@simple-obs/core";
+import { Input, SourceFilters, CustomInputArgs } from "@sceneify/core";
 
 export type GDIPlusTextSourceSettings = {
   text: string;

packages/sources/src/Image.ts

@@ -1,4 +1,4 @@
-import { CustomInputArgs, Input, SourceFilters } from "@simple-obs/core";
+import { CustomInputArgs, Input, SourceFilters } from "@sceneify/core";
 
 export type ImageSourceSettings = {
   file: string;

packages/sources/src/Media.ts

@@ -1,4 +1,4 @@
-import { Input, SourceFilters, CustomInputArgs } from "@simple-obs/core";
+import { Input, SourceFilters, CustomInputArgs } from "@sceneify/core";
 
 export type MediaSourceSettings = {
   local_file: string;