Skip to content
Merged
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
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ A Windows desktop app for building and maintaining Minecraft modpacks. It create
projects and installs real mods from Modrinth, with every change reviewed before it is applied.
Awake Launcher is not required.

> **What's new in 1.2.3:** see [docs/releases/v1.2.3.md](docs/releases/v1.2.3.md).
> **What's new in 1.3.0:** see [docs/releases/v1.3.0.md](docs/releases/v1.3.0.md).

**Version 1.2.3 · Windows x64 · English, ไทย, 简体中文, 繁體中文 · GPL-3.0-only**
**Version 1.3.0 · Windows x64 · English, ไทย, 简体中文, 繁體中文 · GPL-3.0-only**

## Install

1. Download `Awake-Modpack-Manager-v1.2.3-Windows-x64-Setup.exe` from the
1. Download `Awake-Modpack-Manager-v1.3.0-Windows-x64-Setup.exe` from the
[latest release](https://github.com/awakenginexe/Awake-Modpack-Manager/releases/latest).
2. Optional: check it against `SHA256SUMS.txt` from the same release
(`Get-FileHash .\Awake-Modpack-Manager-v1.2.3-Windows-x64-Setup.exe`).
(`Get-FileHash .\Awake-Modpack-Manager-v1.3.0-Windows-x64-Setup.exe`).
3. Run the installer. It installs for your Windows user only (no administrator rights) into
`%LOCALAPPDATA%\Awake Modpack Manager`.
The installer is **not code-signed** yet, so Windows SmartScreen may warn that it is from an
Expand Down
9 changes: 5 additions & 4 deletions docs/HANDOFF.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
# Development checkpoint: Manager 1.2.3 and Native Core 0.4.2
# Development checkpoint: Manager 1.3.0 and Native Core 0.4.2

Unreleased until the owner approves the pull request and tags `v1.2.3`.
Unreleased until the owner approves the pull request and tags `v1.3.0`.

## Where things are

- Manager: branch `release/1.2.3`. `npm ci`, then `npm test`, `npm run typecheck`, `cargo test --manifest-path src-tauri/Cargo.toml --lib`.
- Manager: branch `release/1.3.0`. `npm ci`, then `npm test`, `npm run typecheck`, `cargo test --manifest-path src-tauri/Cargo.toml --lib`.
- Native Core: Awake Launcher branch `release/3.2.2`. `.github/workflows/native-core-package.yml` builds it with the recorded toolchain and commits a delivery under `native-core/redistribution/<commit12>/`. `scripts/helper-pin.json` pins that delivery.
- Release: pushing a version tag runs `.github/workflows/awake-beta.yml`, which builds, verifies, assembles every asset and publishes the release. `SHA256SUMS.txt` is required by in-app updates.

## Architecture added in 0.3.0

- `src-tauri/src/providers.rs`: five modpack catalogs, pack downloads, batched project metadata and update lookups. The CurseForge key stays in the host and the helper's environment.
- `src-tauri/src/updater.rs`: GitHub release check and checksum-verified installer run.
- `src-tauri/src/desktop.rs`: project content listing and Recycle Bin, shell open. Mods are never touched here.
- `src-tauri/src/desktop.rs`: content folders of a project or managed Launcher instance (list a folder, edit a text file, add files, Recycle Bin), shell open. Mods are never touched here.
- `src-tauri/src/content.rs` (1.3.0): resource pack and shader search, versions and direct, checksum-verified install into `resourcepacks` / `shaderpacks`.
- `HelperClient.installPack`: one local operation over fetch, upload, create, prepare and apply. A failure removes the created project.
- FTB versions become a generated `.mrpack` manifest; ATLauncher and Technic become a CurseForge-format archive of overrides.
- Native Core: `workspaces.delete`, `workspaces.rename`, `imports.prepare` with `packAuthoritative`, `removeInventoryIds` and `allowLoaderUpdate`, a helper-only hash cache, batched provider reads and parallel downloads.
Expand Down
33 changes: 33 additions & 0 deletions docs/releases/v1.3.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Awake Modpack Manager 1.3.0

Works with **Awake Launcher 3.2.2**. No Launcher update is needed.

## Added

- **Files works, for Launcher instances too.** The Files page used to answer "The Manager helper in this build does not support file listing yet" for every Launcher instance managed here, and was read-only everywhere else. It now shows the configs, default configs, KubeJS, scripts, resource packs and shader packs of any instance you manage here, one folder at a time, with a filter for the folder on screen.
- **Edit configs and scripts in place.** Click a text file to open it, change it and save (Ctrl+S). A save never overwrites a file that changed on disk while it was open, for example a config the game rewrote: you are told and can open the new version. Windows line endings are kept. Files over 2 MB and files that are not text are left to other programs.
- **Add files and remove them.** "Add files" copies files you pick into the folder on screen and never replaces one that is already there. Removing still goes to the Windows Recycle Bin, after a confirmation.
- **Browse resource packs and shaders.** Browse now has three shelves in the sidebar: Mods, Resource packs and Shaders. The two new ones search Modrinth and CurseForge, can be limited to the instance's Minecraft version, show each version with its file, size and (for shaders) what loads it, and install with one click.

## How resource packs and shaders install

They are zip files the game only reads, with no loader or dependencies to resolve, so they do not go through "Review & apply". An install is one download from the provider's own CDN, checked against the provider's checksum, written under a temporary name and then moved into `resourcepacks` or `shaderpacks`. Installing a version whose file is already there replaces that file. Nothing else in the pack changes, and mods still only change through a reviewed plan.

Shaders need a shader mod in the pack, such as Iris or Oculus. Resource packs and shaders are turned on in the game's own options.

CurseForge authors can turn off downloads outside the CurseForge website. For those, the Manager says so and links the page: download it there and use "Add files".

## Changed

- Files no longer shows "included in export" for Manager projects and managed instances: their exports take these folders whole (Instance zip) or from the pack archive, so the tick boxes did nothing there.
- The Files and Browse pages tell you to turn on "Manage mods here" for a Launcher instance that is not managed here yet, instead of "Not available in this version yet".

## Safety

- The Manager's desktop host now writes inside six content folders of an instance (`config`, `defaultconfigs`, `kubejs`, `scripts`, `resourcepacks`, `shaderpacks`), and only when you save, add, install or remove something. It never writes to `mods`, worlds or anything else.
- A link or junction inside one of those folders is never followed, so nothing can be read, saved or removed outside them.
- Only a file whose name ends in `.zip` is ever installed from a provider.

## Not verified on a real machine yet

The demo data and the automated tests cover these screens. Against live Modrinth, search, versions and a real download, checksum check and install into a scratch folder were run through the host's own code. Still unverified: the screens in the desktop app against a real Launcher instance, and anything on CurseForge (this development machine has no CurseForge key; the live CurseForge test for search and versions runs in the GitHub checks).
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "awake-modpack-manager",
"private": true,
"version": "1.2.3",
"version": "1.3.0",
"license": "GPL-3.0-only",
"type": "module",
"engines": {
Expand Down
2 changes: 1 addition & 1 deletion src-tauri/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src-tauri/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "awake-modpack-manager"
version = "1.2.3"
version = "1.3.0"
description = "Awake Modpack Manager desktop host"
license = "GPL-3.0-only"
repository = "https://github.com/awakenginexe/Awake-Modpack-Manager"
Expand Down
Loading
Loading