mirror of
https://github.com/tachiyomiorg/tachiyomi-extensions-inspector.git
synced 2024-11-01 15:05:06 +01:00
ef07b9b4ce
* Update README.md update docker info * [SKIP CI] update docker info * [SKIP CI] Update Readme change to small case
93 lines
6.2 KiB
Markdown
93 lines
6.2 KiB
Markdown
|
|
| Build | Stable | Preview | Support Server |
|
|
|-------|----------|---------|---------|
|
|
|  | [](https://github.com/Suwayomi/Tachidesk/releases) | [](https://github.com/Suwayomi/Tachidesk-preview/releases/latest) | [](https://discord.gg/DDZdqZWaHA) |
|
|
|
|
# Tachidesk
|
|
<img src="https://github.com/Suwayomi/Tachidesk/raw/master/server/src/main/resources/icon/faviconlogo.png" alt="drawing" width="200"/>
|
|
|
|
A free and open source manga reader that runs extensions built for [Tachiyomi](https://tachiyomi.org/).
|
|
|
|
Tachidesk is an independent Tachiyomi compatible software and is **not a Fork of** Tachiyomi.
|
|
|
|
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.
|
|
|
|
Ability to read and write Tachiyomi compatible backups and syncing is a planned feature.
|
|
|
|
**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!**
|
|
|
|
## Is this application usable? Should I test it?
|
|
Here is a list of current features:
|
|
|
|
- Installing and executing Tachiyomi's Extensions, So you'll get the same sources.
|
|
- A library to save your mangas and categories to put them into.
|
|
- Searching and browsing installed sources.
|
|
- A decent chapter reader.
|
|
- Ability to download Mangas for offline read(This partially works)
|
|
- Backup and restore support powered by Tachiyomi Legacy Backups
|
|
|
|
**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.
|
|
|
|
## Downloading and Running the app
|
|
### 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.
|
|
|
|
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).
|
|
|
|
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.
|
|
|
|
### Windows
|
|
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).
|
|
|
|
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
|
|
- `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.
|
|
|
|
### Arch Linux
|
|
You can install Tachidesk from the AUR
|
|
```
|
|
yay -S tachidesk
|
|
```
|
|
|
|
### 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
|
|
```
|
|
|
|
### Using Tachidesk Remotely
|
|
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.
|
|
|
|
## Troubleshooting and Support
|
|
See [this troubleshooting wiki page](https://github.com/Suwayomi/Tachidesk/wiki/Troubleshooting).
|
|
|
|
## Contributing and Technical info
|
|
See [CONTRIBUTING.md](./CONTRIBUTING.md).
|
|
|
|
## Credit
|
|
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.
|
|
|
|
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`.
|
|
|
|
Parts of [tachiyomi](https://github.com/tachiyomiorg/tachiyomi) is adopted into this codebase, also licensed under `Apache License Version 2.0`.
|
|
|
|
You can obtain a copy of `Apache License Version 2.0` from http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Changes to both codebases is licensed under `MPL v. 2.0` as the rest of this project.
|
|
|
|
## 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
|
|
file, You can obtain one at http://mozilla.org/MPL/2.0/.
|