Skip to content

Enhance asset setup instructions in README.md #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Enhance asset setup instructions in README.md #29

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7042c18
Update README.md to enhance asset setup instructions
clicktodev Oct 16, 2025
98ee477
Update README.md to clarify development section and remove redundant …
clicktodev Oct 16, 2025
acce869
Update README for asset setup instructions
clicktodev Oct 16, 2025
e805275
Update README.md to emphasize the retention period of GitHub workflow…
clicktodev Oct 16, 2025
d4b0aa0
Update README with correct workflow link
clicktodev Nov 3, 2025
e7f8a5e
Update link to latest workflow in README
clicktodev Nov 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 34 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,45 @@
OpenFusionClient rewrite with Tauri 2.0, Next.js and React.

## Setup

### Setup development environment

1. Ensure you have all the required [prerequisites](https://v2.tauri.app/start/prerequisites/) installed
2. Install the Tauri CLI with `cargo install tauri-cli --version "^2.0.0" --locked`
3. Install dependencies with `npm install`

## Dev
### Setup required assets

> [!NOTE]
> GitHub workflow artifacts are retained for 90 days max. Which means prebuilt artifacts may not be available by the time you read this.

#### Setup all assets in one step

1. Open the latest workflow at <https://github.com/OpenFusionProject/OpenFusionLauncher/actions?query=branch%3Amain>
2. Download the artifact named `ffrunner-mingw`
3. Copy contents to `resources/ffrunner`

#### Or setup assets separately

1. FFRunner binary
1. To build locally on Ubuntu
1. run `sudo apt update && sudo apt install -y gcc-mingw-w64-i686 wget`
2. run `make -C resources/ffrunner`
2. Can't build locally? Consider a prebuilt binary
1. Open the latest workflow at <https://github.com/OpenFusionProject/ffrunner/actions?query=branch%3Amaster>
2. Download the artifact named `ffrunner`
3. Copy contents to `resources/ffrunner`
2. Webplayer DLLs
1. run `wget -r -l 7 -np -R "index.html*" -nH --cut-dirs=2 https://cdn.dexlabs.systems/webplayer/patched-latest/ -P resources/ffrunner/`
3. Vulkan wrapper DLL
1. run `wget https://github.com/doitsujin/dxvk/releases/download/v1.10.3/dxvk-1.10.3.tar.gz`
2. run `tar -xvf dxvk-1.10.3.tar.gz`
3. run `mv dxvk-1.10.3/x32/d3d9.dll resources/ffrunner/d3d9_vulkan.dll`

## Development

Run `cargo tauri dev` to spawn the app. **Hot reload is on, so any changes you make will immediately reflect.**

## Production
Run `cargo tauri build` to build a production binary and any applicable installers or bundles for the current platform. Note that `cargo build --release` will not produce a useful binary as it does not embed the web pages into the application.

Run `cargo tauri build` to build a production binary and any applicable installers or bundles for the current platform.