diff --git a/README.md b/README.md index bb34d0e..3190052 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,41 @@ -# rlbot/gui +# RLBotGUI -A GUI for [RLBot](https://rlbot.org) v5. Built with: +The official GUI for [RLBot](https://rlbot.org) v5. The RLBot GUI features: + +- Easy match launching: drag-&-drop bots and human onto teams and press start. +- All match settings and mutators configurable with presets of official Rocket League game modes. +- Automatic download of verified bots from https://github.com/RLBot/botpack. +- Loadout editor to easily design your bot's loadout. +- A state-setting sandbox where you can drag-&-drop cars on the field, replay scenarios, run commands, and toggle rendering. + +To use the RLBot GUI as a player or bot developer, please download the installer at https://rlbot.org/. + +## Development + +The RLBot GUI is built with: * [Go](https://golang.org) * [Wails](https://v3alpha.wails.io) (v3 alpha). * [Svelte](https://svelte.dev) -## Info - -This project is built using a justfile. Run `just build` to build, `just dev` to run in dev mode, +This project is built using a [justfile](https://github.com/casey/just). Run `just build` to build, `just dev` to run in dev mode, `just lint` to lint and `just format` to format. Remember to [install dependencies](#Installing-build-dependencies) first. -## Installing build dependencies +### Installing build dependencies 1. Install the [wails v3-alpha cli](https://v3alpha.wails.io/getting-started/installation/) 2. Install [node](https://nodejs.org/en) and [pnpm](https://pnpm.io/installation) 3. Run `cd frontend` and then `pnpm i` (you probably want to `cd ../` after) -## Linux runtime dependencies +### Linux runtime dependencies * Either [zenity, matedialog or qarma](https://github.com/ncruces/zenity?tab=readme-ov-file#benefits-of-the-go-package) + +### Deployment + +- Make sure your local `master` branch is up-to-date. +- Run `just build windows` and `just build linux`. +- Create a new GitHub release with an appropriate name and tag +- Attach `bin/rlbotgui.exe` and `bin/rlbotgui` binaries +- Mark release as latest and click release!