53 lines
2.0 KiB
Markdown
53 lines
2.0 KiB
Markdown
# Modrinth Plus
|
|
|
|
Modrinth Plus is a fork of the official Modrinth monorepo focused on the
|
|
desktop app. Its first custom feature is Connected Library: public Git-hosted
|
|
modpack manifests that can install and update exported `.mrpack` releases.
|
|
|
|
## Stack
|
|
|
|
- Monorepo package manager: pnpm
|
|
- Desktop app frontend: Vue
|
|
- Desktop app shell: Tauri
|
|
- Core app logic: Rust crate `theseus` in `packages/app-lib`
|
|
- Local app storage: SQLite migrations in `packages/app-lib/migrations`
|
|
- CI target: Gitea Actions runner
|
|
|
|
## Connected Library Defaults
|
|
|
|
- Supports public HTTPS raw manifest URLs and GitHub/GitLab/Gitea repo URLs.
|
|
- Manifest filename is `modrinth-plus.json`.
|
|
- Auto-update is disabled by default and can be enabled per connected pack.
|
|
- Private repository auth, SSH, and token storage are out of scope for v1.
|
|
|
|
## Verification
|
|
|
|
Use the cheapest relevant checks first:
|
|
|
|
```bash
|
|
pnpm install
|
|
pnpm --filter @modrinth/app-frontend run lint
|
|
cargo fmt --check
|
|
cargo clippy --package theseus
|
|
```
|
|
|
|
Full app packaging may require platform-specific Tauri dependencies.
|
|
|
|
## Build Artifacts
|
|
|
|
Windows installer packages are built by the Gitea runner and published to the generic package registry:
|
|
|
|
```text
|
|
https://git.wilkensxl.de/api/packages/MrSphay/generic/modrinth-plus/latest/Modrinth-Plus-Windows-Setup.exe
|
|
```
|
|
|
|
The workflow also uploads a run artifact for debugging, but workflow-run artifacts are not Package Registry packages.
|
|
|
|
## Kit Application Notes
|
|
|
|
- `AGENTS.md` intentionally preserves the upstream `CLAUDE.md` handoff while adding Modrinth Plus and Gitea workflow-loop rules.
|
|
- README blueprint generation is not enabled because the upstream Modrinth README should remain authoritative.
|
|
- Release dry-run automation is deferred until desktop packaging commands and artifact names are finalized.
|
|
- Template compliance is enabled on push to keep Codex context files present and placeholder-free.
|
|
- Codex kit metadata should stay in source control for agent work but should not be shipped inside user-facing installers or downloadable package artifacts.
|