Raine-gay/royal_road_archiver
1
0
Fork 0
mirror of https://github.com/Raine-gay/royal_road_archiver.git synced 2024-11-23 07:38:42 -06:00
Code Issues Packages Projects Releases Wiki Activity
Terminal based archival Program for RoyalRoad.
42 commits 3 branches 2 tags 1,012 KiB
Rust 100%
Find a file
Raine-gay 858c9be84a
Merge pull request #6 from Raine-gay/dependabot/cargo/h2-0.3.26 
Bump h2 from 0.3.24 to 0.3.26
2024-04-15 14:28:14 +01:00
.vscode Updated launch.json 2024-02-12 17:00:57 +00:00
html2xhtml-linux Bundled both windows and linux builds of html2xhtml and just generally made a bunch of work 2024-01-25 14:49:55 +00:00
html2xhtml-windows Removed some junk from html2xhtml-windows 2024-01-26 18:58:55 +00:00
src Formatted through rustfmt 2024-02-10 22:32:27 +00:00
.gitignore Updated release settings in cargo,toml 2024-01-26 21:52:49 +00:00
Cargo.lock Bump h2 from 0.3.24 to 0.3.26 2024-04-15 13:27:18 +00:00
Cargo.toml Updated version 2024-01-30 15:14:09 +00:00
html2xhtml-linux.zip html2xhtml should now extract on both windows & linux. 2024-01-26 15:44:19 +00:00
html2xhtml-windows.zip Removed some junk from html2xhtml-windows 2024-01-26 18:58:55 +00:00
LICENSE Added description and license 2024-01-26 22:28:44 +00:00
README.md Update README.md 2024-01-28 18:26:18 +00:00
rustfmt.toml Edited rustfmt 2024-02-10 22:41:04 +00:00
TODO Updated to v1.0.1, redid all the error handling, made the library better. 2024-01-28 18:18:40 +00:00

README.md

Terminal based archival Program for RoyalRoad.

Currently supports:

  • Epub generation - Turn the webnovels into an epub file for offline reading / archival.
  • Markdown generation - Turn the webnovels into a markdown file. Dunno why you'd want to do this but hey, you can.

Coming soon:

  • Audiobook generation support.
  • HTML + CSS archival. Think archive.org, but on your machine.

How to use:

  • Windows - Download the binaries (.exe files) for windows from the releases page,
    Unzip them into a folder E.G Downloads,
    Open Command prompt,
    Change the directory to where you unzipped the binaries (.exe files) by typing cd <Binaries_Directory>\royal_road_archiver_windows-bin E.G cd Downloads\royal_road_archiver_windows-bin,
    Open the program by typing royal_road_archiver.exe

  • Linux - Basically the same as windows:
    Download the linux binaries from the releases page,
    Unzip em,
    Open console,
    cd to the folder containing the binaries,
    Run it using royal_road_archiver

  • Cargo - Run cargo install royal_road_archiver,
    Then just run royal_road_archiver from the terminal.
    DOES NOT WORK ON WINDOWS.

Example commands:

  • royal_road_archiver https://www.royalroad.com/fiction/59450/bioshifter epub --- Will create an Epub version of the novel bioshifter in the current directory.
  • royal_road_archiver https://www.royalroad.com/fiction/59450/bioshifter markdown --no-image-tags --- Will create a markdown version of the novel bioshifter in the current directory, removing image tags from the markdown file.
  • royal_road_archiver https://www.royalroad.com/fiction/59450/bioshifter Downloads epub --- Will create an Epub version of the novel bioshifter in my Downloads folder.
  • Look the commands are all documented in the program just running royal_road_archiver help will show you everything.

Enjoy.