![OutFly Screenshot](doc/branding/banner.jpg)

[Features](#features) • [Tutorial](#tutorial) • [Controls](#controls) • [Running OutFly](#running-outfly) • [Troubleshooting](#troubleshooting)

# OutFly

[![License: GPL 3.0](doc/images/badge-gpl3.svg)](https://www.gnu.org/licenses/gpl-3.0.html)
[![Powered by Bevy](doc/images/badge-bevy.svg)](https://bevyengine.org)
[![Available on itch.io](doc/images/badge-itch.svg)](https://yunicode.itch.io/outfly)
[![Donate on Liberapay](https://img.shields.io/liberapay/patrons/outfly?logo=liberapay&logoColor=%23ffffff)](https://liberapay.com/outfly)
[![Follow on Mastodon](https://img.shields.io/mastodon/follow/112327969307230863)](https://mastodon.social/@outfly)

OutFly is an atmospheric, open world, realistic 3D space game that throws you into the [Rings of Jupiter](https://en.wikipedia.org/wiki/Rings_of_Jupiter) with a self-sufficient sportswear space suit that will take you anywhere.

Imagine a blend of [Fallout](https://en.wikipedia.org/wiki/Fallout_%28series%29) and [Outer Wilds](https://en.wikipedia.org/wiki/Outer_Wilds), where you are free to explore the breathtaking expanse of the Jupiter system and discover what life could be like after hundreds of years of space colonization.

This game aims to respect the player as much as possible. It doesn't waste your time: Despite the vastness of space, nothing takes too long. Speed cheats are active by default, allowing you to visit places you normally couldn't, without passing out from the g-forces. There are no anxiety-causing features (apart of, maybe, space itself), no loading screens, nothing to micromanage, not even save games. You can plunge into the game any time you feel like it, and it's up to you whether you just want to soak in the beautiful scenery, engage with the survival mechanics, or dive into the game story [still in development]. And finally, it's not just DRM-free but completely open source, allowing you to tinker on any part of the game to your liking.

Source code: https://codeberg.org/outfly/outfly

# Features

- A beautiful, serene atmosphere with gorgeous views
- Racing vehicles, unique NPCs, cozy places, deadly environment
- Accurate, clickable star chart. Can you spot the constellations?
- Cross platform, [free & open source](https://codeberg.org/outfly/outfly) forever!
- Written in [Rust](https://www.rust-lang.org) with the [Bevy game engine](https://bevyengine.org)
- Status: Early access, not much content

# Tutorial

OutFly has typical game controls like mouse movement, `A/W/S/D` for horizontal movement, `Ctrl/Shift` for vertical movement.  But in space, there is no friction to slow you down after the movement. [You just keep on moving](https://en.wikipedia.org/wiki/Newton%27s_laws_of_motion#First_law), until you hit something or accelerate in the opposite direction.

The `SPACE` key helps you move more intuitively by slowing you down.  Hold it for a while to come to a halt.  Combine it with movement keys for slower, more precise movement.  You can also click to select another object and then hold the `SPACE` key to **match your velocity** to the target object.  Essential for spaceflight!

When you're ready, take a look around, explore the starting area. There is a friendly person floating nearby in a red space suit that would love to talk to you.

The game is dark.  After all, space is dark.  The planets and moons orbit in real time, the map changes depending on when you play, and if you're unlucky, you start in the shadow of Jupiter and everything's even darker!  Try the flashlight (`f` key), or stronger light amplification (menu), which requires Augmented Reality to be active (`TAB` key).

Press `Esc` for the menu to restart the game if you get lost, explore more key bindings, game features, and the **achievements** to get some guidance on what you can do in the game.

But in the end, OutFly is an open world game with no true goals other than the ones you set for yourself.  Just lean back, get cozy, and drift towards whatever catches your eye :)

# Controls

Press **ESC** to view these any time from the in-game menu.

- **Space**: Slow down, match velocity
- **E**: Interact
- **F**: Flashlight
- **Q**: Exit vehicle
- **M**: Map
- **C**: Camera
- **T**: Cruise control
- **R**: Rotate (hold + move mouse)
- **Y**: Rotation stabilizer
- **`**: Fast forward conversation
- **AWSD/Shift/Ctrl**: Move
- **J/K/U/L/I/O**: Rotate
- **F11**: Fullscreen
- **Tab**: Toggle Augmented Reality
- **Left click**: Target objects (in AR only)
- **Right click**: Zoom

Cheats:

- **G**: Toggle cheats + invulnerability
- **V/B**: Impossible acceleration
- **Shift+V/B**: Extreme acceleration
- **X**: Teleport to target
- **Z**: Stop

# Running OutFly
## System Requirements

- Screen/keyboard/mouse
- Operating System: Linux, Windows, Mac
- A graphics card with vulkan support

## Running on Linux

1. Download and unpack the latest release: https://codeberg.org/outfly/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.

```
pacman -S glibc libcap gcc-libs alsa-lib systemd-libs
./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
```

See also: [build instructions](https://codeberg.org/outfly/outfly/src/branch/main/build/README.md)

## Running on Windows

1. Download and unpack the latest release: https://codeberg.org/outfly/outfly/releases
2. Double-click on `OutFly.exe`

## Running on MacOS / Android / iOS

No releases for these operating systems exist yet. For MacOS, you can build OutFly yourself using the [build instructions](https://codeberg.org/outfly/outfly/src/branch/main/build/README.md). Support for Android/iOS is planned for the future.

# Troubleshooting
## I'm stuck inside another object

Try turning on God Mode and using one of the speed cheats, that should get you out.

## My GPU doesn't support Vulkan!

Try running outfly with the command-line option "--gl", with one of these commands:

```
./outfly --gl
cargo run -- --gl
```

This will result in some visual glitches, reduced performance, as well as a lot of error messages about CubeArrays which you can safely ignore.  You can alternatively achieve this by setting the environment variable `WGPU_BACKEND` to `gl`: `WPU_BACKEND=gl ./outfly`.

## The game instantly crashes!

Try changing the full screen mode with the command line option "--fs-legacy":

```
./outfly --fs-legacy
cargo run -- --fs-legacy
```

If this doesn't work, please open an issue on https://codeberg.org/outfly/outfly and provide as many details as you can, including the crash log.

## Crash with "error while loading shared libraries"

If you build with `--features dev`, then you must not run the game `./outfly`. Use `cargo run` instead.

## The assets can't be found

If you build without the "`embed_assets`" feature, the asset folder must be in the same path as the outfly binary. Possible solutions are to symlink the `assets` directory into the `target/$yourtarget/` folder, to instead run with `cargo run`, or to compile with "`--features embed_assets`" (which is enabled by default).

## I'm on Windows. How do I use command line options?

Create a shortcut, change the target from `[...]outfly.exe` to e.g. `[...]outfly.exe --gl`.

See https://superuser.com/questions/1202989/how-to-you-add-a-parameter-to-an-executable-in-windows-10