No description
Find a file
2026-03-11 17:05:11 -03:00
assets docs(readme): add profile readme 2026-03-11 17:05:11 -03:00
README.md docs(readme): add profile readme 2026-03-11 17:05:11 -03:00

Yukari Logo

Yukari

📖 About Yukari

Yukari is an open-source desktop reader built with WinUI 3 and .NET 10 for Windows.
It focuses on speed, privacy (100% local SQLite library, no telemetry/ads/accounts) and extensible via a plugin-based architecture.

Anyone can create or use plugins to add sources (MangaDex, ComicK, etc.) without forking the main app.

Ecosystem Structure

  • Yukari → The main application (core reader, UI, library management).
    Install from here: Releases or via Scoop (Asterism bucket).

  • Yukari.Core → Shared API contracts, interfaces (e.g. IComicSource) and data models.
    Published as NuGet package: dotnet add package Yukari.Core (latest: 1.4.0).
    Source repo: Yukari-App/Core (only for reference or PRs to the API itself).

  • Plugins → Community-maintained sources (format: Plugin.*).
    To create one:

    • Create a new .NET class library project.
    • Add NuGet: dotnet add package Yukari.Core
    • Implement IComicSource (or other required interfaces).
    • Build → get the .dll.
    • Publish as a new repo in the org (or your own), with Releases containing the DLL.
      Current examples:

🤝 Contributing & Community

  • Creating a new source/plugin? No need to fork anything!
    Just reference Yukari.Core via NuGet → implement the interfaces → build your DLL → share via a new repo or PR to add it to the org.
    Guidelines soon in the wiki (coming).

  • Report bugs, suggest features or discuss in the Yukari issues.

  • Want to improve the Core API itself? PRs welcome on Yukari-App/Core.

All repos and packages under GPL-3.0 — feel free to contribute!

Project is experimental — more plugins, docs and features coming soon.