OpenLiberty/README.md

112 lines
3.5 KiB
Markdown
Raw Normal View History

2022-11-14 19:44:16 +07:00
# GTA 3 in Godot
2024-07-31 23:45:48 -03:00
2024-08-01 00:31:41 -03:00
![Full Map](screenshots/re3-gd1.png)
2024-07-31 23:45:48 -03:00
This project aims to reimplement the Grand Theft Auto 3 on the Godot Engine.
2022-11-20 10:53:41 +07:00
Currently, this project is able to load the game's map, collision data, etc. at
runtime and stream in models and textures as needed.
2024-07-31 23:45:48 -03:00
2024-08-01 00:31:41 -03:00
## How To Run
### Godot Editor
- Download this repository
- Paste the GTA3 files inside the `gta` folder of the repository
- Open the Godot Engine and run the default scene
### Exported Executable
- Download this repository
- Open the Godot Engine
- Export the executable
- Paste the GTA3 files on the same folder of the executable
2024-07-31 23:45:48 -03:00
## 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.
2024-08-01 02:23:03 -03:00
- [OpenRW](https://openrw.org/) - Incomplete and not active.
2024-07-31 23:45:48 -03:00
2024-07-31 23:54:05 -03:00
Both projects use the [RenderWare](https://en.wikipedia.org/wiki/RenderWare) version of GTA3, which is old and limited for improvements.
2024-07-31 23:45:48 -03:00
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
2024-08-01 17:25:29 -03:00
If we successfully load the GTA San Andreas files, we could start a GTA San Andreas reimplementation on the Godot engine.
2024-07-31 23:45:48 -03:00
Similar to what the [San Andreas Unity](https://github.com/in0finite/SanAndreasUnity) project did, but the Unity engine is closed-source.
## Chat
2024-08-01 17:25:29 -03:00
- [Discord](https://discord.gg/d9ca4U64H4)
2024-08-01 17:46:46 -03:00
- [Matrix](https://matrix.to/#/#foss-supremacy:matrix.org)
2024-07-31 23:45:48 -03:00
## 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
2024-07-31 23:54:05 -03:00
git clone https://github.com/FOSS-Supremacy/re3-gd
2024-07-31 23:45:48 -03:00
```
- 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
```