From fad7347cd98adabe0a6c2f9440a9e0e79ffb2b1a Mon Sep 17 00:00:00 2001 From: hut Date: Sun, 21 Apr 2024 19:11:02 +0200 Subject: [PATCH] rephrased "Running OutFly" section --- README.md | 28 +++++++++++++++++++++------- 1 file changed, 21 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index ff8ed2a..65a8fc6 100644 --- a/README.md +++ b/README.md @@ -67,17 +67,20 @@ Links: - X: Teleport to target # Running OutFly +## System Requirements -System Requirements: Screen/keyboard/mouse, Linux/Windows/Mac, and a graphics card with vulkan support. +- Screen/keyboard/mouse +- Operating System: Linux, Windows, Mac +- A graphics card with vulkan support -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: +## Running on Linux + +1. Download and unpack the latest release: https://codeberg.org/hut/outfly/releases +2. Open a terminal and navigate to the directory where you unpacked outfly +3. If you are on ArchLinux, type the following commands. For other distributions, replace "pacman -S" with the distro's command to install packages. Also, the packages may be called slightly differently. ``` -cd [path-to-extracted-outfly-directory] +pacman -S glibc libcap gcc-libs alsa-lib systemd-libs ./outfly ``` @@ -87,6 +90,17 @@ If your graphics card does not support vulkan, try setting the environment varia WGPU_BACKEND=gl ./outfly ``` +Alternatively, you can also install OutFly as a package, if your distribution has one. This will place OutFly in your "start menu". As of writing, only an ArchLinux AUR package exists, which you can install with this command: + +``` +yay -S outfly-git +``` + +## Running on Windows + +1. Download and unpack the latest release: https://codeberg.org/hut/outfly/releases +2. Double-click on `OutFly.exe` + # 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.