tachiyomi-extensions-inspector/README.md

93 lines
6.2 KiB
Markdown
Raw Normal View History

2021-02-25 19:24:49 +01:00
2021-04-18 16:52:25 +02:00
| Build | Stable | Preview | Support Server |
|-------|----------|---------|---------|
2021-05-24 15:01:07 +02:00
| ![CI](https://github.com/Suwayomi/Tachidesk/actions/workflows/build_push.yml/badge.svg) | [![stable release](https://img.shields.io/github/release/Suwayomi/Tachidesk.svg?maxAge=3600&label=download)](https://github.com/Suwayomi/Tachidesk/releases) | [![preview](https://img.shields.io/badge/dynamic/json?url=https://github.com/Suwayomi/Tachidesk-preview/raw/main/index.json&label=download&query=$.latest&color=blue)](https://github.com/Suwayomi/Tachidesk-preview/releases/latest) | [![Discord](https://img.shields.io/discord/801021177333940224.svg?label=discord&labelColor=7289da&color=2c2f33&style=flat)](https://discord.gg/DDZdqZWaHA) |
2021-04-18 16:52:25 +02:00
# Tachidesk
2021-04-18 17:35:58 +02:00
<img src="https://github.com/Suwayomi/Tachidesk/raw/master/server/src/main/resources/icon/faviconlogo.png" alt="drawing" width="200"/>
2021-01-22 08:43:25 +01:00
A free and open source manga reader that runs extensions built for [Tachiyomi](https://tachiyomi.org/).
2021-05-07 08:54:40 +02:00
Tachidesk is an independent Tachiyomi compatible software and is **not a Fork of** Tachiyomi.
2021-05-07 12:58:30 +02:00
Tachidesk is as multi-platform as you can get. Any platform that runs java and/or has a modern browser can run it. This includes Windows, Linux, macOS, chrome OS, etc. Follow [Downloading and Running the app](#downloading-and-running-the-app) for installation instructions.
2021-01-21 22:04:49 +01:00
Ability to read and write Tachiyomi compatible backups and syncing is a planned feature.
2021-05-18 20:58:59 +02:00
**Tachidesk needs serious front-end dev help for it's reader and other parts, if you like the app and want to see it become better please don't hesitate to contribute some code!**
2021-05-18 20:57:14 +02:00
2021-02-21 22:53:44 +01:00
## Is this application usable? Should I test it?
Here is a list of current features:
2021-05-24 15:52:48 +02:00
- Installing and executing Tachiyomi's Extensions, So you'll get the same sources.
2021-02-21 22:53:44 +01:00
- A library to save your mangas and categories to put them into.
2021-02-22 12:18:17 +01:00
- Searching and browsing installed sources.
2021-03-28 03:30:34 +02:00
- A decent chapter reader.
- Ability to download Mangas for offline read
2021-04-09 22:48:15 +02:00
- Backup and restore support powered by Tachiyomi Legacy Backups
2021-02-21 22:53:44 +01:00
2021-05-15 23:23:35 +02:00
**Note:** Keep in mind that Tachidesk is alpha software and can break rarely and/or with each update. See [Troubleshooting](https://github.com/Suwayomi/Tachidesk/wiki/Troubleshooting) if it happens.
2021-02-21 22:53:44 +01:00
2021-02-21 22:58:13 +01:00
## Downloading and Running the app
2021-03-16 13:34:29 +01:00
### All Operating Systems
You should have The Java Runtime Environment(JRE) 8 or newer and a modern browser installed(Google is your friend for seeking assitance). Also an internet connection is required as almost everything this app does is downloading stuff.
2021-03-16 13:34:29 +01:00
2021-05-24 15:51:23 +02:00
Download the latest "Stable" jar release from [the releases section](https://github.com/Suwayomi/Tachidesk/releases) or a preview jar build from [the preview repository](https://github.com/Suwayomi/Tachidesk-preview/releases).
2021-03-16 20:54:14 +01:00
2021-04-10 07:43:56 +02:00
Double click on the jar file or run `java -jar Tachidesk-vX.Y.Z-rxxx.jar` (or `java -jar Tachidesk-latest.jar` if you have the latest preview) from a Terminal/Command Prompt window to run the app which will open a new browser window automatically. Also the System Tray Icon is your friend if you need to open the browser window again or close Tachidesk.
2021-02-04 22:16:46 +01:00
2021-03-16 20:44:36 +01:00
### Windows
2021-05-24 15:51:23 +02:00
Download the latest "Stable" win32 or win64 (depending on your system, usually you want win64) release from [the releases section](https://github.com/Suwayomi/Tachidesk/releases) or a preview one from [the preview repository](https://github.com/Suwayomi/Tachidesk-preview/releases).
2021-03-16 20:54:14 +01:00
2021-05-24 15:51:23 +02:00
The Windows specific build has java bundled inside, so you don't have to install java to use it. Unzip `Tachidesk-vX.Y.Z-rxxx-win64.zip` and run one of the Launcher files depending on what you want(see bellow). The rest works like the previous section.
#### Windows Launchers
- `Tachidesk Electron Launcher.bat`: Launches Tachidesk inside Electron as a desktop applicaton
- `Tachidesk Browser Launcher.bat`: Launches Tachidesk in a browser window
2021-05-24 15:52:16 +02:00
- `Tachidesk Debug Launcher.bat`: Launches Tachidesk with debug logs attached. If Tachidesk doesn't work for you, running this can give you insight into why.
2021-02-13 18:55:49 +01:00
2021-03-16 20:43:44 +01:00
### Arch Linux
You can install Tachidesk from the AUR
```
yay -S tachidesk
```
2021-03-16 20:44:36 +01:00
### Docker
Check our Offical Docker release [Tachidesk Container](https://github.com/orgs/Suwayomi/packages/container/package/tachidesk) or use [arbuilder's](https://github.com/arbuilder/Tachidesk-docker) tachidesk docker repo for installation. Source code for our container is available at [docker-tachidesk](https://github.com/Suwayomi/docker-tachidesk). By default the server will be running on http://localhost:4567 open this url in your browser.
Install from the command line:
```
$ docker pull ghcr.io/suwayomi/tachidesk
```
Run Container from the command line:
```
$ docker run -p 4567:4567 ghcr.io/suwayomi/tachidesk
```
2021-02-13 18:55:49 +01:00
2021-05-07 11:02:42 +02:00
### Using Tachidesk Remotely
2021-05-08 18:03:53 +02:00
You can run Tachidesk on your computer or a server and connect to it remotely through the web interface with a web browser on any device including a mobile or tablet or even your smart TV!, this method of using Tachidesk is only recommended if you are a power user and know what you are doing.
2021-05-07 11:02:42 +02:00
2021-05-07 16:21:47 +02:00
## Troubleshooting and Support
See [this troubleshooting wiki page](https://github.com/Suwayomi/Tachidesk/wiki/Troubleshooting).
2021-02-21 22:53:44 +01:00
## Contributing and Technical info
See [CONTRIBUTING.md](./CONTRIBUTING.md).
2021-01-21 11:11:03 +01:00
## Credit
2021-03-25 15:02:31 +01:00
This project is a spiritual successor of [TachiWeb-Server](https://github.com/Tachiweb/TachiWeb-server), Many of the ideas and the groundwork adopted in this project comes from TachiWeb.
2021-03-25 14:51:14 +01:00
2021-03-13 22:32:43 +01:00
The `AndroidCompat` module was originally developed by [@null-dev](https://github.com/null-dev) for [TachiWeb-Server](https://github.com/Tachiweb/TachiWeb-server) and is licensed under `Apache License Version 2.0`.
2021-01-21 11:12:17 +01:00
Parts of [tachiyomi](https://github.com/tachiyomiorg/tachiyomi) is adopted into this codebase, also licensed under `Apache License Version 2.0`.
2021-01-21 11:11:03 +01:00
2021-01-29 16:41:38 +01:00
You can obtain a copy of `Apache License Version 2.0` from http://www.apache.org/licenses/LICENSE-2.0
2021-01-26 20:37:54 +01:00
2021-01-29 16:41:38 +01:00
Changes to both codebases is licensed under `MPL v. 2.0` as the rest of this project.
2021-01-26 20:32:04 +01:00
## License
Copyright (C) Contributors to the Suwayomi project
This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
2021-01-03 00:46:17 +01:00
file, You can obtain one at http://mozilla.org/MPL/2.0/.