update readme

This commit is contained in:
Ren Tatsumoto 2020-10-24 14:48:25 +03:00
parent 90379c7e06
commit 56b103b2bd

View file

@ -27,7 +27,7 @@ in the preferences dialog and dropping the files there.
### Using curl ### Using curl
``` ```
$ curl -o ~/.config/mpv/scripts/subs2srs.lua 'https://raw.githubusercontent.com/Ajatt-Tools/mpvacious/master/subs2srs.lua' $ curl -o ~/.config/mpv/scripts/videoclip.lua 'https://raw.githubusercontent.com/Ajatt-Tools/videoclip/master/videoclip.lua'
``` ```
### Using git ### Using git
If you already have your dotfiles set up according to If you already have your dotfiles set up according to
@ -48,18 +48,20 @@ function load(relative_path) dofile(mpv_scripts_dir_path .. relative_path) end
load("videoclip/videoclip.lua") load("videoclip/videoclip.lua")
``` ```
### Updating with git ### Updating with git
Submodules are updated using standard git commands: | Install method | Command |
``` | --- | --- |
$ config submodule update --remote --merge | Submodules | `$ config submodule update --remote --merge` |
``` | Plain git | `$ cd ~/.config/mpv/scripts/videoclip && git pull` |
or
```
$ cd ~/.config/mpv/scripts/videoclip && git pull
```
## Configuration ## Configuration
Configuration file is located at ```~/.config/mpv/script-opts/videoclip.conf``` The config file should be created by the user, if needed.
and should be created by the user if needed. If a parameter is not specified
in the config file, the default value will be used. | OS | Config location |
| --- | --- |
| GNU/Linux | `~/.config/mpv/script-opts/videoclip.conf` |
| Windows | `C:/Users/Username/AppData/Roaming/mpv/script-opts/videoclip.conf` |
If a parameter is not specified in the config file, the default value will be used.
mpv doesn't tolerate spaces before and after `=`. mpv doesn't tolerate spaces before and after `=`.
Example configuration file: Example configuration file:
@ -92,8 +94,14 @@ audio_bitrate=32k
# Create silent videoclips by default. Possble values: `yes` or `no`. # Create silent videoclips by default. Possble values: `yes` or `no`.
mute_audio=yes mute_audio=yes
``` ```
Key bindings are configured in ```~/.config/mpv/input.conf```. ### Key bindings
This step is not necessary.
| OS | Config location |
| --- | --- |
| GNU/Linux | `~/.config/mpv/input.conf` |
| Windows | `C:/Users/Username/AppData/Roaming/mpv/input.conf` |
Add this line if you want to change the key that opens the script's menu.
``` ```
c script-binding videoclip-menu-open c script-binding videoclip-menu-open
``` ```