Merge branch 'main' of ssh://git.gieszer.link:2222/unfa/liblast
commit
7e18855420
|
|
@ -0,0 +1,44 @@
|
|||
# Contribution Guide
|
||||
# Introduction
|
||||
|
||||
Looks like you want to lend a helping hand? Great, feel welcomed to read the following sections in order to know how to ask questions and see what you can work on!
|
||||
|
||||
By following the guidelines detailed below, you are respecting the time of the developers working on this project and in turn the developers will show that respect again in addressing your issue, assessing changes, and helping you finalize your pull requests.
|
||||
|
||||
|
||||
# What we're looking for!
|
||||
|
||||
Due to the early state of the game, we're looking for bug reports and any game breaking exploit you might find by tinkering around the game.
|
||||
|
||||
Make sure that you're running the latest version of the game and editor before reporting a bug!
|
||||
|
||||
Any suggestions to improve documentation are also welcomed.
|
||||
|
||||
|
||||
## Bug Report Template
|
||||
|
||||
Short and descriptive example bug report title
|
||||
|
||||
A summary of the issue and the OS environment in which it occurs. If suitable,
|
||||
include the steps required to reproduce the bug.
|
||||
|
||||
1. This is the first step
|
||||
2. This is the second step
|
||||
3. Further steps, etc.
|
||||
|
||||
Any other information you want to share that is relevant to the issue being
|
||||
reported. This might include the lines of code that you have identified as
|
||||
causing the bug, and potential solutions (and your opinions on their merits).
|
||||
|
||||
# What if I want to add to the game?
|
||||
|
||||
Before making an awesome suggestion check the project's roadmap before making the request because it might already be planned!
|
||||
|
||||
Keep in mind the vision of the project and its lore when writing the feature
|
||||
request, other than that, be extensive in detailing the feature and why it fits
|
||||
the game!
|
||||
|
||||
|
||||
# Not sure on how to contribute?
|
||||
|
||||
Check these tutorials [How to Make a Pull Request](https://makeapullrequest.com/) and [First Timers Only](https://www.firsttimersonly.com/).
|
||||
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!](./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
|
||||
## 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`
|
||||
|
||||
|
|
|
|||
Reference in New Issue