https://github.com/virxec/rlbot_gui_rust
The Rust port of RLBot's GUI, now with feature parity & more!
https://github.com/virxec/rlbot_gui_rust
gui python rlbot rust
Last synced: 2 months ago
JSON representation
The Rust port of RLBot's GUI, now with feature parity & more!
- Host: GitHub
- URL: https://github.com/virxec/rlbot_gui_rust
- Owner: VirxEC
- License: mit
- Created: 2022-05-06T22:48:47.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-12-21T21:09:17.000Z (over 1 year ago)
- Last Synced: 2023-12-21T22:24:10.772Z (over 1 year ago)
- Topics: gui, python, rlbot, rust
- Language: Rust
- Homepage:
- Size: 48.6 MB
- Stars: 6
- Watchers: 1
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# RLBotGUI
## About
RLBotGUI is a streamlined user interface that helps you run custom
Rocket League bots for offline entertainment. It relies on the RLBot
project to work its magic: https://github.com/RLBot/RLBot
Works on Windows and partially works on Linux.
## Useful program arguments for bot devs
- `--debug`: Tricks JavaScript into think that the GUI was compiled in debug mode (won't check for updates on launch)
- `--console`: (Windows only) will spawn a console window that will output all text, and will inherit console if available
- `--no-pipe`: Auto-enables `--console`, on Windows; Won't use the in-GUI console for RLBot-related things, but instead directly to a real console (work-around for some print flushing issues in Python & allowing for maximum print-spam)
### Screenshots
You can download, update or create bots
In Story Mode, you can take over cities by beating challenges and can also
recruit teammates and purchase upgrades for your car!
## Features & fixes unique to the Rust port
### Back-portable
- Add new bots into their proper place in the bot list instead of the end
- Deferred bundle logo loading and missing python package checking
- Better error messages when downloading or upgrading the botpack
- Letting the user close Rocket League in between matches without restarting the GUI
- Full self-updating of the GUI: Implemented for Windows and Ubuntu users & reserved spot on AUR
- Prints get dumped asynchronously to log.txt in content folder
- "Upload GUI log for help" button in Menu (top right) which uploads the log.txt file to HasteBin
- DotNet runtime detection for C# bots to display warning message
- The selected bot tab persists between launches
### Unique to this version
- Launching of the GUI without Python
- Managing Python from within the GUI
- Running RLBot with a custom Python executable
- Easy Python pip fixing if something breaks; top right -> menu -> "Edit/Repair Python Settings"
- Real-time non-blocking subprocess stdout & stderr capture redirected to built-in GUI console for debugging purposes
- In-GUI completely isolated Python installation for Windows users
- Mini-console for quick & easy user status updates (installing packages, etc.)
## User Installation
### Windows
Download the installer from the [latest release in this repo](https://github.com/VirxEC/rlbot_gui_rust/releases/latest).
It will put "RLBotGUI" in your Windows start menu and desktop.
### Debian-based Linux distros
1. Add the public GPG key of the ppa to your system: `wget -O- https://virxec.github.io/rlbot_gui_rust_apt/apt-repo/pgp-key.public | sudo gpg --dearmor -o /etc/apt/trusted.gpg.d/rl-bot-gui.gpg`
- NOTE: You might not see the prompt, but you may need to enter in your sudo password.
- Deprecated method: `wget -O- https://virxec.github.io/rlbot_gui_rust_apt/apt-repo/pgp-key.public | sudo apt-key add -`
2. Add the repository to your system: `echo "deb [arch=amd64] https://virxec.github.io/rlbot_gui_rust_apt/apt-repo/ stable main" | sudo tee /etc/apt/sources.list.d/rl-bot-gui.list > /dev/null`
- Deprecated method: `sudo add-apt-repository 'deb [arch=amd64] https://virxec.github.io/rlbot_gui_rust_apt/apt-repo/ stable main'`
3. Refresh app list: `sudo apt update`
4. Install the GUI: `sudo apt install rl-bot-gui`
### Arch-based Linux distros
**NOTE**: If you wish to compile the GUI on your own system, replace `rlbotgui-rust-bin` with `rlbotgui-rust-git`!
Using yay: `yay -S rlbotgui-rust-bin`
Using paru: `paru -S rlbotgui-rust-bin`
Without using an AUR helper:
1. Setup: `sudo pacman -S --needed base-devel`
2. Clone PKGBUILD: `git clone https://aur.archlinux.org/rlbotgui-rust-bin.git`
3. Navigate to the folder: `cd rlbotgui-rust-bin`
4. Install using PKGBUILD: `makepkg -si`
### Other Linux distros (no easy updates)
We have a pre-compiled binary, icon, and `.desktop` for you! [Get the `linux-basics.tar.gz` from here](https://github.com/VirxEC/rlbot_gui_rust_apt/releases/latest).
If you want to have a script that checks for updates, you could:
1. [Download this JSON](https://api.github.com/repos/VirxEC/rlbot_gui_rust_apt/releases/latest)
2. Compare the `tag_name` from when you last download the binary to the current `tag_name`
3. Download the `asset` with the name `linux-basics.tar.gz` using `browser_download_url`
4. Unzip the `.tar.gz` and put the files in their proper places on your system
### MacOS (no easy updates)
**Warning**: RLBot (not the GUI, the underlying RLBot project) is currently broken on MacOS.
You're going to have to compile the GUI yourself:
1. Follow the [Tauri prerequisites guide](https://tauri.app/v1/guides/getting-started/prerequisites).
2. A system with at least 8GB of RAM is required. 4GB will not work.
3. Clone this repository into your home directory: `git clone https://github.com/VirxEC/rlbot_gui_rust.git`
4. Navigate to the right folder: `cd rlbot_gui_rust/src-tauri`
5. Build the GUI: `cargo build --release`
6. The compiled binary is `target/release/rl-bot-gui`
7. To check for updates, run `git fetch` then `git pull` in the project directory - if there's updates re-run `cargo build --release` to compile the new binary.
## Dev Environment Setup
### Prerequisites
- 16gb of RAM *(minimum 8gb required, might not be able to have other apps open while compiling)*
- 64gb+ free space *(assuming fresh Windows install with no build tools, Rocket League, git, IDE, etc)*
- For non-Windows: SSD *(debug binary is around 500mb on Linux)*
**Windows**
1. Download [the `rustup` tool](https://static.rust-lang.org/rustup/dist/x86_64-pc-windows-msvc/rustup-init.exe)
2. Run the exe, and Rust will be installed on your system. If you're prompted to `Automatically install Visual Studio 2022 Community edition`, you must type `y`.
You should then be prompted to install the required C++ Build Tools and Windows SDK as seen here: 
- To update the `rustup` tool, run `rustup self update` in your terminal
- To update Rust, run `rustup update stable` in your terminal
**Other**
Follow the [Tauri prerequisites guide](https://tauri.app/v1/guides/getting-started/prerequisites).
### Setup
1. Clone this repository
2. Navigate to the `src-tauri` folder
2. Running via:
- `cargo run` - the GUI will compile and launch.
- `cargo run --release` - the GUI will compile with optimizations (like production) and launch.
### Live Reload
- Install Tauri's CLI: `cargo install tauri-cli --version "^1.0.0"`
- NOTE: This will download the CLI source and compile it. If you have yarn and don't wish to compile from source, you can:
- In the project directory, run `yarn add -D @tauri-apps/cli`
- And then replace `cargo` with `yarn`. The generated `package.json` and `yarn.lock` will be auto-ignored.
- Host the `assets` folder on `localhost` port `5500` - the Live Server extension for VS Code can do this:
- Open the `assets` folder in a new VS Code window
- In VS Code's `settings.json`, add the following:
```json
{
"liveServer.settings.host": "localhost",
"liveServer.settings.ignoreFiles": [
"src-tauri/**",
".vscode/**",
]
}
```
- Run the `Open with Live Server` command
- In the `src-tauri` folder, run `cargo tauri dev`. The GUI will now:
- Auto-reload when something changes in the `assets` folder
- Auto-recompile when your code changes in the `src-tauri/src` folder
- You should also now have two windows, one with the `assets` folder open for HTML/CSS/JS dev work and the other for Rust dev work
### Building the GUI installer for users
Taken from the [Tauri guide](https://tauri.app/v1/guides/):
Note that for Linux, you should build on the oldest version of Ubuntu possible. Ubuntu 18.04 is recommended for the best compatibility.
**Method 1: 100% compile from source**
This will not only compile the GUI from source, but also the Tauri CLI. Once the CLI is compiled, you don't need to do it again.
1. Navigate to the `src-tauri` folder
2. Run `cargo install tauri-cli --version "^1.0.0"`
3. In the project directory, run `cargo tauri build`
**Method 2: Do it quickly with yarn**
This will download a pre-compiled version of the Tauri CLI.
1. Run `yarn add -D @tauri-apps/cli`
2. In the project directory, run `yarn tauri build`
### How to update items in the appearance editor
1. Install and run [BakkesMod](http://www.bakkesmod.com/)
2. In Rocket League, press F6 to open the BakkesMod console, and enter the `dumpitems` command
3. Find the output `items.csv` in the folder where your `RocketLeague.exe` is, usually `C:/Program Files (x86)/Steam/steamapps/common/rocketleague/Binaries/Win64`
4. Replace `assets/csv/items.csv` with the new file
5. Change encoding of the new file to UTF-8. Here's how to do that in VS Code:
- use the _Change File Encoding_ command (or click the UTF-8 button in the bottom right)
- select _Reopen with Encoding_, select the one with _Guessed from content_ (probably Windows 1252)
- now do that again, but _Save with Encoding_ and _UTF-8_
6. Don't forget to bump the version number in `src-tauri/Cargo.toml`