https://github.com/datsfilipe/web-ascii-theater

Package that exports a component that can be used to play ascii animations inside a React.js application.
https://github.com/datsfilipe/web-ascii-theater

badapple hacktoberfest javascript reactjs typescript

Last synced: about 1 month ago
JSON representation

Package that exports a component that can be used to play ascii animations inside a React.js application.

• Host: GitHub
• URL: https://github.com/datsfilipe/web-ascii-theater
• Owner: datsfilipe
• License: mit
• Created: 2022-10-22T15:51:38.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-01T03:19:41.000Z (9 months ago)
• Last Synced: 2024-11-09T02:38:58.347Z (about 1 month ago)
• Topics: badapple, hacktoberfest, javascript, reactjs, typescript
• Language: TypeScript
• Homepage: https://react-bad-apple.vercel.app
• Size: 53 MB
• Stars: 11
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Ascii Theater

As it says, using this package you can play whatever video you want in React.js as an Ascii animation. Follow the steps to do it.

# Showcase

You can see how it would be in here: [deploy](https://react-bad-apple.vercel.app).

# Steps

  

  - You can see the examples, in main repo inside "[src/scripts](./src/scripts)", of the scripts used to download the video and extract the frames;

  - If you cannot see it in the main repo, you can try to find package folder inside your node_modules, the scripts will be there;

  - You need to specify the path for the frames (recommend you to use ``public`` folder inside your app :));

  - Some of the props are mandatory, like: framesDir, framesCount, width and height.

# Usage

```jsx

import { AsciiTheater } from '@datsfilipe/web-ascii-theater'

// ...

return (

  // ...

  

  // ...

)

```

# Installation

  ```bash

# npm

  npm i @datsfilipe/web-ascii-theater@latest

# pnpm

  pnpm i @datsfilipe/web-ascii-theater@latest

# yarn

  yarn add @datsfilipe/web-ascii-theater@latest

  ```