thelink2012 / gta3sc

GTA3script compiler
MIT License
71 stars 13 forks source link
compiler gta gta3script toolchain

gta3sc

Build Status

This is a native script compiler/decompiler for the so called GTA3script language, used to design the mission scripts of the 3D Universe of the series.

Due to its design, it can also be used as a framework for working with SCM data. See the README.md in the src directory for a technical overview. There's also a experimental Dynamic Recompiler in the dynarec-x86 branch.

Building

Windows (MSVC) and Linux (GCC/Clang) are currently supported, but you need the latest compiler toolchain of your platform due to the use of C++17.

Just follow the standard CMake procedure for generating projects or makefiles.

mkdir build
cd build
cmake ..

Then make or use the generated project files.

Using

The compiler/decompiler is invoked by the file extension of the input file, or from the action compile or decompile.

Compilation example:

gta3sc main.sc --config=gta3
gta3sc compile main.sc --config=gta3  # does the same thing as above

Decompilation example:

gta3sc main.scm --config=gta3
gta3sc decompile main.scm --config=gta3  # does the same thing as above

The decompiler is still very early and produces very low-levelish code, so low that it cannot be recompiled back. High-level decompilation is supposed to be implemented later.

Help:

To get further instructions, try getting help from the utility.

gta3sc --help

Testing

Ensuring a compiler is working correctly is a must. To help us on this task we use llvm-lit. While on the root of this tree, use the following command to run all the tests.

lit test --verbose

For further details, please refer to the README.md on the test directory.