forked from unfa/liblast
87 lines
2.7 KiB
Markdown
87 lines
2.7 KiB
Markdown
<p align="center"><img src="https://git.gieszer.link/unfa/liblast/media/branch/main/Design/Logo.png" alt="Liblast - a Libre Multiplayer FPS Game"></p>
|
|
|
|
# Liblast
|
|
|
|
A Libre Multiplayer FPS Game built with Godot game engine and a fully FOSS toolchain.
|
|
|
|
---
|
|
|
|
Subscribe to the [YouTube channel](https://www.youtube.com/channel/UC1Oi1eXwdr8RlqIslyht5AQ) for upcoming video updates!
|
|
|
|
![Screenshot](https://git.gieszer.link/unfa/liblast/media/branch/main/Screenshots/02.jpg)
|
|
|
|
## Rewrite Status
|
|
|
|
The game is currently being rewritten from scratch in Godot 4.
|
|
The legacy branch contains the initial, Godot 3-based version of the game. This version of the game has served well as a prototype and a testbed to help us figure out what we want to do. We've also learned some important lessons on our mistakes.
|
|
|
|
We wanted to take advantage of the improved performance, features and workflow of Godot 4 and since the GDScript syntax is changing significantly - we've decided we'll take this opportunity to rebuild the game from scratch and improve our design.
|
|
|
|
Hence - if you'd like to contribute to the project, please get in touch first, as things are very much in flux right now, and we'd hate to have any effort wasted!
|
|
|
|
**DISCLAIMER: THE GAME IS IN VERY EARLY STAGES OF DEVELOPMENT.
|
|
DO NOT EXPECT MUCH**
|
|
|
|
**PLEASE DO NOT REPORT ISSUES OR PROPOSE FEATURES AT THIS POINT IN TIME - IF YOU WANT TO HELP, GET IN TOUCH FIRST!**
|
|
|
|
## Get in touch
|
|
|
|
If you want to talk to the dev team and discuss the game in an instant manner, go here:
|
|
https://chat.unfa.xyz/channel/liblast
|
|
|
|
## How to run the game
|
|
|
|
### GNU/Linux
|
|
|
|
1. Make sure you have `git`, `git-lfs` and `unzip` installed.
|
|
|
|
2. Clone the Git repository:
|
|
```
|
|
git clone ssh://git@git.gieszer.link:2222/unfa/liblast.git
|
|
```
|
|
|
|
3. Enter the cloned repository:
|
|
```
|
|
cd liblast
|
|
```
|
|
|
|
4. Initialize Git-LFS:
|
|
```
|
|
git lfs install
|
|
```
|
|
|
|
5. Pull the large files (if any):
|
|
```
|
|
git lfs pull
|
|
```
|
|
|
|
6. Extract the godot editor binary:
|
|
```
|
|
cd ./Godot
|
|
unzip godot-linux-nightly-x86_64.zip
|
|
```
|
|
|
|
7. Run the Godot editor binary and load the project:
|
|
```
|
|
./godot ../Game/project.godot
|
|
```
|
|
|
|
Once Godot editor loads the project, hit `F5` to start the game
|
|
|
|
## Controls
|
|
|
|
- WASD to walk around
|
|
- mouse too look around
|
|
- mouse 1 to shoot
|
|
- space bar to jump
|
|
- shift to use the jetpack
|
|
- T to write to your team mates (not complete yet)
|
|
- Y to write to all players on the server (not complete yet)
|
|
|
|
Because of Godot 4's unstable nature, things may not work. The game is being developed using the `v4.0.dev.calinou.94c31ba30` build of the engine - the builds of the engine are included in this repository for the conveniece of developers and users.
|
|
|
|
# What does the name of this project mean?
|
|
|
|
`Libre` + `Blast` = `Liblast`
|
|
|
|
No, it's not a library ;) |