mu-go/README.md

54 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

2022-08-24 11:44:24 +02:00
# Mugo
2022-08-23 09:12:41 +02:00
This project helps you to run a HTTP server and publish videos using an API.
2022-08-23 09:16:38 +02:00
A client gives you a way to play and download these videos in an interactive way.
2022-08-23 09:12:41 +02:00
## Installation
Builds are available for Linux (64 bits).
Download the latest binary from [releases](https://gitnet.fr/deblan/mu-go/releases).
`mpv` and `wget` are required.
## Usage
### Server side
```
2022-08-23 09:15:03 +02:00
muget serve --listen 127.0.0.1 --port 4000 --directory . --api-url http://127.0.0.1:4000
2022-08-23 09:12:41 +02:00
```
Arguments are optional.
In case of a reverse proxy, edit the API Url, eg: `--api-url https://videos.example.com`.
### Client side
```
muget play --api-url http://127.0.0.1:4000
2022-08-23 19:58:19 +02:00
muget play --api-url http://127.0.0.1:4000 1 # select the first video
2022-08-23 09:15:03 +02:00
muget download --api-url http://127.0.0.1:4000 --directory .
2022-08-23 19:58:19 +02:00
muget download --api-url http://127.0.0.1:4000 --directory . 1-10 # Download the 10 first videos
2022-08-23 09:12:41 +02:00
```
2022-08-23 09:15:03 +02:00
`--directory` is optional.
2022-08-23 09:12:41 +02:00
In case of a reverse proxy, edit the API Url, eg: `--api-url https://videos.example.com`.
By default, videos are listed from oldest to newer. You can sort by name this using `--order name`.
To search videos by name, use `--name xxxxx`.
2022-08-23 09:15:03 +02:00
2022-08-23 12:31:44 +02:00
You have several ways to select videos:
* by number:
* `10`
* `1 12 42`
* by range:
* `1-12`: equals `1 2 3 ... 12`
2022-08-23 12:32:05 +02:00
* `10-1`: equals `10 9 8 ... 1`
2022-08-23 12:31:44 +02:00
* `*` or `*+`: equals `1 2 ... x`
2022-08-26 21:13:05 +02:00
* `*-`: equals `x ... 3 2 1`
2022-08-23 12:31:44 +02:00
* `12-`: equals `12 11 10 ... 1`
* `12+`: equals `12 13 14 ... x`