Skip to content

Commit

Permalink
Fix up the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Pirulax committed Jul 9, 2023
1 parent 2e2177a commit 961b419
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 14 deletions.
33 changes: 21 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,9 @@ Before you start writing code, please make sure to read the [coding guidelines](
* [Visual Studio 2022](https://visualstudio.microsoft.com/en/downloads/) (Community Edition is enough)
* [CMake](https://cmake.org) (for those who want to use CMake instead of premake5)

#### Game
* GTA SA **Compact** exe
* [ASI Loader](https://gtaforums.com/topic/523982-relopensrc-silents-asi-loader/)
* [III.VC.SA.WindowedMode.asi](https://github.com/ThirteenAG/III.VC.SA.WindowedMode)
* [Mouse Fix (**dinput8.dll**)]()

You can download them in a single [archive](https://github.com/codenulls/gta-reversed/files/6949371/gta_sa.zip).
Using other plugins is strongly discouraged and we provide __**no support**__.

### Build Instructions

You can either build with **Premake5** or **CMake**; that's up to you, but a C++20 capable compiler with <ranges> support is required.
You can either build with **Premake5** or **CMake**; that's up to you, but a C++20 capable compiler [with `<ranges>`, `<format>` support] is required.

First clone the project, including the submodules:
```shell
Expand All @@ -38,10 +29,11 @@ git clone --recurse-submodules https://github.com/gta-reversed/gta-reversed-mode
<details>
<summary>Premake5</summary>

1) Execute `premake5.bat` for 2022, or `premake5.bat vs20xx` for other VS versions. (Note: Premake works fine with vs2019, CMake requires vs2022) (e.g: `premake5.bat vs2019`)
1) Execute `premake5.bat`

2) You'll find gta_reversed.sln shortcut in the same folder as premake5.

3) Open it, and once the project has loaded, just hit `CTRL + SHIFT + B`
</details>

<details>
Expand Down Expand Up @@ -79,13 +71,30 @@ git clone --recurse-submodules https://github.com/gta-reversed/gta-reversed-mode

</details>

### Game
To install all the necessary files, run `install.py` with **__administrator privileges__** [Necessary to create symlinks on Windows] in the root directory.
Alternatively, you can install them by yourself:

* GTA SA **Compact** exe
* [ASI Loader](https://gtaforums.com/topic/523982-relopensrc-silents-asi-loader/)
* [III.VC.SA.WindowedMode.asi](https://github.com/ThirteenAG/III.VC.SA.WindowedMode)
* Mouse Fix (**dinput8.dll**) [Can be found in the zip in `./contrib`]

You can download them in a single [archive](https://github.com/gta-reversed/gta-reversed-modern/blob/master/contrib/plugins.zip).
Using other plugins is strongly discouraged and we provide __**no support**__.

### Preparing Environment (Optional)
[If you have ran `install.py` in the previous step then this step is already done]

<details>
<summary>Instructions</summary>

You can create symbolic links [symlinks] for artifacts [the `.asi`] to need not copy them every time you compile the project.

Open a console with administrator privileges in the git repo's directory and run `contrib\link_asi.bat` or right click `link_asi.bat` file and click `Run as administrator`, then
Open a console with **__administrator privileges__** in the git repo's directory and run `contrib\link_asi.bat` or right click `link_asi.bat` file and click `Run as administrator`, then
follow instructions at the command window.

</details>

### What to work on?
Check [this](https://github.com/gta-reversed/gta-reversed-modern/discussions/402) out for some inspiration ;)
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion source/game_sa/Entity/Vehicle/Automobile.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -5111,7 +5111,7 @@ CObject* CAutomobile::SpawnFlyingComponent(eCarNodes nodeIndex, uint32 collision
*RwFrameGetMatrix(flyingObjFrame) = *frameLTM; // Set this frame's matrix to be the same as the component's - TODO: This most likely isn't the correct way to do this..
CVisibilityPlugins::SetAtomicRenderCallback(clonedFlyingObjAtomic, nullptr);
obj->AttachToRwObject((RwObject*)clonedFlyingObjAtomic, true);

obj->m_bDontStream = true;
obj->m_fMass = 10.f;
obj->m_fTurnMass = 25.f;
Expand Down
2 changes: 1 addition & 1 deletion source/game_sa/Models/ClumpModelInfo.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,7 @@ RwFrame* CClumpModelInfo::FindFrameFromNameWithoutIdCB(RwFrame* frame, void* sea
searchInfo->m_pFrame = frame;
return nullptr;
}

RwFrameForAllChildren(frame, FindFrameFromNameWithoutIdCB, searchData);
if (searchInfo->m_pFrame)
return nullptr;
Expand Down

0 comments on commit 961b419

Please sign in to comment.