aboutsummaryrefslogtreecommitdiff
path: root/readme.md
blob: 776b3e5915ffae9dc8187813c9897507d49b9952 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# Jellything

Jellything (not to be confused with "Jellyfin") is a media streaming software,
optimizied for serving movies and such.

## Features

- A functional and visually appealing user interface
- Remuxing media on-the-fly to avoid downloading unneccesary tracks. (Jellyfin
  cant do that!)
- Multiple streaming formats
  - Matroska or WebM (dynamic remux)
  - Original (exact copy from disk, no remuxing)
  - HLS
  - JHLS (our own format)
- Javascript video player
- Adaptive bitrate and real-time transcoding
- Blazingly fast 🚀 🚀

## Usage

Requirements:

- esbuild
- dav1d
- nasm
- nightly rust toolchain

```sh
cargo +nightly install jellything --git https://codeberg.org/metamuffin/jellything.git
cargo +nightly install jellytool --git https://codeberg.org/metamuffin/jellything.git
jellytool init --brand 'Blubflix' data # data will be a directory containing all the instances data
jellything data/config.yaml
```

## Licence

The Licence is AGPL-3.0-only, see `COPYING`

## API

See [`api.md`](./api.md)