Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dy-tea/rr-dl
Royal Road Novel Downloader
https://github.com/dy-tea/rr-dl
downloader markdown vlang
Last synced: 6 days ago
JSON representation
Royal Road Novel Downloader
- Host: GitHub
- URL: https://github.com/dy-tea/rr-dl
- Owner: dy-tea
- License: gpl-3.0
- Created: 2024-03-28T11:01:17.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-12-21T18:17:25.000Z (29 days ago)
- Last Synced: 2024-12-21T19:22:13.359Z (29 days ago)
- Topics: downloader, markdown, vlang
- Language: V
- Homepage:
- Size: 41 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- trackawesomelist - rr-dl (⭐1) - Royal-Road Novel downloader. (Recently Updated / [Dec 22, 2024](/content/2024/12/22/README.md))
README
# 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 Index chapters starting from value
-i, --index Prefix title with chapter index
-d, --directory Set download location
-e, --extension 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](https://obsidian.md). 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](https://vlang.io), 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.