Metadata-Version: 2.1
Name: panda3d-subtitler
Version: 22.6
Summary: A simple file and folder browser for Panda3D
Home-page: https://github.com/fireclawthefox/panda3d-subtitler
Author: Fireclaw
Author-email: fireclawthefox@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Topic :: Multimedia :: Video
Classifier: Topic :: Multimedia :: Sound/Audio
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# Panda3D Subtitler
A subtitle reader/renderer for the Panda3D game engine

## Features
This library extends the game engine by a simple subtitle reader/renderer. You just open an existing subtitle file, sync it to the audio or video and you'll have subtitles in your panda3d application.

Currently this library only supports SubRip subtitle (.srt) files.

## Install
Install the subtitler via pip

```bash
pip install panda3d-subtitler
```

## How to use
To add a browser instance to your running Panda3D application, just instantiate it like shown here:
```python3
from subtitler.subtitler import Subtitler

mySound = loader.loadSfx("someAudioFile.ogg")

subtitles = Subtitler("subtitles")
subtitles.loadSubtitleFile("./mySubtitles.srt")
subtitles.synchronizeToAudio(mySound)
```
