106 lines
4.6 KiB
Markdown
106 lines
4.6 KiB
Markdown
<p align="center">
|
|
<img width=200px height=200px src="assets/app_icons/icon-red.png"/>
|
|
</p>
|
|
|
|
<h1 align="center"> Mangayomi </h1>
|
|
|
|
<p align="center">
|
|
|
|
[](https://github.com/kodjodevf/mangayomi/releases)
|
|
[](https://github.com/kodjodevf/mangayomi/releases)
|
|
[](https://github.com/kodjodevf/mangayomi/releases)
|
|
|
|
[](https://discord.com/invite/EjfBuYahsP)
|
|
|
|
</p>
|
|
|
|
Mangayomi is free an open source manga reader and anime streaming cross-platform app inspired by Tachiyomi and Aniyomi made with Flutter. It allows users to read manga and watch anime from a variety of sources.
|
|
|
|
## Features
|
|
|
|
Features include:
|
|
* [Supports external sources](https://github.com/kodjodevf/mangayomi-extensions), utilizing the capabilities of the [dart_eval](https://pub.dev/packages/dart_eval) package & [flutter_qjs](https://github.com/kodjodevf/flutter_qjs)
|
|
* Online reading from a variety of sources
|
|
* Watching anime from a variety of sources
|
|
* Local reading of downloaded content
|
|
* A configurable reader with multiple viewers, reading directions and other settings..
|
|
* Tracker support for anime and manga: [MyAnimeList](https://myanimelist.net/), [AniList](https://anilist.co/) and [Kitsu](https://kitsu.io/) support
|
|
* Categories to organize your library
|
|
* Light and dark themes
|
|
* Create backups locally to read offline or to your desired cloud service
|
|
|
|
## Screenshots :camera:
|
|
|
|
### Mobile Screenshots
|
|
| | Reader | Player |
|
|
| -------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
|
| Views | | |
|
|
|
|
### Desktop Screenshots
|
|
| | Reader | Player |
|
|
| -------- | ------------------------------------------------- | ------------------------------------------------- |
|
|
| Views | | |
|
|
|
|
## Download
|
|
Get the app from our [releases page](https://github.com/kodjodevf/mangayomi/releases).
|
|
|
|
# Contributing
|
|
|
|
Contributions are welcome!
|
|
|
|
To get started with extension development, see [CONTRIBUTING-DART.md](https://github.com/kodjodevf/mangayomi-extensions/blob/main/CONTRIBUTING-DART.md) for create sources in Dart or [CONTRIBUTING-JS.md](https://github.com/kodjodevf/mangayomi-extensions/blob/main/CONTRIBUTING-JS.md) for create sources in JavaScript.
|
|
|
|
## Using flutter_rust_bridge
|
|
|
|
To run and build this app, you need to have
|
|
[Flutter SDK](https://docs.flutter.dev/get-started/install)
|
|
and [Rust toolchain](https://www.rust-lang.org/tools/install)
|
|
installed on your system.
|
|
You can check that your system is ready with the commands below.
|
|
Note that all the Flutter subcomponents should be installed.
|
|
|
|
```bash
|
|
rustc --version
|
|
flutter doctor
|
|
```
|
|
|
|
You also need to have the CLI tool for flutter_rust_bridge ready.
|
|
|
|
```bash
|
|
cargo install 'flutter_rust_bridge_codegen'
|
|
```
|
|
|
|
run the following command:
|
|
|
|
```bash
|
|
flutter_rust_bridge_codegen generate
|
|
```
|
|
|
|
Now you can run and build this app just like any other Flutter projects.
|
|
|
|
```bash
|
|
flutter run
|
|
```
|
|
|
|
|
|
|
|
## License
|
|
|
|
Copyright 2023 Moustapha Kodjo Amadou
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
|
|
|
|
## Disclaimer
|
|
|
|
The developer of this application does not have any affiliation with the content providers available.
|