movie-rename/README.md

22 lines
1.3 KiB
Markdown
Raw Normal View History

2022-12-08 01:03:56 -06:00
# movie-rename
2022-12-08 22:08:16 -06:00
### A simple tool to rename movies, written in Rust.
2022-12-08 01:03:56 -06:00
This is made mostly due to [mnamer](https://github.com/jkwill87/mnamer) not having support for director's name, and partly because I wanted to try writing something useful in Rust.
2022-12-08 22:08:16 -06:00
## Installation
Install from [AUR](https://aur.archlinux.org/packages/movie_rename), my personal [lure-repo](https://github.com/SinTan1729/lure-repo) or download the binary from the releases.
2022-12-08 01:03:56 -06:00
2022-12-08 22:08:16 -06:00
## Notes
- The expected syntax is:
`movie_rename <filename(s)> [-n|--dry-run] [-d|--directory] [-h|--help] [-v|--version]`
2022-12-08 21:59:53 -06:00
- There needs to be a config file named movie_rename.conf in your $XDG_CONFIG_HOME.
2022-12-08 01:03:56 -06:00
- It should consist of two lines. The first line should have your TMDb API key.
- The second line should have a pattern, that will be used for the rename.
- In the pattern, the variables need to be enclosed in {{}}, the supported variables are `title`, `year` and `director`.
- Default pattern is `{title} ({year}) - {director}`. Extension is always kept.
2022-12-08 21:23:58 -06:00
- Passing `--directory` assumes that the arguments are directory names, which contain exactly one movie and optionally subtitles.
2022-12-08 01:03:56 -06:00
2022-12-08 22:08:16 -06:00
- I plan to add more variables in the future. Support for TV Shows will not be added, since [tvnamer](https://github.com/dbr/tvnamer) does that excellently.