CONTRIBUTE.md

How to Contribute

Implementing cpp-sdk Changes

To implement a new cpp-sdk change or add a missing implementation, follow these steps:

1. Create a New Branch

   • Start by creating a new branch based on the dev branch.
   • In the submodule runtime, create another branch also based on the dev branch.

2. Update the cpp-sdk Version

   • If required, update the cpp-sdk version in the runtime branch.

3. Add the cpp-sdk Method

   • Add the new cpp-sdk method to the appropriate classes.
     For example, to implement IPlayer.GetSocialClubId(), update the following runtime classes:
     • player.h
     • player.cpp

4. Run the CApi Generator

   • Run the CApi Generator with the runtime/c-api folder as the working directory.

5. Push Changes

   • Push all changes to the runtime branch.

6. Implement the Method in the C# Module

   • Use the runtime branch to implement the method within the C# module.
     For the example above, add the SocialClubId as a getter to the IPlayer interface.

7. Add the Getter Implementation

   • Implement the getter in the Player class to invoke the unsafe runtime call Core.Library.*.

8. Extend the AsyncPlayer Class

   • Add the method to the AsyncPlayer class, ensuring it calls the parent method from the Player class.

9. Push Changes

   • Push all changes to the module branch.

10. Testing

    • Open powershell window, change directory to root module folder. Run gen_local_win_env.ps1 and wait everything downloaded.
    • To test the changes, use the windows-build.bat file in the runtime/server folder to generate a coreclr-module.dll.
    • Place the generated DLL in the server's modules folder.
    • Build the module project and copy the new module DLLs to the C# resource folder and the project directory of the resource.

      <ItemGroup>
    <Reference Include="AltV.Net">
      <HintPath>lib\AltV.Net.dll</HintPath>
    </Reference>
    <Reference Include="AltV.Net.Async">
      <HintPath>lib\AltV.Net.Async.dll</HintPath>
    </Reference>
    <Reference Include="AltV.Net.Interactions">
      <HintPath>lib\AltV.Net.Interactions.dll</HintPath>
    </Reference>
    <None Update="lib\*.dll">
      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
    </None>
    

``` - Test your changes thoroughly. - **Clientside cannot be tested yet**

11. Submit Pull Requests

• Create separate pull requests for both the module branch and the runtime branch.