gilgamesh/liblast
1
0
Fork 0
forked from unfa/liblast
Code Issues Pull requests Projects Releases Wiki Activity

Added running instructions

Browse source
This commit is contained in:
unfa 2021-06-22 14:07:10 +02:00 committed by GitHub
parent b4d163100d
commit e064e6ea0f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -1,8 +1,7 @@
# Liblast
Libre Multiplayer FPS Game built with Godot game engine and a fully FOSS toolchain.
![Screenshot 01](https://github.com/unfa/liblast/raw/legacy/Screenshots/01.png)
![Screenshot 02](https://github.com/unfa/liblast/raw/legacy/Screenshots/02.png)
![Screenshot 03](https://github.com/unfa/liblast/raw/legacy/Screenshots/03.jpg)
## Rewrite Status
@ -13,6 +12,24 @@ We wanted to take advantage of the improved performance, features and workflow o
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!
## How to run the game
1. Make sure you have `git` and `git-lfs` installed.
1. Clone the Git repository: `git clone git@github.com:unfa/liblast.git`
1. Enter thr cloned repository: `cd liblast`
1. Initialize Git-LFS: `git lfs install`
1. Pull the large files: `git pull`
1. Extract the godot editor binary: `tar -xvf ./Godot/godot-v4.0.dev.calinou.94c31ba30.Linux-x64.tar.gz`
1. Run the Godot editor binary and load the project: `./Godot/godot-v4.0.dev.calinou.94c31ba30.Linux-x64 ./Game/project.godot`
Once Godot editor loads the project, hit `F5` to start the game
## Get in touch
If you want to talk to the devs and discuss the game in an instant manner, go here:
@ -30,10 +47,17 @@ https://chat.unfa.xyz/channel/liblast
Because of Godot 4's unstable nature, thing may not work. The gmae is being developed using the `v4.0.dev.calinou.94c31ba30` build of the engine.
You can clone the Godot source code of the specified commit and it should work, though sometimes the project just won't load. That's the price of using unfinished software for production :D Once Godot 4 alpha is out, the development should be able to continue on a bit more smoothly.
# What's with the name?
`Libre` + `Blast` = `Liblast`
No, it's not a library ;)
---
# Stuff below applies only to the legacy branch
![Screenshot 01](https://github.com/unfa/liblast/raw/legacy/Screenshots/01.png)
![Screenshot 02](https://github.com/unfa/liblast/raw/legacy/Screenshots/02.png)
## Controls
Standard FPS stuff:
@ -68,7 +92,3 @@ https://youtu.be/aUtSLNzvqvI
Video of a version of the game not long before 0.1 release:
https://youtu.be/g3KvNeu4X54 (quite outdated as of 2021-02)
# What's with the name?
`Libre` + `Blast` = `Liblast`
No, it's not a library. Sorry if it's confusing.