Files
canvas-launcher/README.md
T
2024-11-29 11:51:21 -07:00

33 lines
1.2 KiB
Markdown

# Canvas Launcher
A custom Minecraft launcher designed as a Technic replacement. This launcher is designed to be reskinned by each modpack installed.
Modpacks can be added via zip files, the Technic platform, or the complimentary project Palette.
## Installation
To start developing you'll need Go and NodeJS + NPM installed. Afterwards you'll need to install Wails. Wails requires additional system libraries. `wails doctor` scans your system for the libraries required.
```bash
go install github.com/wailsapp/wails/v2/cmd/wails@latest
wails doctor
```
After you have a functioning Wails installation, just clone the launcher.
```bash
git clone https://git.bigduckie.dev/big-duckie/canvas-launcher.git
cd canvas-launcher
```
## Live Development
To run the live development mode, run `wails dev`.
This sets up a Vite development server that provides hot reloads for the frontend. It also provides a backend dev server on `http://localhost:34115`. This allows you to call Go code from your browser's devtools.
## Deployment
To build this project for binary redistribution, ensure you're on your target platform. Wails *does not* reliably support cross-compilation because it relies on C binaries.
```bash
wails build
```