https://github.com/coko7/tcb-opus
A discord bot to get the latest manga chapters from TCB Scans as soon as they come out.
https://github.com/coko7/tcb-opus
bot discord discord-bot manga manga-scraper manga-tracker nodejs scans scraping
Last synced: 7 months ago
JSON representation
A discord bot to get the latest manga chapters from TCB Scans as soon as they come out.
- Host: GitHub
- URL: https://github.com/coko7/tcb-opus
- Owner: Coko7
- License: mit
- Created: 2022-02-04T15:27:29.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-01T15:19:57.000Z (about 1 year ago)
- Last Synced: 2025-01-09T12:02:34.268Z (9 months ago)
- Topics: bot, discord, discord-bot, manga, manga-scraper, manga-tracker, nodejs, scans, scraping
- Language: JavaScript
- Homepage:
- Size: 60.5 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🤖 tcb-opus
`tcb-opus` is a Discord bot you can use to get the latest manga chapters from **TCBScans** as soon as they come out!
To work properly, you first need to configure one of the channels in your Discord server to follow updates from the `#releases` text channel on the official TCB Discord server. This will cause any message posted by the original TCB bot in the `#releases` channel to be forwarded to your own channel on your Discord server.
Once a message is forwarded to your Discord channel, `tcb-opus` will analyse it and determine to what manga it corresponds. Once a valid manga has been recognized, `tcb-opus` will attempt to fetch the URL of the latest chapter for that manga from TCBScans. It will then send a message containing the chapter URL to whatever channel you like on your Discord server.
## 🧰 Requirements
Please make sure you have both [npm](https://www.npmjs.com/) and [Node.js](https://nodejs.org/) **v16.6+** installed otherwise this bot will not work.
Once you have cloned the repository, simply run `npm i` to install the required dependencies on your system.
## ⚙️ Setup
### Bot token and prefix
First, you need to create a Discord application and bot on Discord [Developer Portal](https://discord.com/developers/applications).
Then, create a file named `config.json` with the following content:
```json
{
"token": "YOUR_BOT_TOKEN",
"prefix": "!"
}
```
Replace `YOUR_BOT_TOKEN` with the token of your bot.
### OPUS configuration
Now that `config.json` has been created, you need to configure the bot to listen for specific manga releases and notify users.
To do that, open the file [opus-config.json](./opus-config.json). It should have the following content by default:
```json
{
"scanSite": "https://tcbscans.com/",
"fetchMode": 2,
"mangas": [
{
"name": "One Piece",
"active": true,
"notifyRole": "DISCORD_ROLE_ID",
"fromChannel": "TCB_LISTEN_CHANNEL_ID",
"toChannel": "OPUS_NOTIFY_CHANNEL_ID",
"autoCreateThread": true
},
{
"name": "Black Clover",
"active": true,
"notifyRole": "DISCORD_ROLE_ID",
"fromChannel": "TCB_LISTEN_CHANNEL_ID",
"toChannel": "OPUS_NOTIFY_CHANNEL_ID",
"autoCreateThread": true
},
{
"name": "Hunter X Hunter",
"regex": "H(unter)?(.?)X(.?)H(unter)?",
"active": true,
"notifyRole": "DISCORD_ROLE_ID",
"fromChannel": "TCB_LISTEN_CHANNEL_ID",
"toChannel": "OPUS_NOTIFY_CHANNEL_ID",
"autoCreateThread": true
}
]
}
```
You do not need to change `scanSite` as only TCB can be used right now. `fetchMode` will control how chapter data is fetched. Two modes are available:
- **1:** The chapter number and direct URL will be fetched from TCB's Discord message
- **2:** It is possible that TCB decides to stop posting direct links to the chapter for security reasons. In that case, you can setup `tcb-opus` to scrape the website and find the direct link and chapter number itself
The default configuration registers listen events for two mangas: **One Piece** and **Black Clover**.
You can register as many mangas as you want as long as the scans exist on the TCB website.
Manga attributes:
- The `name` attribute of a manga is the most important as it is used to identify a manga on TCB. Make sure to get it right.
- The `regex` attribute is optional and may be used when TCB uses other denominations for the manga in their Discord messages.
- The `active` attribute can be used to disable notification for a specific manga without removing its configuration.
- The `notifyRole` attribute will be used in the notification message to notify a specific Discord role. The value must be a valid Discord role ID on your Discord server. _This attribute is optional. If omitted, the notification message will not ping any role._
- The `fromChannel` attribute is the Discord channel ID in which you receive TCB releases notifications.
- The `toChannel` attribute is the Discord channel ID of the channel where you want OPUS notifications to be sent.
- The `autoCreateThread` attribute is used to automatically create a thread to talk about a new chapter release. The thread will be attached to the `toChannel` channel. _This attribute is optional. If omitted, no thread will be created._
## 🚀 Launching the bot
Once, you have installed the required packages and configured [config.json](config.json), you can launch the bot simply by typing:
```
npm start
```