A Libre Multiplayer FPS Game built with Godot 4 engine and a fully open-source toolchain https://libla.st
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Liblast/README.adoc

261 lines
6.0 KiB

= Liblast
:url-main: https://codeberg.org/Liblast/Liblast/src/branch/main
:url-main-raw: https://codeberg.org/Liblast/Liblast/raw/branch/main
:url-git: https://codeberg.org/Liblast/Liblast.git
:toc: macro
:toclevels: 1
:toc-title: Liblast
++++
<p align="center">
<img src="https://codeberg.org/Liblast/liblast/media/branch/main/Design/Logo.png"></br></br>
<b>A Libre Multiplayer FPS Game built with Godot 4 game engine and a fully FOSS toolchain.</b></br></br>
</p>
++++
[cols="1,1,1", grid="none"]
|===
|image:Screenshots/thumb_01.jpg[Screenshot 1, link={url-main-raw}/Screenshots/01.jpg]
|image:Screenshots/thumb_02.jpg[Screenshot 2, link={url-main-raw}/Screenshots/02.jpg]
|image:Screenshots/thumb_03.jpg[Screenshot 2, link={url-main-raw}/Screenshots/03.jpg]
|image:Screenshots/thumb_04.jpg[Screenshot 4, link={url-main-raw}/Screenshots/04.jpg]
|image:Screenshots/thumb_05.jpg[Screenshot 3, link={url-main-raw}/Screenshots/05.jpg]
|image:Screenshots/thumb_06.jpg[Screenshot 3, link={url-main-raw}/Screenshots/06.jpg]
|===
toc::[]
== Goals
.Primary goals:
. Create a fun open-source game for everyone to enjoy
. Prove that libre creative tools suffice to make a good game - we use only open-source software in the production
. Have fun, get to know each other and grow together with the project
.Secondary goals:
. Push the envelope of open-source FPS games in regards to a coherent design, style, technology and overall quality
. Enable the game to be playable on lower-end computers, but provide higher fidelity for those who have more powerful hardware
. Allow joining the game from a web browser for quick sessions, as well as providing downloadable package for residential or portable usage
. Actively help the development of Godot engine and other open-source tools that we depend on
. Facilitate 3rd party content via mods
. Provide optional online accounts to securely store user data and protect their in-game identity
'''
Check out the https://www.youtube.com/channel/UC1Oi1eXwdr8RlqIslyht5AQ[YouTube channel^] for video updates and livestreamed playtesting sessions.
== Want to help?
.Please see:
. https://codeberg.org/Liblast/Liblast/wiki/Game-Design-Document[Game Design Document]
. https://codeberg.org/Liblast/Liblast/wiki/Roadmap[Roadmap]
. https://codeberg.org/Liblast/Liblast/src/branch/main/CONTRIBUTING.adoc[Contributing Guide]
== How To Play
=== Download the game
Go to the https://codeberg.org/Liblast/liblast/releases[releases page] and download the latest release of the game.
NOTE: The game is in early, pre-alpha state! Do not expect a complete or seamless experience :)
=== Controls
[cols="^1,<2", options="header"]
|===
|Key
|Action
|`W`, `A`, `S`, `D`
|Movement
|Mouse
|Camera
|Left Click
|Shoot
|`R`
|Reload
|`Space`
|Jump
|`Shift` (Hold)
|Jetpack
|`1`, `2`, `3`
|Select weapon
|`T`
|Chat with team
|`Y`
|Chat with all
|`Z`
|Zoom
|`M`
|Mute audio
|`ESC`
|Main menu
|`~` a.k.a `Tilda`
|Console
|`F3`
|Record inputs
|`F4`
|Play recorded inputs
|`F2`
|Clear recorded inputs
|===
== Contributing and Getting in touch
Check the {url-main}/CONTRIBUTING.adoc[Contribution Guide]!
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
WARNING: Do not download the source code archive from the website - this will omit all assets that are stored using LFS. You need to clone the game repository with LFS. Please follow the guide below.
=== Liblast Godot 4 Downloads
Current engine version used is the official *Godot 4 Beta 4 release*. Download the editor for your platform here:
https://downloads.tuxfamily.org/godotengine/4.0/beta4/
Rememebr that Godot 4 is not stable yet, so it's possible you'll encounter an engine bug.
In the beta stage it's also possible the GDScript syntax is being changed a bit requiring simple updates to the Liblast codebase.
IMPORTANT: It may be necessary to delete asset import cache after updating the engine version. If you are having issues, try to delete the `Liblast/Game/.godot/imported` directory before opening the project. Godot will re-import all assets. Deleting the Godot cache directory `~/.cache/godot` can be also helpful if you face problems.
=== GNU/Linux
. Make sure you have `git` and `git-lfs` installed. Additional tools to make using `git` in the commandline easier that we can recommend are https://github.com/jonas/tig[`tig`^], https://github.com/jesseduffield/lazygit[`lazygit`^] and https://github.com/Extrawurst/gitui[`gitui`^].
. Clone the Git repository:
+
[source,bash,subs="attributes+"]
----
git clone {url-git}
----
+
. Enter the cloned repository:
+
[source,bash]
----
cd Liblast
----
+
. Initialize Git-LFS:
+
[source,bash]
----
git lfs install
----
+
. Pull the Git-LFS stored files:
+
[source,bash]
----
git lfs pull
git fetch
----
+
. Run the Godot editor and import the project located in `liblast/Game/project.godot`.
=== macOS
. Install `git` and `git-lfs`:
+
[source,bash]
----
brew install git git-lfs
----
+
. Clone the Git repository:
+
[source,bash,subs="attributes+"]
----
git clone {url-git}
----
+
. Enter the cloned repository:
+
[source,bash]
----
cd Liblast
----
+
. Initialize Git-LFS:
+
[source,bash]
----
git lfs install
----
+
. Pull the Git-LFS stored files:
+
[source,bash]
----
git lfs pull
git fetch
----
+
. Run the Godot editor and import the project located in `liblast/Game/project.godot`.
=== Windows
. https://gitforwindows.org[Install Git for Windows^].
. Open Git Bash.
+
TIP: You can open Git Bash in a directory in Windows Explorer using the option `Git Bash Here` in the context menu.
+
. Clone the Git repository:
+
[source,bash,subs="attributes+"]
----
git clone {url-git}
----
+
. Enter the cloned repository:
+
[source,bash]
----
cd Liblast
----
+
. Initialize Git-LFS:
+
[source,bash]
----
git lfs install
----
+
. Pull the Git-LFS stored files:
+
[source,bash]
----
git lfs pull
git fetch
----
+
. Run the Godot editor and import the project located in `liblast/Game/project.godot`.
== What does Liblast mean?
`Libre` + `Blast` = `Liblast` (pronounced _ˈlɪblɑːst_)
No, it's not a library ;)