Skip to content

Commit 13fb2ab

Browse files
Updated readme with new features.
1 parent 65e30b0 commit 13fb2ab

File tree

1 file changed

+33
-12
lines changed

1 file changed

+33
-12
lines changed

README.md

Lines changed: 33 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,43 @@
22

33
You go onto [twitch.tv](https://twitch.tv/), your usual streamers are not there, or you have not found one you like yet, you keep on aimlessly clicking to find the one streamer to waste your time on. Not any more! `ryck.py` aims to automate this process for you! Run it, and streams will start flowing! With the press of a single key you go to the next.
44

5-
This project is still in the early stages, so not all features have yet been implemented.
6-
75
## Usage
86

9-
There is basically nothing to do but to run the script at this point
7+
The short story is that you can just run it (make sure it is in your `$PATH`)
108

119
```
12-
$ ./ryck.py
10+
$ ryck.py
1311
```
1412

15-
which will start playing all currently live twitch streams under 'IRL' with the English language. This is all hard-coded, so change the code if you wanna change those defaults. Press `q` to go to the next, and `Ctrl+c` to stop.
13+
and it will start playing streams from 'IRL' in English. Check out the 'Key-mapping' section below to see how to control the streams.
14+
15+
The long story is told by the help:
16+
17+
```
18+
$ ./github/ryck/ryck.py --help
19+
usage: ryck.py [options] [-- [mpv]]
20+
21+
Stream twitch streams instead of browsing them.
22+
23+
positional arguments:
24+
mpv Arguments to pass to `mpv`.
25+
26+
optional arguments:
27+
-h, --help show this help message and exit
28+
--game GAME Change the "game"-type twitch streams should be fetched
29+
from.
30+
--lang LANGUAGE Change the language the stream should be in.
31+
--max MAX Set how many streams should be fetched (0 or lower means
32+
all).
33+
--sort SORT Sort streams to be played after "random" or anything else
34+
(which uses twitch default popularity sorting).
35+
--gen-input Ryck will generate a new input.conf and backup the old.
36+
--print-game Prints known game options.
37+
--print-lang Prints known language options.
38+
--play-mem Ryck will play the streams saved by user (`R` (`shift+r`)),
39+
available in `~/.ryck/remember`
40+
--version Prints version number and exits.
41+
```
1642

1743
### Key-mapping
1844

@@ -28,11 +54,6 @@ Ryck will generate a `input.conf`-file (to be stored in `~/.ryck/`) and override
2854

2955
Generally this is suppose to be quite featureless, but some small goodies should be added
3056

31-
* argparse
32-
- to change language
33-
- figure out all the language names
34-
- to change 'game'
35-
- figure out all the 'game' names
36-
- Sorting option (now just random, but also popularity, others?)
3757
* Perhaps integrate initiating irssi and jump into the chat
38-
* Option to play only remembered streams
58+
* add more languages
59+
* add more games

0 commit comments

Comments
 (0)