Update 'README.md'
parent
c193112db7
commit
0760a32af0
48
README.md
48
README.md
|
|
@ -4,11 +4,20 @@
|
|||
|
||||
A Libre Multiplayer FPS Game built with Godot game engine and a fully FOSS toolchain.
|
||||
|
||||
The goals of the project are as follows:
|
||||
Primary goals:
|
||||
|
||||
1. Create a fun open-source game for everyone to enjoy
|
||||
2. Prove that libre creative tools suffice to make a good game - we use only open-source software in the production
|
||||
3. Have fun working together, get to know each other and learning as we go
|
||||
3. Have fun, get to know each other and grow together with the project
|
||||
|
||||
Secondary goals:
|
||||
|
||||
1. Push the envelope of open-source FPS games in regards to a coherent design, style, technology and overall quality
|
||||
2. Enable the game to be playable on lower-end computers, but provide higher fidelity for those who have more powerful hardware
|
||||
3. Allow joining the game from a web browser for quick sessions, as well as providing downloadable package for residential or portable usage
|
||||
4. Actively help the development of Godot engine and other open-source tools that we depend on
|
||||
5. Facilitate 3rd party content via mods
|
||||
6. Provide optional online accounts to securely store user data and protect their in-game identity
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -16,30 +25,23 @@ Subscribe to the [YouTube channel](https://www.youtube.com/channel/UC1Oi1eXwdr8R
|
|||
|
||||
[**Watch the latest public playtesting session**](https://youtu.be/0R40GuIn5GA)
|
||||
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
|
||||
**DISCLAIMER: THE GAME IS IN EARLY STAGES OF DEVELOPMENT.
|
||||
DO NOT EXPECT MUCH**
|
||||
Due to reported **issues with cloning the game repository** as a temporary aid we provide a [REPOSITORY SNAPSHOT (8.4 GB, 7-zip)](https://mega.nz/file/ew4AACwA#E3HRtFh0a6PWErLMgvoAcUe6TSCFc6sBRzQi7L8VsgA).
|
||||
Download, extract and proceed with `git pull` to update.
|
||||
---
|
||||
|
||||
---
|
||||
|
||||
## 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:
|
||||
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` the game will present the server address upon startup.
|
||||
|
||||
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!
|
||||
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 a server and play!
|
||||
|
||||
### Controls
|
||||
|
||||
|
|
@ -55,14 +57,6 @@ To start playing Liblast it's recommended to first host a local game and adjust
|
|||
| 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
|
||||
|
||||
|
|
@ -94,7 +88,7 @@ cd liblast
|
|||
git lfs install
|
||||
```
|
||||
|
||||
5. Pull the Git-LFS stored files (that includes the bundled Godot editor):
|
||||
5. Pull the Git-LFS stored files (that includes the bundled Godot editor binaries):
|
||||
```
|
||||
git lfs pull
|
||||
git fetch
|
||||
|
|
@ -145,6 +139,6 @@ git fetch
|
|||
|
||||
## What does the name of this project mean?
|
||||
|
||||
`Libre` + `Blast` = `Liblast`
|
||||
`Libre` + `Blast` = `Liblast` (pronounced _ˈlɪblɑːst_)
|
||||
|
||||
No, it's not a library ;)
|
||||
Reference in New Issue