Shortened README

This commit is contained in:
yuni 2024-04-21 18:50:02 +02:00
parent 03a5cd0831
commit 0687952258

View file

@ -10,7 +10,7 @@
+ ▀████████████████████████████████████████████████████▀ + ▀████████████████████████████████████████████████████▀
``` ```
[Controls](#key-bindings) • [System Requirements](#system-requirements) • [Running OutFly](#running-outfly) • [Building](#building) • [Changelog](#changelog) • [Credits/License](#credits-and-license) [Features](#features) • [Controls](#controls) • [Running OutFly](#running-outfly) • [Building](#building) • [Changelog](#changelog) • [Credits](#credits)
# OutFly # OutFly
@ -20,7 +20,14 @@ Imagine a blend of [Fallout](https://en.wikipedia.org/wiki/Fallout_%28series%29)
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 [still in development], 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. 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 [still in development], 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.
Key features: Links:
- [Source code](https://codeberg.org/hut/outfly)
- [itch.io page](https://wholesomevacuum.itch.io/outfly)
- [Game updates on Mastodon](https://mastodon.gamedev.place/@outfly)
- [Chatroom](https://matrix.to/#/#outfly:pub.solar)
# Features
- Open source forever - Open source forever
- Open world, realistic hard sci-fi, atmospheric, deadly - Open world, realistic hard sci-fi, atmospheric, deadly
@ -29,14 +36,7 @@ Key features:
- Written in [Rust](https://www.rust-lang.org) with the [Bevy game engine](https://bevyengine.org) - Written in [Rust](https://www.rust-lang.org) with the [Bevy game engine](https://bevyengine.org)
- Status: Early access, not much content - Status: Early access, not much content
Links: # Controls
- [Source code](https://codeberg.org/hut/outfly)
- [itch.io page](https://wholesomevacuum.itch.io/outfly)
- [Game updates on Mastodon](https://mastodon.gamedev.place/@outfly)
- [Chatroom](https://matrix.to/#/#outfly:pub.solar)
# Key Bindings
- F1: Show key bindings - F1: Show key bindings
- Space: Slow down (or match velocity) - Space: Slow down (or match velocity)
@ -64,24 +64,10 @@ Links:
- C: Impossibly instant stopping - C: Impossibly instant stopping
- X: Teleport to target - X: Teleport to target
# 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 # Running OutFly
System Requirements: Screen/keyboard/mouse, Linux/Windows/Mac, and a graphics card with vulkan support.
1. Download a release for your operating system at https://codeberg.org/hut/outfly/releases 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. 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. 3. Unpack and run the outfly/outfly.exe executable.
@ -93,6 +79,12 @@ cd [path-to-extracted-outfly-directory]
./outfly ./outfly
``` ```
If your graphics card does not support vulkan, try setting the environment variable `WGPU_BACKEND=gl`: (will result in poor performance)
```
WGPU_BACKEND=gl ./outfly
```
# Building # 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. 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.
@ -231,7 +223,7 @@ python -m http.server -d wasm
- v0.1.1: Better sky box and HUD - v0.1.1: Better sky box and HUD
- v0.1.0: First release with basic controls, HUD, sounds, skybox, sun - v0.1.0: First release with basic controls, HUD, sounds, skybox, sun
# Credits and License # Credits
- Source code: GPL Version 3.0 - Source code: GPL Version 3.0
- 3D models: Original art, placed under the Creative Commons CC0 License - 3D models: Original art, placed under the Creative Commons CC0 License