Native Wrapper Generator

This program generates wrapper methods for native function, to be used with .NET script hook (wrappers) that works with Grand Theft Auto V Legacy.

Currently, the following platforms are supported:

• Script Hook V .NET and compatibles
• RAGE Plugin Hook

Compared to the old generator that was made in 2022, this generator:

• runs faster (the actual generator cost less than 300ms in most runs, and the process only takes a few seconds)
• Generates C# 7.3 code (no need for <LangVersion>latest</LangVersion>)

Get

Installable archive for pre-built wrappers are available in the releases page. Corresponding developer packages are published on NuGet:

Platform	Link
SHVDN	WithLithum.NativeWrapper
RPH	WithLithum.NativeWrapper.RagePluginHook

Pre-built binaries for the native wrapper generator program are not provided. You need to build the project yourself, if you just want the generator.

Experimental builds

Important

Experimental builds are produced automatically for every commit (change) in the trunk branch.

There is absolutely no guarantee that these builds will work with existing scripts, or future experimental builds won't break those built with previous experimental builds.

To get installable archives for experimental builds, click here and select the most recent run. You need a GitHub account to download build artefacts.

Developer packages for experimental builds are published in GitHub Packages.

Usage

Synopsis

WithLithum.NativeWrapperGen
  [--natives-file <natives-json-file>]
  [--config-file <config-json-file>]
  [--generator <generator-name>]
  [--file-name-format <file-name-format>]
  [--namespace <namespace>]
  [--class-name <class-name>]
  [--count-time]

Options

• natives-file: --natives-file <natives-json-file>

  Specifies a natives.json file. The file must be conforming to the format as provided in the alloc8or nativedb-data.

  Defaults to the bundled data file.

• config-file: --config-file <config-file>

  Specifies the configuration file. For an example, see the default settings tailored for SHVDN.

  Defaults to read the included settings.

• generator: --generator <generator-name>

  Specifies the name of the generator to use. The following is available:

  • shvdn: for Script Hook V .NET
  • rph: for RAGE Plugin Hook

• file-name-format: --file-name-format <file-name-format>

  Specifies the file name format. {0} gets replaced with the native namespace name. For example, Natives.{0}.cs becomes Natives.Misc.cs, and so on.

  Path can be included as well. Defaults to Natives.{0}.cs.

• namespace: --namespace <namespace>

  The namespace for the generated file. Defaults to WithLithum.NativeWrapperGen.Artefact.

• class-name: --class-name <class-name>

  The class name for the generated file. Defaults to Natives.

• count-time: --count-time

  If specified, counts the time used to run the generator.

Building

You need a version of .NET SDK that can target .NET 10.0. Download .NET SDK 10.0 here.

Any OS can build and run the generator.

Wrappers

Note

.NET will take care of installing reference assemblies for you if you don't have the appropriate .NET Framework SDK installed, or is on a non-Windows system. Of course, this needs Internet access.

The wrappers are generated under wrappers directory and uses its own solution to avoid unnecessarily slowing down IDEs.

To create wrappers, use PowerShell 7 to run GenerateNativeWrapper.ps1. If you have ran this script at least once, you can specify -NoDownload to tell the script not to update native definition files.

Licence

Apache-2.0