remotion-subtitles - GitLite

KO | EN

gitlite — search

#react #ai #llm #golang #go #android #machine-learning #deep-learning #linux #awesome #cli #security #openai #open-source

remotion-subtitles

(★ 100)

Create Animated Subtitles From .SRT files in Remotion

파일 탐색기

최종 버전 다운로드 (.zip)

- BounceCaption.gif
- Caption.gif
- ColorfulCaption.gif
- ExplosiveCaption.gif
- FadeCaption.gif
- FireCaption.gif
- GlitchCaption.gif
- GlowingCaption.gif
- LightningCaption.gif
- NeonCaption.gif
- RotatingCaption.gif
- ShakeCaption.gif
- ThreeDishCaption.gif
- ThreeDishCaption2.gif
- TiltShiftCaption.gif
- TypewriterCaption.gif
- WavingCaption.gif
- ZoomCaption.gif
- - BounceCaption.js
  - Caption.js
  - ColorfulCaption.js
  - ExplosiveCaption.js
  - FadeCaption.js
  - FireCaption.js
  - GlitchCaption.js
  - GlowingCaption.js
  - index.js
  - LightningCaption.js
  - NeonCaption.js
  - RotatingCaption.js
  - ShakeCaption.js
  - ThreeDishCaption.js
  - TiltShiftCaption.js
  - TypewriterCaption.js
  - WavingCaption.js
  - ZoomCaption.js
- - SubtitleSequence.js
- index.js
.gitignore
.npmignore
LICENSE
package-lock.json
package.json
README.md
rollup.config.js
yarn.lock

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/ahgsql/remotion-subtitles

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd remotion-subtitles

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm install remotion-subtitle

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## Remotion Subtitle Library

Remotion Subtitles is a JavaScript library designed to simplify the process of adding animated subtitles or captions to your Remotion video projects. It offers easy parsing of SRT files and provides various pre-built caption templates with stunning animation effects.The library automatically handles SRT files using either comma (,) or dot (.) as the decimal separator.

## Installation

```bash
npm install remotion-subtitle
```

## Usage

Import the Library, other Captions if need, and React Hooks.

```javascript
import { SubtitleSequence } from "remotion-subtitle";
import { TypewriterCaption as Caption } from "remotion-subtitle";
import { useEffect, useState } from "react";
```

Sample Usage

```javascript
export const Subtitles = () => {
  const { fps } = useVideoConfig();
  let [Sequences, setSequences] = useState([]);
  const [loaded, setLoaded] = useState(false);
  let subtitles = new SubtitleSequence("audio.srt"); // Your srt filename from public folder.
  useEffect(() => {
    subtitles.ready().then(() => {
      setSequences(subtitles.getSequences(<Caption />, fps));
      setLoaded(true);
    });
  }, []);
  return (
    <>
      {loaded && (
        <>
          <Audio src={staticFile("ibrahim.mp3")} /> {Sequences}
        </>
      )}
    </>
  );
};
```

You can pass your custom Caption Component (should accept a prop named **text** ) inside getSequences function. If not, default h1 element will be used.

```javascript
useEffect(() => {
  subtitles.ready().then(() => {
    setSequences(subtitles.getSequences(<YourAwesomeCaption />, 30));
    setLoaded(true);
  });
}, []);
```

This library includes, **17 hand-made** styled Components for you to use.

You can import them from **"remotion-subtitle"** to use, if you want to pass custom style, go ahead.

**style** prop: Apply custom styles to your captions (e.g., color, font size)

```javascript
subtitles.getSequences(<Caption style={{ fontSize: "24px" }} />);
```

Available Caption Templates

- BounceCaption  
  ![BounceCaption](https://github.com/ahgsql/remotion-subtitles/blob/main/readme_files/BounceCaption.gif)

- ColorfulCaption  
  ![ColorfulCaption](https://github.com/ahgsql/remotion-subtitles/blob/main/readme_files/ColorfulCaption.gif)

- ExplosiveCaption  
  ![ExplosiveCaption](https://github.com/ahgsql/remotion-subtitles/blob/main/readme_files/ExplosiveCaption.gif)

- FadeCaption  
  ![FadeCaption](https://github.com/ahgsql/remotion-subtitles/blob/main/readme_files/FadeCaption.gif)

- FireCaption  
  ![FireCaption](https://github.com/ahgsql/remotion-subtitles/blob/main/readme_files/FireCaption.gif)

- GlitchCaption  
  ![GlitchCaption](https://github.com/ahgsql/remotion-subtitles/blob/main/readme_files/GlitchCaption.gif)

- GlowingCaption  
  ![GlowingCaption](https://github.com/ahgsql/remotion-subtitles/blob/main/readme_files/GlowingCaption.gif)

- LightningCaption  
  ![LightningCaption](https://github.com/ahgsql/remotion-subtitles/blob/main/readme_files/LightningCaption.gif)

- NeonCaption  
  ![NeonCaption](https://github.com/ahgsql/remotion-subtitles/blob/main/readme_files/NeonCaption.gif)

- RotatingCaption  
  ![RotatingCaption](https://github.com/ahgsql/remotion-subtitles/blob/main/readme_files/RotatingCaption.gif)

- ShakeCaption  
  ![ShakeCaption](https://github.com/ahgsql/remotion-subtitles/blob/main/readme_files/ShakeCaption.gif)

- ThreeDishCaption  
  ![ThreeDishCaption](https://github.com/ahgsql/remotion-subtitles/blob/main/readme_files/ThreeDishCaption.gif)

- TiltShiftCaption  
  ![TiltShiftCaption](https://github.com/ahgsql/remotion-subtitles/blob/main/readme_files/TiltShiftCaption.gif)

- TypewriterCaption  
  ![TypewriterCaption](https://github.com/ahgsql/remotion-subtitles/blob/main/readme_files/TypewriterCaption.gif)

- WavingCaption  
  ![WavingCaption](https://github.com/ahgsql/remotion-subtitles/blob/main/readme_files/WavingCaption.gif)

- ZoomCaption  
  ![ZoomCaption](https://github.com/ahgsql/remotion-subtitles/blob/main/readme_files/ZoomCaption.gif)

## Documentation

### SubtitleSequence Class

**constructor(filepath):** Initializes the Sequence with SRT file path.

**getSequences(customComponent,fps=30):** Generates Remotion Sequence components with captions with desired fps.
Returns Sequences with auto applied timings.

**ready** Returns a promise, to load .srt file from public/ folder.

**getArray(fps):** Returns the parsed subtitle data as an array. So you can use them as you wish.

each item has **text**, **startFrame** and **endFrame** properties.

### Caption Templates

Each template is a React component with pre-defined animation styles. You can customize the appearance further using the style prop.

## Contribution

We welcome contributions to expand the library's functionality and caption options. Here's how you can get involved:

- **Create new caption templates:** Design and implement React components with unique animation effects.

```
1. Fork this project.
2. Create .js file inside captions folder which exports a component  which accepts text and style props. This style should be combined with your styling. See premade Captions for reference.
3. export {YourComponent} from ./YourComponent inside captions/index.js file.
```

- **Improve existing templates:** Enhance the styling, animation, or performance of current captions.

- **Add features:** Contribute new features like easing options, delay support, or iteration control for animations.

- **Fix bugs and improve documentation:** Help ensure the library is robust and easy to use.

## Enjoy creating captivating videos with animated subtitles using Remotion Subtitles!

[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/ahgsql)