Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/crolbar/matm

watch anime, movies, tv shows and read manga from comfort of the cli
https://github.com/crolbar/matm

anime cli free fzf manga manga-reader movie movies mpv rust rust-lang scraper webscraping

Last synced: 1 day ago
JSON representation

watch anime, movies, tv shows and read manga from comfort of the cli

Awesome Lists containing this project

README

        


A tool to watch anime, movies, tv shows and read manga from the comfort of the terminal!


matm works by scraping
aniwatch.to,
flixhq.to,
manganato.com
then playing the video through
mpv and
zathura for manga

# Install
### You are at your own risk when using this tool!

## Linux

### Arch
Install from the AUR
```
yay -S matm-bin
```
if the release dosnt work there is a git version `matm-git`
- the histroy file is in `~/.local/state/matm`
- the cache dir for manga is `~/.cache/matm`

## Windows
no

## Manual

### Build
You can build it from source on any linux distribution. (make sure you have all dependencies)
```
git clone https://github.com/crolbar/matm
cd matm
cargo build --release
```

### Running
The binary is in `target/release` so you can:
```
cd target/release
./matm
```

If you get "permission denied" make sure the binary is executable
```
chmod +x matm
```

Then you can cp the binary into your $PATH
```
sudo cp matm /usr/bin
```
You can remove the cloned repo if you want
```
cd ../../..
rm -rf matm
```

# Dependencies
#### Usage
- `mpv`
- `zathura-cb`
- `fzf` (for versions before 2.0)
#### Make
- `git`
- `cargo`

### AUR packages:
```
yay -S --needed mpv zathura-cb git cargo
```

# Usage
Watching anime

```
matm ani
```
You can use `matm a` for short

#### Continue to watch from history
```
matm a -c
```

#### Watch the dubbed versioin
```
matm a --dub
```

#### Get the help menu
```
matm a --help
```

Watching movies or tv shows

```
matm mov
```
You can use `matm m` for short

#### Continue to watch from history
```
matm m -c
```

#### Use vlc insead of mpv (not recommended)
Sometimes takes a bit to load
```
matm m --vlc
```

#### Get the help menu
```
matm m --help
```
Reading manga

```
matm man
```
You can use `matm ma` for short

#### Continue to watch from history
```
matm ma -c
```

#### Clean the cache directory
```
matm ma --clean
```

#### Get the help menu
```
matm ma --help
```
Selector

- Exit: `Esc`, `Alt + q`, `ctrl + c`
- Up: `arrow-up`, `alt + k`, `shift + tab`, `scrollup`
- Down: `arrow-down`, `alt + j`, `tab`, `scrolldown``
- Top: `PageUp`, `Home`, `alt + g`
- Bottom: `PageDown`, `End`, `alt + shift + g`
- Select: `Enter`, `double left click`

# Uninstall
### AUR
```
yay -R matm-bin
```
or if you are using the git version `matm-git`

### Manual
you can basically remove the binary file
```
sudo rm $(which matm)
```
and state and cache folders
```
rm -rf ~/.local/state/matm
rm -rf ~/.cache/matm
```

# Credits
- [ani-cli](https://github.com/pystardust/ani-cli): inspiration for this project
- [justchokingaround](https://github.com/justchokingaround): mmm lobster