forked from unfa/liblast
General updates to the README
- Changed the contribution section. - Changed the controls section. - Changed the image links to be relative. - Updated the Godot 4 Editor link; from 4.0-dev.20211004 to 4.0-dev.20211015. - Added spaces between screenshots.main
parent
1d2010debe
commit
08c6d46965
63
README.md
63
README.md
|
|
@ -8,21 +8,26 @@ A Libre Multiplayer FPS Game built with Godot game engine and a fully FOSS toolc
|
|||
|
||||
Subscribe to the [YouTube channel](https://www.youtube.com/channel/UC1Oi1eXwdr8RlqIslyht5AQ) for upcoming video updates!
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
|
||||
**DISCLAIMER: THE GAME IS IN EARLY STAGES OF DEVELOPMENT.
|
||||
DO NOT EXPECT MUCH**
|
||||
|
||||
## How to play
|
||||
## How To Play
|
||||
|
||||
### Download the game
|
||||
|
||||
Go to the releases page and download the latest release of the game. You'll find some instructions and notes there as well:
|
||||
https://git.gieszer.link/unfa/liblast/releases
|
||||
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`.
|
||||
|
||||
|
|
@ -30,42 +35,41 @@ To start playing Liblast it's recommended to first host a local game and adjust
|
|||
|
||||
### Controls
|
||||
|
||||
- WASD to walk around
|
||||
- mouse to 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
|
||||
| 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.
|
||||
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
|
||||
## Contributing and Getting in touch
|
||||
|
||||
If you'd like to contribute to the project, please get in touch first, as we've got some designs in mind, and we'd hate to have any effort wasted!
|
||||
|
||||
## Get in touch
|
||||
Check the [Contribution Guide!](./CONTRIBUTION.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
|
||||
## How to Edit the Game
|
||||
|
||||
Get the Godot 4 editor for the OS of your choosing from here:
|
||||
https://downloads.tuxfamily.org/godotengine/testing/4.0/4.0-dev.20211004/
|
||||
[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 (yes, it's a single file).
|
||||
For example for Linux you need `Godot_[version]_linux.64.zip`. Extract the archive to obtain the Godot editor binary.
|
||||
|
||||
If you'll 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`).
|
||||
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:
|
||||
|
||||
|
|
@ -107,6 +111,7 @@ 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
|
||||
|
|
@ -118,9 +123,9 @@ 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?
|
||||
|
||||
## What does the name of this project mean?
|
||||
|
||||
`Libre` + `Blast` = `Liblast`
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue