liblast/README.md

<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](./Screenshots/01.jpg)
---
![Screenshot](./Screenshots/02.jpg)
---
![Screenshot](./Screenshots/03.jpg)
---
![Screenshot](./Screenshots/04.jpg)
---
![Screenshot](./Screenshots/05.jpg)
---

**DISCLAIMER: THE GAME IS IN EARLY STAGES OF DEVELOPMENT.
DO NOT EXPECT MUCH**

## How To Play

### Download the game

Go to the [releases page](https://git.gieszer.link/unfa/liblast/releases) and download the latest release of the game. You'll find some instructions and notes there as well:


There's one public dedicated server running at `liblast.unfa.xyz`.

To start playing Liblast it's recommended to first host a local game and adjust your mouse sensitivity and other preferences, as well as modify your profle (player name and color). Then connect to the public server (or any other that you know of) and play!

### Controls

| Key          | Action         |
|--------------|----------------|
| WASD         | Movement       |
| Mouse        | Camera         |
| Left Click   | Shoot          |
| Space        | Jump           |
| Shift (Hold) | Jetpack        |
| T            | Chat with Team |
| Y            | Chat with All  |
| Z            | Zoom           |
| ESC          | Main Menu      |

## 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 and Getting in touch

Check the [Contribution Guide!](./CONTRIBUTING.md)

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 Edit the Game

[Get the Godot 4 Editor](https://downloads.tuxfamily.org/godotengine/testing/4.0/4.0-dev.20211015) for your OS

For example for Linux you need `Godot_[version]_linux.64.zip`. Extract the archive to obtain the Godot editor binary.

If you want to export the game (make game builds) you'll also need to download (and subsequently install in Godot) the export templates (file ending with `.tpz`).

After you have that done - proceeed based on your OS:

### 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 Git-LFS stored files:
```
git lfs pull
```

6. Run the Godot editor and import the project located in `../Game/project.godot`

### 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 Git-LFS stored files:
```
git lfs pull
```

6. Run the Godot editor and import the project located in `../Game/project.godot`


## What does the name of this project mean?

`Libre` + `Blast` = `Liblast`

No, it's not a library ;)