Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
184 changes: 92 additions & 92 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
# Kazumi
# Akiora

[![Telegram](https://img.shields.io/badge/Telegram-2CA5E0?style=flat&logo=telegram&logoColor=white)](https://t.me/kazumi_app)

使用 Flutter 开发的基于自定义规则的番剧采集与在线观看程序。使用最多五行基于 `Xpath` 语法的选择器构建自己的规则。支持规则导入与规则分享。支持基于 `Anime4K` 的实时超分辨率。绝赞开发中 (~ ̄▽ ̄)~
A Flutter-based anime indexing and online streaming app driven by user-defined rules. Build your own rules with selectors written in `Xpath` syntax (up to five lines). Supports importing and sharing rules, plus real-time super-resolution powered by `Anime4K`. Heavy development in progress (~ ̄▽ ̄)~

## 支持平台
> Akiora is a renamed/customized build of the upstream [Kazumi](https://github.com/Predidit/Kazumi) project. The package name, F-Droid/Flathub IDs, AUR packages, Telegram group, and release-asset URLs below still point to the upstream Kazumi project where the binaries are actually hosted.

- Android 10 及以上
- Windows 10 及以上
- MacOS 10.15 及以上
- Linux (实验性)
- iOS 13 及以上 (需要[自签名](https://kazumi.app/docs/misc/how-to-install-in-ios.html))
- HarmonyOS 5.0 及以上 (位于[分支仓库](https://github.com/ErBWs/Kazumi/releases/latest),需要[侧载](https://kazumi.app/docs/misc/how-to-install-in-ohos.html))
## Supported platforms

## 屏幕截图
- Android 10 and later
- Windows 10 and later
- macOS 10.15 and later
- Linux (experimental)
- iOS 13 and later (requires [self-signing](https://kazumi.app/docs/misc/how-to-install-in-ios.html))
- HarmonyOS 5.0 and later (lives in a [fork repository](https://github.com/ErBWs/Kazumi/releases/latest), requires [sideloading](https://kazumi.app/docs/misc/how-to-install-in-ohos.html))

## Screenshots

<table>
<tr>
Expand All @@ -28,37 +30,37 @@
<tr>
</table>

## 功能 / 开发计划

- [x] 规则编辑器
- [x] 番剧目录
- [x] 番剧搜索
- [x] 番剧时间表
- [x] 番剧字幕
- [x] 分集播放
- [x] 视频播放器
- [x] 多视频源支持
- [x] 规则分享
- [x] 硬件加速
- [x] 高刷适配
- [x] 追番列表
- [x] 番剧弹幕
- [x] 在线更新
- [x] 历史记录
- [x] 倍速播放
- [x] 配色方案
- [x] 跨设备同步
- [x] 无线投屏 (DLNA)
- [x] 外部播放器播放
- [x] 超分辨率
- [x] 一起看
- [x] 番剧下载
- [ ] 番剧更新提醒
- [ ] 还有更多 (/・ω・\)

## 下载

通过本页面 [releases](https://github.com/Predidit/Kazumi/releases) 选项卡下载:
## Features / Roadmap

- [x] Rule editor
- [x] Anime catalog
- [x] Anime search
- [x] Broadcast schedule
- [x] Anime metadata / details
- [x] Episode playback
- [x] Built-in video player
- [x] Multiple video-source support
- [x] Rule sharing
- [x] Hardware acceleration
- [x] High-refresh-rate support
- [x] Tracking / watchlist
- [x] Danmaku (bullet comments)
- [x] In-app updates
- [x] Watch history
- [x] Variable playback speed
- [x] Color schemes
- [x] Cross-device sync
- [x] Wireless casting (DLNA)
- [x] Playback via external players
- [x] Super-resolution
- [x] Watch Together
- [x] Anime downloads
- [ ] New-episode notifications
- [ ] More to come (/・ω・\)

## Download

Download from the [releases](https://github.com/Predidit/Kazumi/releases) tab on this page:

<a href="https://github.com/Predidit/Kazumi/releases">
<img src="static/svg/get_it_on_github.svg" alt="Get it on Github" width="200"/>
Expand All @@ -79,13 +81,13 @@

#### Arch Linux

可以从 [AUR](http://aur.archlinux.org) [archlinuxcn](https://github.com/archlinuxcn/repo) 安装。
Available from [AUR](http://aur.archlinux.org) or [archlinuxcn](https://github.com/archlinuxcn/repo).

##### AUR

```bash
[yay/paru] -S kazumi # 从源码构建
[yay/paru] -S kazumi-bin # 二进制包
[yay/paru] -S kazumi # build from source
[yay/paru] -S kazumi-bin # binary package
```

##### archlinuxcn
Expand All @@ -94,103 +96,101 @@
sudo pacman -S kazumi
```

## 贡献
## Contributing

欢迎向我们的 [规则仓库](https://github.com/Predidit/KazumiRules) 提交您的自定义规则。您可以自由选择是否在规则中留下您的ID
You are welcome to submit your custom rules to our [rules repository](https://github.com/Predidit/KazumiRules). You may freely choose whether or not to leave your ID in your rule.

## Q&A

<details>
<summary>使用者 Q&A</summary>
<summary>End-user Q&A</summary>

#### Q: 为什么少数番剧中有广告?
#### Q: Why are there ads in some anime?

A: 本项目未插入任何广告。广告来自视频源, 请不要相信广告中的任何内容, 并尽量选择没有广告的视频源观看。
A: This project does not insert any ads. Ads come from the video source. Please do not trust anything in the ads, and prefer video sources without ads when possible.

#### Q: 为什么我启用超分辨率功能后播放卡顿?
#### Q: Why does playback stutter when I enable super-resolution?

A: 超分辨率功能对 GPU 性能要求较高, 如果没有在高性能独立显卡上运行 Kazumi, 尽量选择效率档而非质量档。对低分辨率视频源而非高分辨率视频源使用超分也可以降低性能消耗。
A: Super-resolution is GPU-intensive. If you are not running Akiora on a high-performance discrete GPU, prefer the performance mode over the quality mode. Using super-resolution on low-resolution video sources rather than high-resolution ones also reduces the performance cost.

#### Q: 为什么播放视频时内存占用较高?
#### Q: Why is memory usage high during video playback?

A: 本程序在视频播放时, 会尽可能多地缓存视频到内存, 以提供较好的观看体验。如果您的内存较为紧张, 可以在播放设置选项卡启用低内存模式, 这将限制缓存。
A: During playback the app caches as much of the video into memory as possible to provide a smoother viewing experience. If memory is tight, you can enable Low Memory Mode in the playback settings tab to limit the cache.

#### Q: 为什么少数番剧无法通过外部播放器观看?
#### Q: Why can a few anime not be played in an external player?

A: 部分视频源的番剧使用了反盗链措施, 这可以被 Kazumi 解决, 但无法被外部播放器解决。
A: Some video sources use anti-hotlinking measures. Akiora can work around them, but external players cannot.

#### Q: 为什么下载的 Linux 版本缺少图标和托盘功能?
#### Q: Why is the Linux build I downloaded missing icons and tray support?

A: 使用 .deb 版本进行安装, tar.gz 版本仅为方便二次打包, 这一格式先天缺乏图标和托盘功能支持。
A: Install using the `.deb` package; the `.tar.gz` is only intended to make repackaging easier and inherently lacks icon and tray support.

</details>

<details>
<summary>规则编写者 Q&A</summary>
<summary>Rule-author Q&A</summary>

#### Q: 为什么我的自定义规则无法实现检索?
#### Q: Why does my custom rule fail to perform searches?

A: 目前我们对 `Xpath` 语法的支持并不完整, 我们目前只支持以 `//` 开头的选择器。建议参照我们给出的示例规则构建自定义规则。
A: Our `Xpath` support is currently incomplete; only selectors starting with `//` are supported. We recommend using the example rules we provide as a template for your own.

#### Q: 为什么我的自定义规则可以实现检索, 但不能实现观看?
#### Q: My custom rule can search but cannot play. Why?

A: 尝试关闭自定义规则的使用内置播放器选项, 这将尝试使用 `webview` 进行播放, 提高兼容性。但在内置播放器可用时, 建议启用内置播放器, 以获得更加流畅并带有弹幕的观看体验。
A: Try disabling "Use built-in player" on the custom rule; this falls back to `webview` for playback and improves compatibility. When the built-in player works, however, prefer it for smoother playback and danmaku support.

</details>

<details>
<summary>开发者 Q&A</summary>
<summary>Developer Q&A</summary>

#### Q: 我在尝试自行编译该项目, 但编译没有成功。
#### Q: I'm trying to build the project myself but the build fails.

A: 本项目编译需要良好的网络环境, 除了由 Google 托管的 Flutter 相关依赖外, 本项目同样依赖托管在 MavenCentral/Github/SourceForge 上的资源。如果您位于中国大陆, 可能需要设置恰当的镜像地址。
A: Building requires a healthy network. In addition to the Flutter-related dependencies hosted by Google, this project depends on resources hosted on MavenCentral / GitHub / SourceForge. If you are in mainland China you may need to configure appropriate mirrors.

</details>

## 美术资源

本项目图标来自 [Yuquanaaa](https://www.pixiv.net/users/66219277) 发表在 [Pixiv](https://www.pixiv.net/artworks/116666979) 上的作品。

此图标由其原作者 [Yuquanaaa](https://www.pixiv.net/users/66219277) 拥有版权。我们已获得原作者的授权和许可, 可以在本项目中使用这一图标。这一图标不是自由使用的, 未经原作者明确授权, 任何人不得擅自使用、复制、修改或分发这一图标。
## Art assets

本项目内嵌字体为 [Mi Sans](https://hyperos.mi.com/font/en/details/sc/) 字体, 由 [Xiaomi](https://www.mi.com/) 开发和拥有版权。
The app icon used by upstream Kazumi was created by [Yuquanaaa](https://www.pixiv.net/users/66219277) and published on [Pixiv](https://www.pixiv.net/artworks/116666979). Copyright is held by the original author [Yuquanaaa](https://www.pixiv.net/users/66219277), and upstream has obtained their authorization to use it. The icon is **not** freely usable; without explicit permission from the original author no one may use, copy, modify, or distribute it.

## 免责声明
This Akiora fork ships its own custom icon and does not redistribute the upstream icon. Any custom artwork bundled here belongs to its respective owner.

本项目基于 GNU 通用公共许可证第 3 版(GPL-3.0)授权。我们不对其适用性、可靠性或准确性作出任何明示或暗示的保证。在法律允许的最大范围内, 作者和贡献者不承担任何因使用本软件而产生的直接、间接、偶然、特殊或后果性的损害赔偿责任。
The bundled font is [Mi Sans](https://hyperos.mi.com/font/en/details/sc/), developed and copyrighted by [Xiaomi](https://www.mi.com/).

使用本项目需遵守所在地法律法规, 不得进行任何侵犯第三方知识产权的行为。因使用本项目而产生的数据和缓存应在24小时内清除, 超出 24 小时的使用需获得相关权利人的授权。
## Disclaimer

## 隐私政策 (Privacy policy)
This project is licensed under the GNU General Public License v3.0 (GPL-3.0). We make no express or implied warranty as to its fitness, reliability, or accuracy. To the maximum extent permitted by law, the authors and contributors are not liable for any direct, indirect, incidental, special, or consequential damages arising from the use of this software.

我们不收集任何用户数据, 不使用任何遥测组件。
Use of this project must comply with the laws and regulations of your jurisdiction, and must not infringe any third party's intellectual property rights. Any data and caches generated by using this project should be cleared within 24 hours; use beyond 24 hours requires authorization from the relevant rights holder.

## 代码签名策略 (Code signing policy)
提交者: [Contributors](https://github.com/Predidit/Kazumi/graphs/contributors)
审阅者: [Owner](https://github.com/Predidit)
## Privacy policy

## 赞助 (Sponsors)
| ![signpath](https://signpath.org/assets/favicon-50x50.png) | Free code signing on Windows provided by [SignPath.io](https://about.signpath.io/), certficate by [SignPath Foundation](https://signpath.org/) |
|------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
We do not collect any user data and do not use any telemetry components.

## 致谢
## Code signing policy
Submitters: [Contributors](https://github.com/Predidit/Kazumi/graphs/contributors)
Reviewers: [Owner](https://github.com/Predidit)

特别感谢 [XpathSelector](https://github.com/simonkimi/xpath_selector) 这个优秀的项目是本项目的基石。
## Sponsors
| ![signpath](https://signpath.org/assets/favicon-50x50.png) | Free code signing on Windows provided by [SignPath.io](https://about.signpath.io/), certificate by [SignPath Foundation](https://signpath.org/) |
|------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|

特别感谢 [DandanPlayer](https://www.dandanplay.com/) 本项目使用了 dandanplayer 开放 API 以提供弹幕交互。
## Acknowledgments

特别感谢 [Bangumi](https://bangumi.tv/) 本项目使用了 Bangumi 开放 API 以提供番剧元数据。
Special thanks to [XpathSelector](https://github.com/simonkimi/xpath_selector) — this excellent project is the cornerstone of ours.

特别感谢 [Anime4K](https://github.com/bloc97/Anime4K) 本项目使用 Anime4K 进行实时超分。
Special thanks to [DandanPlayer](https://www.dandanplay.com/) — we use the dandanplay open API to power danmaku interactions.

特别感谢 [SyncPlay](https://github.com/Syncplay/syncplay) 本项目使用 SyncPlay 协议并通过 SyncPlay 公共服务器实现一起看功能。
Special thanks to [Bangumi](https://bangumi.tv/) — we use the Bangumi open API for anime metadata.

特别感谢 [trace.moe](https://trace.moe) 本项目使用了 trace.moe 提供的图片识别番剧功能。
Special thanks to [Anime4K](https://github.com/bloc97/Anime4K) — used for real-time super-resolution.

感谢 [media-kit](https://github.com/media-kit/media-kit) 本项目跨平台媒体播放能力来自 media-kit。
Special thanks to [SyncPlay](https://github.com/Syncplay/syncplay) — we use the SyncPlay protocol and its public servers to power Watch Together.

感谢 [avbuild](https://github.com/wang-bin/avbuild) 本项目使用了来自 avbuild 的树外补丁实现非标准视频流播放。
Special thanks to [trace.moe](https://trace.moe) — used for the image-based anime search feature.

感谢 [hive](https://github.com/isar/hive) 本项目持久化储存能力来自 hive。
Thanks to [media-kit](https://github.com/media-kit/media-kit) — provides cross-platform media playback.

Thanks to [avbuild](https://github.com/wang-bin/avbuild) — we use out-of-tree patches from avbuild to enable non-standard video-stream playback.

Thanks to [hive](https://github.com/isar/hive) — provides the persistent storage layer.
2 changes: 1 addition & 1 deletion android/app/src/main/AndroidManifest.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
<application
android:label="Kazumi"
android:label="Akiora"
android:name="${applicationName}"
android:usesCleartextTraffic="true"
android:icon="@mipmap/ic_launcher"
Expand Down
Binary file added assets/images/logo/new_icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion assets/linux/io.github.Predidit.Kazumi.desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[Desktop Entry]
Name=Kazumi
Name=Akiora
Comment=Watch Animes online with danmaku support.
Comment[zh_CN]=一款好用的追番软件
Exec=kazumi
Expand Down
22 changes: 11 additions & 11 deletions assets/statements/statements.txt
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
在使用本软件之前,请您仔细阅读以下内容,并确保您充分理解并同意以下条款:
1、本软件为开源软件,您应该免费获取和使用。如果您是从第三方付费获取,建议您向其索取赔偿。
2、本软件完全基于您个人意愿使用,您应该对自己的使用行为和所有结果承担全部责任。
3、本软件仅供学习交流、科研等非商业性质的用途,严禁将本软件用于商业目的。如有任何商业行为,均与本软件无关。
4、本软件并不保证与所有操作系统或硬件设备兼容。本软件作者或贡献者不对因使用本软件而产生的任何技术或安全问题承担责任。
5、本软件作者或贡献者不承担因使用本软件而造成的任何直接、间接、特殊或后果性的损失或损害的责任,包括但不限于财产损失、商业利润损失、信息或数据丢失或损坏等。
6、本软件使用者应遵守国家相关法律法规和使用规范,不得利用本软件从事任何违法违规行为。如因使用本软件而导致的违法行为,使用者应承担相应的法律责任。
7、本软件不会收集、存储、使用任何用户的个人信息,包括但不限于姓名、地址、电子邮件地址、电话号码等。在使用本软件过程中,不会进行任何形式的个人信息采集。
8、本软件作者或贡献者保留随时修改、增加、删除本免责声明中的内容而不另行通知的权利。
9、如果本软件存在侵犯您的合法权益的情况,请及时与作者联系,作者将会及时删除有关内容。
如您不同意本免责声明中的任何内容,请勿使用本软件。使用本软件即代表您已完全理解并同意上述内容。
Before using this software, please read the following carefully and make sure you fully understand and agree to the following terms:
1. This software is open source and you should obtain and use it for free. If you obtained it from a third party for a fee, you are advised to seek a refund from them.
2. You use this software entirely of your own free will, and you are solely responsible for your usage and all of its consequences.
3. This software is intended only for non-commercial purposes such as learning, communication, and research. Using this software for commercial purposes is strictly prohibited. Any commercial activity is unrelated to this software.
4. This software does not guarantee compatibility with all operating systems or hardware devices. The authors or contributors of this software are not responsible for any technical or security issues arising from its use.
5. The authors or contributors of this software are not liable for any direct, indirect, special, or consequential loss or damage caused by using this software, including but not limited to property loss, loss of business profits, and loss or corruption of information or data.
6. Users of this software must comply with relevant national laws, regulations, and usage standards, and must not use this software for any illegal or non-compliant activity. Users shall bear the corresponding legal liability for any illegal acts resulting from the use of this software.
7. This software does not collect, store, or use any user personal information, including but not limited to name, address, email address, or phone number. No personal information is collected in any form while using this software.
8. The authors or contributors of this software reserve the right to modify, add to, or remove the contents of this disclaimer at any time without further notice.
9. If this software infringes upon your legitimate rights and interests, please contact the author promptly, and the author will remove the relevant content in a timely manner.
If you do not agree with any part of this disclaimer, please do not use this software. Using this software means you have fully understood and agreed to the above.
2 changes: 1 addition & 1 deletion ios/Runner/Info.plist
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<key>CFBundleDevelopmentRegion</key>
<string>$(DEVELOPMENT_LANGUAGE)</string>
<key>CFBundleDisplayName</key>
<string>Kazumi</string>
<string>Akiora</string>
<key>CFBundleExecutable</key>
<string>$(EXECUTABLE_NAME)</string>
<key>CFBundleIdentifier</key>
Expand Down
Loading