Tranga v2

Automatic Manga and Metadata downloader

![GitHub License](https://img.shields.io/github/license/C9glax/tranga)

## About The Project Tranga can download Chapters and Metadata from "Scanlation" sites such as - [MangaDex.org](https://mangadex.org/) (Multilingual) - [Comick.io](https://comick.io/) - ❓ Open an [issue](https://github.com/C9Glax/tranga/issues/new?assignees=&labels=New+Connector&projects=&template=new_connector.yml&title=%5BNew+Connector%5D%3A+) and trigger a library-scan with [Komga](https://komga.org/) and [Kavita](https://www.kavitareader.com/). Notifications can be sent to your devices using [Gotify](https://gotify.net/), [LunaSea](https://www.lunasea.app/) or [Ntfy](https://ntfy.sh/ ), or any other service that can use REST Webhooks. ## What this program does and does *not* do DOES: Download Images from a Website.
DOES: Create Archives.
### how: Tranga (this repository) is a REST-API and worker in one. Tranga provides REST-Endpoints to configure workers (Jobs). Requests include searches for Manga, creating and starting Jobs such as downloading available chapters. For available endpoints check `/swagger` This repository *does not* include a frontend. A frontend can take many forms, such as a website: [tranga-website](https://github.com/C9Glax/tranga-website) When downloading a chapter (meaning the images that make-up the manga) from a Website, Tranga will additionally try and scrape Metadata from the same website ~~or enhance it from third-party sources~~ ([tbd issue](https://github.com/C9Glax/tranga/issues/280)). Downloaded images can be jpeg-compressed and/or made black and white to save on diskspace (measured at least a 50% reduction in size, without a significant loss of quality). Tranga will then package the contents of each chapter in a `.cbz`-archive and place it in a common folder per Manga. If specified, Tranga will then notify library-Managers such as [Komga](https://komga.org/) and [Kavita](https://www.kavitareader.com/) to trigger a scan for new chapters. Tranga can also send notifications to your devices via third-party services such as [Gotify](https://gotify.net/), [Ntfy](https://ntfy.sh/), or any other REST Webhook. ## Screenshots This repository has no frontend, however checkout [tranga-website](https://github.com/C9Glax/tranga-website) for a default! ## Inspiration: Because [Kaizoku](https://github.com/oae/kaizoku) was relying on [mangal](https://github.com/metafates/mangal) and mangal hasn't received bugfixes for its issues with Titles not showing up, or throwing errors because of illegal characters, there were no alternatives for automatic downloads. However, [Kaizoku](https://github.com/oae/kaizoku) certainly had a great Web-UI. That is why I wanted to create my own project, in a language I understand, and that I am able to maintain myself.

(back to top)

## Endpoint Documentation Endpoints are documented in Swagger. Just spin up an instance, and go to `http:///swagger`. ## Built With - .NET - ASP.NET - Entity Framework - [PostgreSQL](https://www.postgresql.org/about/licence/) - [Swagger](https://github.com/domaindrivendev/Swashbuckle.AspNetCore/blob/master/LICENSE) - [Ngpsql](https://github.com/npgsql/npgsql/blob/main/LICENSE) - [Newtonsoft.Json](https://github.com/JamesNK/Newtonsoft.Json/blob/master/LICENSE.md) - [PuppeteerSharp](https://github.com/hardkoded/puppeteer-sharp/blob/master/LICENSE) - [Html Agility Pack (HAP)](https://github.com/zzzprojects/html-agility-pack/blob/master/LICENSE) - [Soenneker.Utils.String.NeedlemanWunsch](https://github.com/soenneker/soenneker.utils.string.needlemanwunsch/blob/main/LICENSE) - [Sixlabors.ImageSharp](https://docs-v2.sixlabors.com/articles/imagesharp/index.html#license) - 💙 Blåhaj 🦈

(back to top)

## Star History

## Getting Started ### Docker Built for AMD64 (and ARM64, maybe, if it feels like it). An example `docker-compose.yaml` is provided. Mount `/Manga` to wherever you want your chapters (`.cbz`-Archives) downloaded (where Komga/Kavita can access them for example). The file also includes [tranga-website](https://github.com/C9Glax/tranga-website) as frontend. For its configuration refer to the [Tranga-Website Repository](https://github.com/C9Glax/tranga-website) README. For compatibility do not execute the compose as root (which you should not do anyways...) but as user that can access the folder. Permission conflicts with Komga and Kavita should thus be limited. ### Bare-Metal While not supported/currently built, Tranga will also run Bare-Metal without issue. Configuration-Files will be stored per OS: - Linux `/usr/share/tranga-api` - Windows `%appdata%/tranga-api` Downloads (default) are stored in - but this can be configured in `settings.json`: - Linux `/Manga` - Windows `%currentDirectory%/Downloads` #### Prerequisits [.NET-Core 9.0](https://dotnet.microsoft.com/en-us/download/dotnet/9.0) ## Contributing If you want to contribute, please feel free to fork and create a Pull-Request! General rules: - Strongly-type your variables. This improves readability. ```csharp var xyz = Object.GetSomething(); //Do not do this. What type is xyz? Manga[] zyx = Object.GetAnotherThing(); //I can now easily see that zyx is an Array. ``` **A broad overview of where is what:**
- `Program.cs` Configuration for ASP.NET, Swagger (also in `NamedSwaggerGenOptions.cs`) - `Tranga.cs` Worker-Logic - `Schema/` Entity-Framework - `Schema/Jobs/` + Logic for Jobs - `Schema/**/` + Logic for ** - `Schema/Contexts/` EF configuration - `MangaDownloadClients/` Networking-Clients for Scraping - `Controllers/` ASP.NET Controllers (Endpoints) - `APIEndpointRecords/` Records for API-Requests with specific Request-Types (Body) If you want to add a new Website-Connector:
1. Copy one of the existing connectors, or start from scratch and inherit from `API.Schema.MangaConnectors.MangaConnector`. 2. Add the new Connector as Object-Instance in `Program.cs` to the MangaConnector-Array `connectors`. 3. In `PgsqlContext.cs` add the Discriminator for the Connector (the value is the name of the connector, as defined in the constructor). 4. In `Program.cs` add a new Object to the Array. ## License Distributed under the GNU GPLv3 License. See [LICENSE.txt](https://github.com/C9Glax/tranga/blob/master/LICENSE.txt) for more information.

(back to top)

## Acknowledgments * [Choose an Open Source License](https://choosealicense.com) * [Best-README-Template](https://github.com/othneildrew/Best-README-Template/tree/master) * [Shields.io](https://shields.io/)

(back to top)