@thomasfarineau/anvil 0.0.1 → 0.0.3

package/README.md

@@ -1,217 +1,43 @@
 <div align="center">
-  <img src="./logo.svg" width="96" height="96" alt="anvil" />
+  <img src="https://raw.githubusercontent.com/ThomasFarineau/anvil/refs/heads/main/logo.svg" width="96" height="96" alt="anvil" />
   <h1>anvil</h1>
   <p>Build a native Minecraft launcher by writing only HTML.<br>The Rust backend handles everything else.</p>
 
-  [![release](https://img.shields.io/github/v/release/ThomasFarineau/anvil?style=flat-square)](https://github.com/ThomasFarineau/anvil/releases)
-  [![license](https://img.shields.io/github/license/ThomasFarineau/anvil?style=flat-square)](./LICENSE)
-  [![CI](https://img.shields.io/github/actions/workflow/status/ThomasFarineau/anvil/ci.yml?style=flat-square&label=CI)](https://github.com/ThomasFarineau/anvil/actions)
+[![npm](https://img.shields.io/npm/v/%40thomasfarineau%2Fanvil?style=flat-square)](https://www.npmjs.com/package/@thomasfarineau/anvil)
+[![release](https://img.shields.io/github/v/release/ThomasFarineau/anvil?style=flat-square)](https://github.com/ThomasFarineau/anvil/releases)
+[![license](https://img.shields.io/github/license/ThomasFarineau/anvil?style=flat-square)](./LICENSE)
+[![CI](https://img.shields.io/github/actions/workflow/status/ThomasFarineau/anvil/ci.yml?style=flat-square&label=CI)](https://github.com/ThomasFarineau/anvil/actions)
+
 </div>
 
 ---
 
-**anvil** is a framework that generates a native Minecraft launcher (Windows · macOS · Linux) from a `config.json` file and an HTML page. The built-in Rust backend takes care of:
-
-- Downloading and managing Java
-- Downloading Minecraft assets (vanilla, Fabric, Forge…)
-- Launching the game with session management
-- Auto-updates via URL
-- App icon generation from your logo
-
-You only touch the **frontend**.
-
-## Prerequisites
-
-- [Node.js](https://nodejs.org) ≥ 18
-- [Rust](https://rustup.rs) (stable)
-- [Tauri v2 prerequisites](https://tauri.app/start/prerequisites/) (WebView2 on Windows, Xcode on macOS)
+**anvil** is a framework that generates a native Minecraft launcher (Windows · macOS · Linux) from a `config.json` file and an HTML page. The built-in Rust backend handles Java, Minecraft downloads (vanilla, Fabric, Forge…), mods, launching, sessions, auto-updates and app icons. You only touch the **frontend**.
 
 ## Quick start
 
 ```bash
-npx anvil create my-launcher
+npx @thomasfarineau/anvil create my-launcher
 cd my-launcher
 npm install
 npm run dev
 ```
 
-Or in an existing project:
-
-```bash
-npm install -D anvil
-npx anvil init
-npm run dev
-```
-
-## Commands
-
-| Command | Description |
-|---|---|
-| `npx anvil create <name>` | Scaffold a new project in `<name>/` |
-| `npx anvil init` | Initialize anvil in the current folder |
-| `npx anvil dev` | Start the launcher in development mode |
-| `npx anvil build` | Compile the launcher for distribution |
-| `npx anvil update` | Update the Rust backend and `api.js` to the latest version |
-
-## Project structure
-
-```
-my-launcher/
-├── config.json          ← launcher configuration
-├── src/
-│   ├── index.html       ← your interface (HTML/CSS/JS)
-│   ├── api.js           ← JS ↔ Rust bridge  (do not modify)
-│   └── logo.svg         ← your launcher logo (optional)
-└── src-anvil/           ← generated by anvil  (do not modify)
-```
-
-## config.json
-
-```json
-{
-  "$schema": "node_modules/anvil/src/client/config.schema.json",
-  "identifier": "com.mycompany.launcher",
-  "app_name": "My Launcher",
-  "data_folder": ".my-launcher",
-  "java_version": 21,
-  "logo": "logo.svg",
-  "session": "none",
-  "update_url": "",
-  "target": "dist",
-  "window_decorations": true,
-  "window_resizable": false,
-  "instances": [
-    {
-      "id": "survival",
-      "name": "Survival",
-      "mc_version": "1.21.4"
-    },
-    {
-      "id": "modded",
-      "name": "Modded",
-      "mc_version": "1.21.4",
-      "loader": "fabric",
-      "loader_version": "0.16.9"
-    }
-  ]
-}
-```
-
-### Field reference
-
-| Field | Type | Description |
-|---|---|---|
-| `identifier` | `string` | Reverse-domain app identifier (e.g. `com.mycompany.launcher`) |
-| `app_name` | `string` | App name shown in the native window and UI |
-| `data_folder` | `string` | Sub-folder in `%APPDATA%` / `~/Library` for game data |
-| `java_version` | `17` \| `21` | Java version to download automatically |
-| `logo` | `string` | Path to the logo (relative to `src/`) — `.svg` or `.png`, auto-converted to app icon |
-| `session` | `"none"` \| `"mojang"` \| `"custom"` | Authentication mode |
-| `update_url` | `string` | URL of the update manifest (leave empty to disable) |
-| `target` | `string` | Output folder for compiled executables (e.g. `dist`) |
-| `window_decorations` | `boolean` | Show the native title bar |
-| `window_resizable` | `boolean` | Allow the user to resize the window |
-| `instances` | `array` | List of available Minecraft instances |
-
-### Instance fields
-
-| Field | Type | Description |
-|---|---|---|
-| `id` | `string` | Unique identifier (used as the folder name) |
-| `name` | `string` | Label shown on the play button |
-| `mc_version` | `string` | Minecraft version (e.g. `"1.21.4"`) |
-| `loader` | `"fabric"` \| `"forge"` \| `"neoforge"` \| `"quilt"` | Mod loader (optional) |
-| `loader_version` | `string` | Mod loader version (e.g. `"0.16.9"`) |
-| `server_ip` | `string` | Server IP for auto-connect on launch |
-| `server_port` | `number` | Server port (default: `25565`) |
-
-## Session
-
-### `"none"` — Offline
-
-The player types their username directly in the UI. No authentication required.
+`create` is interactive: pick **TypeScript** or **JavaScript**, then **Vanilla**, **React**, **Vue** or **Solid**. Skip the prompts with `--template <id>` — see [`examples/`](./examples) for a ready-made project of each template.
 
-### `"custom"` — External authentication
-
-Handle authentication on the client side (OAuth, custom API…) and pass the session to anvil:
-
-```js
-await MC.setSession({
-  username: 'Steve',
-  uuid: '...',
-  access_token: '...',
-});
-
-// To log out:
-await MC.clearSession();
-```
-
-## JavaScript API
-
-Import `api.js` in your HTML:
-
-```html
-<script type="module">
-  import { MC } from '/api.js';
-</script>
-```
-
-### Reference
-
-```js
-// Config & settings
-MC.getConfig()                            // → LauncherConfig
-MC.getSettings()                          // → Settings
-MC.saveSettings(settings)                 // → void
-MC.getDefaultDir()                        // → string  (default %APPDATA%/... path)
-
-// Installation
-MC.getInitStatus()                        // → InitStatus  (java_ok, instances[])
-MC.runSetup()                             // → void  (starts the download)
-
-// Game
-MC.verify(instanceId)                     // → void  (verifies game files)
-MC.play(instanceId)                       // → void  (launches the game)
-
-// Session  (when session: "custom")
-MC.setSession({ username, uuid, access_token })
-MC.clearSession()
-
-// Updates
-MC.checkUpdate()                          // → UpdateInfo | null
-MC.doUpdate(url)                          // → void
-
-// Window
-MC.close()                               // closes the application
-
-// Events
-MC.on.setupProgress(cb)   // cb({ step, current, total, label, error })
-MC.on.setupDone(cb)       // cb()
-MC.on.gameStarting(cb)    // cb(instanceId)
-MC.on.gameOutput(cb)      // cb({ instance_id, text, stderr })
-MC.on.gameExit(cb)        // cb({ instance_id, code })
-```
-
-## App icon
-
-Place your logo in `src/` and set the `logo` field in `config.json`. anvil converts it automatically to all required icon sizes during `init`:
-
-- `.svg` → converted to PNG via **sharp**, then generated at all sizes
-- `.png` → used directly (recommended: 1024×1024)
-
-## Build & distribution
-
-```bash
-npm run build   # → anvil build → tauri build
-```
+## 📖 Documentation
 
-Distribution artifacts are generated in the `target` folder configured in `config.json`:
+Full docs, guides and API reference: **[thomasfarineau.github.io/anvil](https://thomasfarineau.github.io/anvil/)** ([français](https://thomasfarineau.github.io/anvil/fr/))
 
-| Platform | Format |
-|---|---|
-| Windows | `<name>_<ver>_x64-setup.exe` (NSIS) |
-| Linux | `<name>_<ver>_amd64.AppImage` |
-| macOS | `<name>_<ver>_x64.dmg` |
+- [Getting started](https://thomasfarineau.github.io/anvil/guide/getting-started)
+- [CLI commands](https://thomasfarineau.github.io/anvil/guide/commands)
+- [Project structure](https://thomasfarineau.github.io/anvil/guide/project-structure)
+- [config.json reference](https://thomasfarineau.github.io/anvil/config/)
+- [Mods per instance](https://thomasfarineau.github.io/anvil/config/mods)
+- [Session (offline / custom auth)](https://thomasfarineau.github.io/anvil/session)
+- [JavaScript API](https://thomasfarineau.github.io/anvil/api)
+- [App icon generation](https://thomasfarineau.github.io/anvil/icons)
+- [Build & distribution](https://thomasfarineau.github.io/anvil/build)
 
 ## License