Skip to content

README.md

Latest commit

 

History

History
134 lines (103 loc) · 6.38 KB

README.md

File metadata and controls

134 lines (103 loc) · 6.38 KB

Samuel Client

A cross-platform Minecraft launcher built with Wails (Go + React/TypeScript), supporting vanilla, Fabric, and Forge profiles with offline and authlib-injector (Yggdrasil) account authentication.

Features

  • Account management — offline and third-party (authlib-injector / Yggdrasil) login flows, with token refresh and validation
  • Version management — browse and download vanilla Minecraft versions, plus Fabric and Forge mod loaders
  • Mod management — open the mods folder for the active profile directly from the UI
  • Java management — track installed Java runtimes and set a default per profile
  • Local HTTP API — embedded Gin server exposing launcher functionality (auth, versions, downloads, launch, file & shell utilities, system info)
  • Persistent storage — embedded SQLite database for users, settings, logs, tasks, file records, and Java installations
  • Cross-platform — Windows, macOS, and Linux builds via Wails

Tech stack

Layer Technology
Backend Go 1.25, Wails v2, Gin, modernc.org/sqlite
Frontend React 19, TypeScript 5, Vite 6, Material UI v6
Build Wails CLI (WebKitGTK 2.41+ on Linux)

Project layout

HRPML-Wails/
├── app.go                  # Wails App struct — entry point for Go ↔ JS bindings
├── main.go                 # Wails application bootstrap
├── wails.json              # Wails project configuration
├── go.mod / go.sum         # Go module definition
├── internal/
│   ├── config/             # Configuration loading
│   ├── database/           # SQLite initialization and access
│   ├── handlers/           # HTTP handlers (db, mc, generic)
│   ├── middleware/         # Gin middleware (recovery, logger, CORS)
│   ├── models/             # Domain & API models
│   ├── repository/         # Data access layer
│   ├── routes/             # Router setup
│   └── services/           # HTTP service + platform-specific services
├── frontend/
│   ├── src/
│   │   ├── components/     # React views (Home, Versions, Accounts, Mods, Settings, Debug, Login)
│   │   ├── App.tsx         # Main app shell with navigation drawer
│   │   ├── main.tsx        # React entry point
│   │   └── variables.ts    # Shared frontend constants
│   ├── index.html
│   ├── package.json
│   ├── tsconfig.json
│   └── vite.config.ts
├── build/                  # Platform-specific build assets (icons, manifests, installer)
└── docs/                   # Reference docs (launcher standard, BMCLAPI, authlib-injector)

Prerequisites

  • Go 1.25 or newer
  • Node.js 18+ and npm
  • Wails CLI v2: go install github.com/wailsapp/wails/v2/cmd/wails@latest
  • Platform build dependencies — see the Wails installation guide:
    • Linux: GCC, libgtk-3-dev, libwebkit2gtk-4.0-dev (or 4.1), pkg-config
    • macOS: Xcode Command Line Tools
    • Windows: MinGW-w64 / MSYS2, WebView2 runtime

Verify your environment with wails doctor.

Getting started

Clone the repository and run the app in live development mode (with hot reload for the frontend):

git clone <repo-url> HRPML-Wails
cd HRPML-Wails
wails dev

wails dev starts a Vite dev server and reloads the UI on change. Go method changes trigger an automatic rebuild. A browser devtools server is also exposed on http://localhost:34115 for inspecting the Go bindings from the browser console.

Building

To produce a redistributable, production-mode binary for your current platform:

wails build

The output binary is written to build/bin/ (SamuelClient / SamuelClient.exe). Cross-compilation is supported via wails build -platform windows/amd64 etc. — see the Wails CLI reference.

HTTP API

On startup, the embedded Gin server listens on the port configured in internal/config (see config.go). The frontend talks to it through the Wails bindings in app.go.

Selected routes (all under /api/v1, plus a few legacy unprefixed routes for backward compatibility):

Group Example endpoints
Health GET /health, GET /ping, GET /hello/:name
Utility POST /echo, GET /sysinfo
Shell / file POST /shell/execute, POST /file/operation
Database GET/POST/PUT/DELETE /db/users, /db/settings, /db/logs, /db/tasks, /db/files, /db/java
Auth GET /auth/meta, POST /auth/login, /auth/refresh, /auth/validate, /auth/offline
Versions GET /versions, GET /versions/:id
Loaders GET /fabric/versions, GET /forge/versions
Download POST /download/version
Launcher GET /launcher/config, POST /launcher/launch, GET /launcher/minecraft-dir, GET /launcher/installed-versions

Frontend

The UI is a single-page React app written in TypeScript and built with Vite. Material UI provides the component library. Views are organized around a left navigation drawer:

  • Play — launch the currently selected version with the active account
  • Versions — browse, download, and select Minecraft versions
  • Accounts — add and switch between offline and Yggdrasil accounts
  • Mods — open the active profile's mods folder
  • Settings — application preferences
  • Debug — internal API and database diagnostics

Run frontend-only checks:

cd frontend
npm run lint
npm run typecheck

License

This project is licensed under the GNU Affero General Public License v3.0 — see the LICENSE file for the full text.

Acknowledgements