Lightnovel Crawler 
-brown){kind=icon}
An app to download novels from online sources and generate e-books.
Discord: https://discord.gg/wMECG2Q
Telegram: https://t.me/epub_smelter_bot
Table of contents
(A) Installation
This application uses Calibre to convert ebooks.
Install it from https://calibre-ebook.com/download
Without it, you will only get output in epub, text, and web formats.
A1. Standalone Bundle (Windows, Linux)
⏬ Windows: lightnovel-crawler v2.24.5 ~ 23MB
In Windows 8, 10 or later versions, it might say that
lncrawl.exeis not safe to dowload or execute. You should bypass/ignore this security check to execute this program.
To get older versions visit the Releases page
⏬ Linux: lightnovel-crawler v2.24.5 ~ 24MB
Copy it to
/usr/binor~/.local/binto make it accessible in terminal. Or, you can create a launcher to easily access the app. However, it is recommended to use pip version directly if you are on Linux
A2. PIP (Windows, Mac, and Linux)
📦 A python package named lightnovel-crawler is available at pypi.
Make sure you have installed Python v3.5 or higher and have pip enabled. Visit these links to install python with pip in Windows, Linux and MacOS. Feel free to ask on the Discord server if you are stuck.
To install this app or to update installed one via pip, just run:
$ pip install --user -U lightnovel-crawlerIn some cases you have to use python3 -m pip or pip3 or python -m pip. And you do not need --user option, if you are running from root.
Next, open your terminal and enter:
$ lightnovel-crawler
# Or, a shortcut:
$ lncrawlTo view extra logs, use:
lncrawl -lll
A3. Termux (Android)
Mobile platforms are unpredictable. It is not guaranteed that the app will run on all devices. It is recommended to use the bots on either Discord or Telegram if you are on mobile.
📱 Using Termux, you can run this app in your android phones too. Follow this instructions:
- Install Termux from playstore.
- Open the app and run these commands one by one:
apt update && apt upgradetermux-setup-storagepkg install ndk-sysroot make python zlib clangpkg install libxml2 libxslt libiconv libcrypt libffi zlib libjpeg-turbopkg install nodejs-ltspip install -U lightnovel-crawlerto install the latest version of this app.
- Now exit the console and relaunch it.
- Type
cd ~/storage/downloadsto store novels there. - Type
lncrawlto start. - You navigate up using Volume UP + W and down using Volume UP + S.
- Run
pip install -U lightnovel-crawleragain to install the latest updates.
A4. Chatbots
A4.1 Discord
Join our server: https://discord.gg/7A5Hktx
Or, visit this link to install discord bot to your own server: https://discordapp.com/oauth2/authorize?client_id=537526751170002946&permissions=51264&scope=bot
A4.2 Telegram
Visit this link to get started with the telegram bot: https://t.me/epub_smelter_bot
Send !help to open the bot help message.
A5. Run from source
- First clone the repository:
$ git clone https://github.com/dipu-bd/lightnovel-crawler- Open command prompt inside of the project folder and install requirements:
$ pip install --user -r requirements.txt- Run the program (use python v3.5 or higher):
$ python __main__.py
# Or, in short,
$ python .A6. Heroku Deployment
Simply fill out the environment variables and you get a running instance.
(B) General Usage
B1. Available options
$ lncrawl -h
================================================================================
📒 Lightnovel Crawler 🍀2.24.0
https://github.com/dipu-bd/lightnovel-crawler
--------------------------------------------------------------------------------
usage: lncrawl [options...]
lightnovel-crawler [options...]
optional arguments:
-h, --help show this help message and exit
-v, --version show program's version number and exit
-l Set log levels. (-l = warn, -ll = info, -lll = debug).
--list-sources Display a list of available sources.
-s URL, --source URL Profile page url of the novel.
-q STR, --query STR Novel query followed by list of source sites.
-x, --sources Display the source selection menu while searching.
--login USER PASSWD User name/email address and password for login.
--format E [E ...] Define which formats to output. Default: all.
--add-source-url Add source url at the end of each chapter.
--single Put everything in a single book.
--multi Build separate books by volumes.
-o PATH, --output PATH
Path where the downloads to be stored.
--filename NAME Set the output file name
--filename-only Skip appending chapter range with file name
-f, --force Force replace any existing folder.
-i, --ignore Ignore any existing folder (do not replace).
--all Download all chapters.
--first [COUNT] Download first few chapters (default: 10).
--last [COUNT] Download last few chapters (default: 10).
--page START STOP. The start and final chapter urls.
--range FROM TO. The start and final chapter indexes.
--volumes [N [N ...]]
The list of volume numbers to download.
--chapters [URL [URL ...]]
A list of specific chapter urls.
--bot {console,telegram,discord,test}
Select a bot. Default: console.
--shard-id [SHARD_ID]
Discord bot shard id (default: 0)
--shard-count [SHARD_COUNT]
Discord bot shard counts (default: 1)
--suppress Suppress all input prompts and use defaults.
ENV [chatbots only] Pass query string at the end of all options. It will be use instead of .env
file. Sample: "BOT=discord&DISCORD_TOKEN=***&LOG_LEVEL=DEBUG"
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~B2. Example Usage
Open your console and type lncrawl --version first to check if you have installed it properly.
Here are some example usage of the app:
-
To start an interactive session:
lncrawl -
To download using an url:
lncrawl -s https://boxnovel.com/novel/reincarnation-of-the-strongest-sword-god/ -
To search novels:
lncrawl -q "Strongest Sword God" -
To search novels from selected sources:
lncrawl -q "Strongest Sword God" --sources -
To download all chapters:
lncrawl --all -
To download first 25 chapters:
lncrawl --first 25 -
To download all between two chapters:
lncrawl --range 10 30 -
To download all between two chapter links:
lncrawl https://boxnovel.com/novel/reincarnation-of-the-strongest-sword-god/chapter-2205 https://boxnovel.com/novel/reincarnation-of-the-strongest-sword-god/chapter-2211 -
To download a specific volumes:
lncrawl --volumes 2 3 -
To define output path:
lncrawl -o "D:\Lightnovels\reincarnation-of-the-strongest-sword-god" -
To delete the output folder if exists:
lncrawl -f -
To ignore the output folder if exists:
lncrawl -i -
To resume download where is has been left previously:
lncrawl -i -
To specify output formats:
lncrawl --format epub pdf mobi -
To display list of supported sources:
lncrawl ---list-sources -
If you provide an option in the argument, it will skip it in the interactive session. If you want to disable all interactive prompts, pass
--suppressat the end. -
You can stack up options like this:
lncrawl -s https://boxnovel.com/novel/reincarnation-of-the-strongest-sword-god/ -o "D:\Lightnovels\reincarnation-of-the-strongest-sword-god" --last 50 -i --format pdf --suppress
B3. Running the bot
There are two chatbots available at this moment: Telegram and Discord. To run your own bot server, follow these instructions:
# Clone this repository
$ git clone https://github.com/dipu-bd/lightnovel-crawler
# Install requirements
$ pip3 install --user -r requirements.txt
$ pip3 install --user -r bot_requirements.txt
# Edit the environment variables
# You should give your API keys and log info here
# Also specify which bot server you want to run
$ cp .env.example .env
$ vim .env
# Run the server using:
$ python3 .There is a server.sh script to run a bot in ubuntu servers. It will basically execute the python __main__.py and send the task to run in background. I use it to run my discord bot in the server.
(C) Development
You are very welcome to contribute in this project. You can:
- create new issues pointing out the bugs.
- solve existing issues.
- add your own sources.
- add new output formats.
- create new bots.
C1. Adding new source
- Create new crawler using the
sources/_template_.pyas template. - Update Supported sources section in
README.md - Add some test inputs to
test_user_inputsvariable inlncrawl/bots/test/test_inputs.py
C2. Adding new Bot
- Create a new bot file using
bots/_sample.pyas template. - Import bot to
bots/__init__.pyfile.
C3. Supported sources
Request new one by creating a new issue.
C4. Rejected sources
| Rejected Sources | Reason |
|---|---|
| http://fullnovel.live | 403 - Forbidden: Access is denied |
| http://gravitytales.com | Redirects to webnovel.com |
| http://moonbunnycafe.com | Does not follow uniform format |
| https://anythingnovel.com | Site broken |
| https://chrysanthemumgarden.com | Removed on request of the owner #649 |
| https://indomtl.com | Does not like to be crawled |
| https://lnindo.org | Does not like to be crawled |
| https://mtled-novels.com | Domain is expired |
| https://novelplanet.com | Site is closed |
| https://www.flying-lines.com | Obfuscated content |
| https://www.jieruihao.cn | Unavailable |
| https://www.noveluniverse.com | Site is down |
| https://www.novelupdates.com | Does not host any novels |
| https://www.novelv.com | Site is down |
| https://www.rebirth.online | Site moved |
C5. Supported output formats
- JSON (default)
- EPUB (default)
- TEXT
- WEB
- DOCX
- MOBI
- RTF
- TXT
- AZW3
- FB2
- LIT
- LRF
- OEB
- PDB
- PML
- RB
- SNB
- TCR
- HTML
C6. Supported bots
- Console Bot
- Telegram Bot
- Discord Bot