Skip to content

Latest commit

 

History

History
59 lines (45 loc) · 1.66 KB

README.md

File metadata and controls

59 lines (45 loc) · 1.66 KB

rr-dl

Royal Road Novel Downloader

Usage

rr-dl 1.2.5
-----------------------------------------------
Usage: rr-dl [options] [ARGS]

Description: A cli program for downloading novels from royalroad.com

Options:
  -a, --all                 Select all chapters
  -t, --title               Add chapter title to start of file
  -I, --indexing <int>      Index chapters starting from value
  -i, --index               Prefix title with chapter index
  -d, --directory <string>  Set download location
  -e, --extension <string>  Change file extension from md
  -h, --help                display this help and exit
  --version                 output version information and exit

About

This is a downloader focused on downloading novels in the Markdown format. This makes it simple to read in apps like Obsidian. This allows for the original formatting of the text to be preserved because it is essentially just a renamed html file. The default file extension is md but can be changed to html if you want to use a browser to display the chapters (although it is not recommended).

Examples

Search for novel

rr-dl

Search for novels titled test

rr-dl test

Search for novels titled test and select all chapters for download

rr-dl -a test

Search for novels titled test and prefix chapter titles with index + 10

rr-dl -I 10 test

Building

First install the V programming language, then run the following commands (ensure you have added v to PATH using v symlink):

git clone https://github.com/dy-tea/rr-dl.git
cd rr-dl

v run build.vsh

This will build the linux and windows versions.