An open API service indexing awesome lists of open source software.

https://github.com/joelmon/scriptx

ScriptX extracts scriptures from the American Sign Language version of the New World Translation Bible.
https://github.com/joelmon/scriptx

asl bible cli ffmpeg jehovahs-witnesses video

Last synced: 7 months ago
JSON representation

ScriptX extracts scriptures from the American Sign Language version of the New World Translation Bible.

Awesome Lists containing this project

README

          

# ScriptX
[![Rust](https://github.com/JoelMon/scriptx/actions/workflows/rust.yml/badge.svg)](https://github.com/JoelMon/scriptx/actions/workflows/rust.yml)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

ScriptX is a command line tool designed to extract scriptures out of the American Sign Language version of the [New World Translation](https://www.jw.org/ase/library/bible/nwt/books/), NWT, Bible published by the [Watch Tower Bible and Tract Society of Pennsylvania](https://www.JW.org). It is useful when you need specific scripture(s) in a standalone file. A quick example would be if you need to splice scriptures into another video.

All the meta data stored within the original file is retained even after being extracted, so when extracting a range you will still have access to chapter markers within your extracted video.

## Features
- Extract single or a range of scriptures eg. `-v 5-10` extracts verses ranging from 5 to 10
- Extracts all scriptures into individual files with `-a`
- Maintains all metadata from the original file
- Doesn't transcode so blazing :fire: fast!

![scriptx-demo](https://user-images.githubusercontent.com/6587811/121826488-e6cf6400-cc85-11eb-8604-39dc87910e08.gif)

## Known Issues
Some scripture videos files that can be downloaded from [https://www.jw.org](https://www.jw.org/ase/library/bible/nwt/books/) do not contain the meta data necessary for ScriptX to process. At the moment there are not work around for this problem. If ScriptX is ran on a file that causes a crash, this is likely the problem.

## Dependencies
[ffmpeg](https://ffmpeg.org/) is required and has to be installed.

## Installation
ScriptX hasn't been tested on Windows but it should work. If it doesn't create an [issue](https://github.com/JoelMon/scriptx/issues) and I will look into it.

### From Source
Use [Cargo](https://doc.rust-lang.org/cargo/) to install ScriptX.

```bash
$ cargo install scriptx
```

If you prefer to install using the repository instead:

```bash
$ cargo install --git https://github.com/JoelMon/scriptx
```

### Package
Ubuntu deb packages for amd64 systems are provided in the [releases](https://github.com/JoelMon/scriptx/releases).

## Usage

```text
ScriptX is a command line tool to extract scriptures out of the American Sign Language version of the New World
Translation.

USAGE:
scriptx [OPTIONS] --file <--all|--verse >

FLAGS:
-a, --all Extracts all scriptures from the file.
-h, --help Prints help information
-V, --version Prints version information

OPTIONS:
-f, --file The input video file to process.
-o, --output The path were to save the output file. [default: output.m4v]
-v, --verse The verse to be extracted out. A single verse or a range of verses can be extracted.
e.g. 2-5

```
## Contributing
Pull requests are welcome. For major changes or if unsure about a contribution, please open an [issue](https://github.com/JoelMon/scriptx/issues) first to discuss what you would like to change.

Please, also remember to run tests to make sure everything is okay.

## License
[MIT](https://choosealicense.com/licenses/mit/)

## Note
This project, ScriptX, is not made by nor is it associated with the [Watch Tower Bible and Tract Society of Pennsylvania](https://www.JW.org).