hut/outfly
hut/outfly
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
A wholesome 3D space game in the rings of Jupiter https://codeberg.org/hut/outfly
308 commits 1 branch 33 tags 84 MiB
Rust 94.9%
WGSL 2%
Python 1.3%
Shell 1%
Nix 0.7%
Other 0.1%
Find a file
yuni 7dd2b14c40 make icon background transparent
2024-03-31 21:09:43 +02:00
assets add second MeteorAceGT behind pizza place 2024-03-31 04:11:49 +02:00
doc make icon background transparent 2024-03-31 21:09:43 +02:00
src play collision sound only on start of collision 2024-03-31 05:13:21 +02:00
.gitignore ignore "extra" directory 2024-03-22 11:45:57 +01:00
Cargo.lock bump to v0.4.0 2024-03-31 05:16:02 +02:00
Cargo.toml bump to v0.4.0 2024-03-31 05:16:02 +02:00
README.md clarify licenses 2024-03-31 21:09:33 +02:00

README.md

OutFly

screenshot

OutFly is an atmospheric, open world, 100% hard sci-fi 3D game that throws you into the main ring of Jupiter, hundreds of years into the future.

Key features:

  • Open source forever
  • Open world, realistic hard sci-fi, atmospheric, deadly
  • Accurate star chart. Can you spot the constellations?
  • Cross platform (verified on Linux & Windows)
  • Written in Rust with the Bevy game engine
  • Status: Early access, not much content

screenshot

Key Bindings

  • Space: stop moving
  • AWSD: accelerate
  • Shift and Ctrl: accelerate up and down
  • JKLUIO: mouseless camera rotation
  • e: open communication channel to nearby astronauts
  • t: toggle music (NOTE: currently no music is included in the git repo)
  • m: mute sound effects
  • q: enter/exit vehicle
  • r: rotate (hold r while moving the mouse)
  • f: toggle 3rd person view
  • TAB: toggle augmented reality overlay (HUD, low-light amplifier)

System Requirements

  • Screen, keyboard
  • Operating System: Linux, Windows, MacOS
  • Ideally, a graphics card with vulkan support

If your GPU does not support vulkan, try rendering with OpenGL by setting the environment variable WGPU_BACKEND to gl, like:

WGPU_BACKEND=gl ./outfly
or
WGPU_BACKEND=gl cargo run

However, this may result in poor performance and visual glitches.

Running OutFly

  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

On Linux

Install the build dependencies. On ArchLinux, it's the following, though you can replace rust with rustup:

pacman -S rust libx11 pkgconf alsa-lib

Then run the following commands, replacing [URL] with the clone URL of the git repository:

git clone [URL]
cd outfly
cargo run --release

NOTE: Audio is muted by default when run through cargo run, unless you add --release

Building for Windows on Linux

rustup target add x86_64-pc-windows-gnu
pacman -S mingw-w64-toolchain  # on ArchLinux. other distros have their equivalent package
cargo build --target=x86_64-pc-windows-gnu --release

More information here: https://bevy-cheatbook.github.io/setup/cross/linux-windows.html

Building on Mac OS

Install homebrew, and then get the following dependencies:

brew install pkg-config molten-vk rustup
rustup-init

Download, compile and run the game:

git clone [URL]
cd outfly
cargo run --release

Credits and License