135 lines
4.3 KiB
Markdown
135 lines
4.3 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/01.jpg)
|
|
![Screenshot](https://git.gieszer.link/unfa/liblast/media/branch/main/Screenshots/02.jpg)
|
|
![Screenshot](https://git.gieszer.link/unfa/liblast/media/branch/main/Screenshots/03.jpg)
|
|
![Screenshot](https://git.gieszer.link/unfa/liblast/media/branch/main/Screenshots/04.jpg)
|
|
![Screenshot](https://git.gieszer.link/unfa/liblast/media/branch/main/Screenshots/05.jpg)
|
|
|
|
**DISCLAIMER: THE GAME IS IN EARLY STAGES OF DEVELOPMENT.
|
|
DO NOT EXPECT MUCH**
|
|
|
|
## Rewrite Status
|
|
|
|
The game has been mostly 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.
|
|
|
|
Compared to the legacy version, most of the features are done, along with some extra things thet were either not done or not possible in Godot 3.
|
|
|
|
## Contributing
|
|
|
|
If you'd like to contribute to the project, please get in touch first, as we've got some designs goin on, and we'd hate to have any effort wasted!
|
|
|
|
|
|
## 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 https://git.gieszer.link/unfa/liblast.git
|
|
```
|
|
|
|
3. Enter the cloned repository:
|
|
```
|
|
cd liblast
|
|
```
|
|
|
|
4. Initialize Git-LFS:
|
|
```
|
|
git lfs install
|
|
```
|
|
|
|
5. Pull the large files (notably the currently used Godot binaries):
|
|
```
|
|
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. Alternatively you can run tehe `Liblst.sh` script, that'll do this for you.
|
|
|
|
### Windows (untested!)
|
|
|
|
1. Install Git for Windows: https://gitforwindows.org/
|
|
|
|
|
|
2. Clone the Git repository:
|
|
```
|
|
git clone https://git.gieszer.link/unfa/liblast.git
|
|
```
|
|
|
|
3. Open GitBash in the cloned repository (ther should be an option in the context menu in Windows Explorer)
|
|
|
|
4. Initialize Git-LFS:
|
|
```
|
|
git lfs install
|
|
```
|
|
|
|
5. Pull the large files (notably the currently used Godot binaries):
|
|
```
|
|
git lfs pull
|
|
```
|
|
|
|
6. Extract the godot editor binary (you can use Windows Explorer I guess):
|
|
```
|
|
unzip godot-windows-nightly-x86_64.zip
|
|
```
|
|
|
|
7. Run the Godot editor binary:
|
|
```
|
|
godot.exe
|
|
```
|
|
|
|
8. Import the Liblast game project into Godot.
|
|
1. Click on "Import" and select the `\Liblast\Game\` directory (it should contain a `project.godot` file)
|
|
2. Click "Import and Edit" - the project will now be added to your projects list and will be easily accessible later
|
|
|
|
9. Once Godot editor loads the project, hit `F5` to start the game. Alternatively you can click "Run" rom teh Project Selection in Godot, without loading it in the editor.
|
|
|
|
|
|
## 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)
|
|
- Z to zoom
|
|
- Esc for menu
|
|
|
|
Because of Godot 4's unstable nature, things may not work. The game is being developed using the a particular build of the engine - the builds of the engine are included in this repository for the conveniece of developers and users. but to access them (in `Godot` directory) you need to clone the repository, install and pull from Git-LFS.
|
|
|
|
# What does the name of this project mean?
|
|
|
|
`Libre` + `Blast` = `Liblast`
|
|
|
|
No, it's not a library ;) |