more detailed description of how to run outfly
This commit is contained in:
parent
42fd96a96d
commit
2214790e53
28
README.md
28
README.md
|
@ -53,10 +53,24 @@ WGPU_BACKEND=gl cargo run
|
||||||
|
|
||||||
However, this may result in poor performance and visual glitches.
|
However, this may result in poor performance and visual glitches.
|
||||||
|
|
||||||
# Building
|
# Running OutFly
|
||||||
## General notes
|
|
||||||
|
|
||||||
For development, it's recommended to use `--features dev` to enable dynamic linking, e.g. like this:
|
1. Download a release for your operating system at https://codeberg.org/hut/outfly/releases
|
||||||
|
2. On Linux, you need the dependency packages: `glibc libcap gcc-libs alsa-lib systemd-libs`. These are the names for ArchLinux, they may differ on your distribution.
|
||||||
|
3. Unpack and run the outfly/outfly.exe executable.
|
||||||
|
1. On Windows, just double-click on outfly.exe
|
||||||
|
2. On Linux, open the console and type this:
|
||||||
|
|
||||||
|
```
|
||||||
|
cd [path-to-extracted-outfly-directory]
|
||||||
|
./outfly
|
||||||
|
```
|
||||||
|
|
||||||
|
# Building
|
||||||
|
|
||||||
|
If there is no package for the version or operating system that you need, or if you wish to tinker on the game, you can also build outfly yourself.
|
||||||
|
|
||||||
|
For development, it's recommended to use `--features dev` to enable dynamic linking for faster compile times, e.g. like this:
|
||||||
|
|
||||||
```
|
```
|
||||||
cargo [run|build] --features dev
|
cargo [run|build] --features dev
|
||||||
|
@ -64,13 +78,7 @@ cargo [run|build] --features dev
|
||||||
|
|
||||||
## On Linux
|
## On Linux
|
||||||
|
|
||||||
To run the pre-compiled version on Arch Linux, you need some basic libs:
|
Install the build dependencies. On ArchLinux, it's the following, though you can replace `rust` with `rustup`:
|
||||||
|
|
||||||
```
|
|
||||||
pacman -S glibc libcap gcc-libs alsa-lib systemd-libs
|
|
||||||
```
|
|
||||||
|
|
||||||
To build the game on Arch Linux yourself, you need these, although you can replace `rust` with `rustup`:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
pacman -S rust libx11 pkgconf alsa-lib
|
pacman -S rust libx11 pkgconf alsa-lib
|
||||||
|
|
Loading…
Reference in a new issue