https://github.com/donkeyclip/motorcortex-tv
https://github.com/donkeyclip/motorcortex-tv
motorcortex motorcortex-plugin tv
Last synced: 19 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/donkeyclip/motorcortex-tv
- Owner: donkeyclip
- License: mit
- Created: 2020-11-13T21:04:04.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-17T17:58:59.000Z (about 1 month ago)
- Last Synced: 2025-04-18T08:10:24.702Z (about 1 month ago)
- Topics: motorcortex, motorcortex-plugin, tv
- Language: JavaScript
- Homepage:
- Size: 20.9 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# MotorCortex-Tv
**Table of Contents**
- [MotorCortex-Tv](#motorcortex-tv)
- [Demo](#demo)
- [Intro / Features](#intro--features)
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Importing and Loading](#importing-and-loading)
- [Creating Incidents](#creating-incidents)
- [TVNoise](#tvnoise)
- [ImageGlitch](#imageglitch)
- [Adding Incidents in your clip](#adding-incidents-in-your-clip)
- [Contributing](#contributing)
- [License](#license)
- [Sponsored by](#sponsored-by)
## Demo
[Check it out here](https://donkeyclip.github.io/motorcortex-tv/demo/index.html)
# Intro / Features
Using MotorCortex-Τv your clip will look like a TV without signal.
This Plugin exposes two incidents:
- TVNoise
- ImageGlitch
# Getting Started
## Installation
```bash
$ npm install --save @donkeyclip/motorcortex-tv
# OR
$ yarn add @donkeyclip/motorcortex-tv
```
## Importing and Loading
```javascript
import { loadPlugin } from "@donkeyclip/motorcortex";
import tvDefinition from "@donkeyclip/motorcortex-tv";
const TV = loadPlugin(tvDefinition);
```
# Creating Incidents
## TVNoise
```javascript
const tvNoise = new TV.TVNoise(
{
width: 800,
height: 600,
sound: true,
},
{
duration: 6000,
selector: "#container",
}
);
```
### TVNoise Attrs
| Name | Are | Values |
| -------- | :------------------------: | -----: |
| width | width of the canvas | num |
| height | height of the canvas | num |
| duration | the duration of the effect | num |
| sound | iclude noise sound or not | bool |
## imageGlitch
```javascript
const imageGlitch = new TV.ImageGlitch(
{
imgUrl:
"https://images.hdqwalls.com/wallpapers/minimal-sunset-landscape-4k-w5.jpg",
},
{
selector: "#glitchContainer",
containerParams: {
width: "800px",
height: "600px",
},
}
);
```
### ImageGlitch Attrs
| Name | Are | Values |
| ------ | :----------------------------------: | -----: |
| imgUrl | the image url to apply the effect on | url |
# Adding Incidents in your clip
```javascript
clipName.addIncident(incidentName,startTime);
```
# Contributing
In general, we follow the "fork-and-pull" Git workflow, so if you want to submit patches and additions you should follow the next steps:
1. **Fork** the repo on GitHub
2. **Clone** the project to your own machine
3. **Commit** changes to your own branch
4. **Push** your work back up to your fork
5. Submit a **Pull request** so that we can review your changes
# License
[MIT License](https://opensource.org/licenses/MIT)
# Sponsored by
[
](https://donkeyclip.com)