Improve the README massively

This commit is contained in:
Ribbon 2024-07-31 23:45:48 -03:00 committed by GitHub
parent b2b728a785
commit 631c479d93
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,5 +1,97 @@
# GTA 3 in Godot
Aims to reimplement GTA 3 in Godot Engine. Very WIP.
This project aims to reimplement the Grand Theft Auto 3 on the Godot Engine.
Currently, this project is able to load the game's map, collision data, etc. at
runtime and stream in models and textures as needed.
## TODOs
- [ ] Properly verify if the GTA3 files are present before execution
- [ ] Configure the player model and texture on the map
- [ ] Load the vehicles
- [ ] Load the weapons
- [ ] Load the NPCs
- [ ] Load the animations
- [ ] Add controls on the player
- [ ] Add controls on vehicles
- [ ] Configure the weapons
- [ ] Add Day and Night cycle
- [ ] Add shadows
- [ ] Add rain
- [ ] Add the Sun on the sky
- [ ] Add the Moon on the sky
- [ ] Support modding
- [ ] Multiplayer
## Motivation
Currently there's two open-source reimplementations of GTA3:
- [re3](https://github.com/halpz/re3) - It had legal problems due to Rockstar Games code.
- [OpenRW](https://openrw.org/) - Incomplete and abandoned.
Both projects use the RenderWare version of GTA3, which is old and limited for improvements.
Our project is more safe to work because we don't use Rockstar Games code, just the GTA3 files that the user needs to add on the project folder.
Beyond legal safety, the RenderWare version used on the GTA3 is old and technically limited for improvements. While the Godot Engine is modern and much more advanced, also easier to make contributions.
## Probable Future
If we successfully import the GTA San Andreas files, we could start a GTA San Andreas reimplementation on the Godot engine.
Similar to what the [San Andreas Unity](https://github.com/in0finite/SanAndreasUnity) project did, but the Unity engine is closed-source.
## Chat
You can join in our Matrix [here](https://matrix.to/#/#foss-supremacy-join:matrix.org).
(Once you join, request for an invite to the Matrix space)
You can also join in our Discord server [here](https://discord.gg/d9ca4U64H4).
## Bugs
If you want to send a bug report, open an issue with "(Bug)" before the title.
## Requests and Suggestions
### Features
If you have a feature request, open an issue with "(Feature request)" before the title.
### Suggestion
If you have a suggestion, open an issue with "(Suggestion)" before the title.
## How to Clone and Build
- Download the repository and game assets
```sh
git clone https://github.com/FOSS-Supremacy/crawling-agony
```
- Download the [Godot Engine](https://godotengine.org/) 4.x version (normal variant, not C#)
- Export the executable to your operating system
## How To Contribute
- Give a start to this repository, it will increase our chances to receive contributions.
- Download the [Godot Engine](https://godotengine.org/) 4.x version (normal variant, not C#)
- Verify the open issues and select some item to work on
- Once ready, send a pull request (if you are adding commits on the PR branch, mark it as draft status)
- Send the link of your pull requests on the "Pull Requests" channel/room on [Discord](https://discord.gg/tk6Vnxv9Qt) or [Matrix](https://matrix.to/#/!vIwqjDewTZpciZqhEp:matrix.org?via=matrix.org).
- We don't accept C# code
## Donate
If you want to support our work, consider a donation, every amount is important.
- [Patreon](https://www.patreon.com/foss_supremacy)
- [Bitcoin](https://bitcoin.org)
```
bc1qg9x5vzr4ppkm2ssw5k7ete4lu49wg7t02azkce
```