Lightnovel Crawler
-brown?logo=linux&style=for-the-badge){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
- Lightnovel Crawler
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.
Standalone Bundle (Windows, Linux)
⏬ Windows: lncrawl.exe ~ 25MB
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.
⏬ Linux: lncrawl ~ 30MB
It is recommended to install via pip if you are on Linux
⏬ To get older versions visit the Releases page
PIP (Windows, Mac, and Linux)
📦 A python package named lightnovel-crawler is available at pypi.
Make sure you have installed Python v3.6 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
Termux (Android)
There is no official support to run python in mobile devices. It is not guaranteed that the app will run smoothly in 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-turbopip 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 can navigate up using Volume UP + W and down using Volume UP + S.
When there is a new update available, you can install it just by running pip install -U lightnovel-crawler. You will not have to run all the above commands again.
PyDroid
You can also use PyDroid in Android phones. Check this discussion for a custom script to run the app: dipu-bd#1137
Chatbots
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
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.
Heroku Deployment
Simply fill out the environment variables and you get a running instance.
Running 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.6 or higher):
$ python lncrawlRunning the Bots
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 calibre for pdf, mobi etc. formats.
-
Install requirements
$ pip3 install --user -r requirements.txt-
Copy
.env.examplefile to.envfile. Edit this file and give your API credentials here. -
To run the discord bot:
$ python3 lncrawl --bot discord --shard-id 0 --shard-count 1- To run the telegram bot
$ python3 lncrawl --bot telegramThere is a start.sh script to run a bot in ubuntu servers. It will basically execute the python3 lncrawl and send the task to run in background. I use it to run my discord bot in the server.
General Usage
Available options
$ lncrawl -h
================================================================================
╭╮╱╱╱╱╱╱╭╮╱╭╮╱╱╱╱╱╱╱╱╱╱╱╱╭╮╱╭━━━╮╱╱╱╱╱╱╱╱╱╭╮
┃┃╱╱╱╱╱╱┃┃╭╯╰╮╱╱╱╱╱╱╱╱╱╱╱┃┃╱┃╭━╮┃╱╱╱╱╱╱╱╱╱┃┃
┃┃╱╱╭┳━━┫╰┻╮╭╋━╮╭━━┳╮╭┳━━┫┃╱┃┃╱╰╋━┳━━┳╮╭╮╭┫┃╭━━┳━╮
┃┃╱╭╋┫╭╮┃╭╮┃┃┃╭╮┫╭╮┃╰╯┃┃━┫┃╱┃┃╱╭┫╭┫╭╮┃╰╯╰╯┃┃┃┃━┫╭╯
┃╰━╯┃┃╰╯┃┃┃┃╰┫┃┃┃╰╯┣╮╭┫┃━┫╰╮┃╰━╯┃┃┃╭╮┣╮╭╮╭┫╰┫┃━┫┃
╰━━━┻┻━╮┣╯╰┻━┻╯╰┻━━╯╰╯╰━━┻━╯╰━━━┻╯╰╯╰╯╰╯╰╯╰━┻━━┻╯
╱╱╱╱╱╭━╯┃ v2.28.11
╱╱╱╱╱╰━━╯ 🔗 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.
--crawler [FILES ...]
Load additional crawler files.
-s URL, --source URL Profile page url of the novel.
-q STR, --query STR Novel query followed by list of source sites.
-x [REGEX], --sources [REGEX]
Filter out the sources to search for novels.
--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 ...] The list of volume numbers to download.
--chapters [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.
--resume [NAME/URL] Resume download of a novel containing in
/home/runner/work/lightnovel-crawler/lightnovel-
crawler/Lightnovels
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"
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~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 -s https://novelfull.com/release-that-witch.html --chapters https://novelfull.com/release-that-witch/chapter-6-training-part-i.html https://novelfull.com/release-that-witch/chapter-8-months-of-the-demons-part-1.html -
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
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.
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
Adding new Bot
- Create a new bot file using
bots/_sample.pyas template. - Import bot to
bots/__init__.pyfile.
Supported sources
Request new one by creating a new issue.
We are supporting 204 sources and 222 crawlers.
ar Arabic
| Source URL | Version | Contributors | |
|---|---|---|---|
| 🔍 | https://arnovel.me/ | 18 |   |
en English
es Spanish, Castilian
| Source URL | Version | Contributors | |
|---|---|---|---|
| https://cclawtranslations.home.blog/ | 67 |   |
|
| https://domentranslations.wordpress.com/ | 67 | |
id Indonesian
multi Multilingual
| Source URL | Version | Contributors | |
|---|---|---|---|
| 🤖🔍 | http://es.mtlnovel.com/ | 19 |   |
| 🤖🔍 | http://fr.mtlnovel.com/ | 19 | |
| 🤖🔍 | http://id.mtlnovel.com/ | 19 | |
| 🤖🔍 | http://www.mtlnovel.com/ | 19 | |
| 🔍 | https://18.foxaholic.com/ | 71 |   |
| 🤖🔍 | https://es.mtlnovel.com/ | 19 | |
| 🔍 | https://foxaholic.com/ | 71 | |
| 🤖🔍 | https://fr.mtlnovel.com/ | 19 | |
| 🔍 | https://global.foxaholic.com/ | 71 | |
| 🤖🔍 | https://id.mtlnovel.com/ | 19 | |
| https://my.w.tt/ | 62 | |
|
| 🔍 | https://www.foxaholic.com/ | 71 | |
| 🤖🔍 | https://www.mtlnovel.com/ | 19 | |
| https://www.wattpad.com/ | 62 | |
ru Russian
| Source URL | Version | Contributors | |
|---|---|---|---|
| 🔍 | https://litnet.com/ | 2 | |
vi Vietnamese
| Source URL | Version | Contributors | |
|---|---|---|---|
| 🤖🔍 | https://docln.net/ | 2 | |
| 🤖🔍 | https://ln.hako.re/ | 2 | |
| 🤖🔍 | https://truyenfull.vn/ | 1 | |
| 🤖🔍 | https://truyentr.info/ | 1 | |
zh Chinese
| Source URL | Version | Contributors | |
|---|---|---|---|
| https://book.qidian.com/ | 10 | |
|
| 🔍 | https://tw.m.ixdzs.com/ | 2 |  |
| https://www.aixdzs.com/ | 13 | |
|
| https://www.daocaorenshuwu.com/ | 55 | |
Rejected sources
Supported output formats
- JSON
- EPUB
- TEXT
- WEB
- DOCX
- MOBI
- RTF
- TXT
- AZW3
- FB2
- LIT
- LRF
- OEB
- PDB
- PML
- RB
- SNB
- TCR
- HTML