Prerequisites

  • AngelScript 2.37.0 or newer.

  • Any C++ compiler that supports C++20 features required by this library. This library mainly depends on requires and <concepts> from C++20.

If the compiler and standard library support newer features like C++23, asbind20 will enable support for them.

There is a nightly build script in CI of asbind20, testing its compatibility with the latest WIP version of AngelScript. If you are using a WIP version of AS for newest features or fixes, you need to consider using the latest release of asbind20, or even the development branch.

Supported Platforms

Currently, the following platforms and compilers are officially supported and tested by CI. However, asbind20 on other platforms, architectures or compiler toolchains supported by AngelScript should work as expected too.

Platform

Compiler
Windows x64
Windows x86

MSVC latest

Windows x64

Clang-Cl latest

Linux x64
GCC 13, 14
Clang 15*, 18, 19
Clang 18 (ASan)

Linux arm64

Clang 18

Emscripten

emsdk latest

* The Clang 15 toolchain only supports features available under C++20.

Note

  • This library on older compiler toolchains, like GCC 12, still works as expected under most situations, but it might need some workarounds to deal with defects of the compiler, e.g., additional typename in template-related code. Please use newer compiler toolchains if possible.

  • The “latest” in the above table means the latest version of compiler toolchain available in CI when asbind20 releases a new stable version.

Integrate into Your Project

Please follow the tutorial of AngelScript to build and install it at first, or use a package manager like vcpkg.

You can also find example script for installing AngelScript in the GitHub Actions script of asbind20.

Besides, if your project has a custom location of <angelscript.h>, you can include it before any asbind20 headers. This library will not include the AngelScript library for the second time by detecting the macro ANGELSCRIPT_H.

1. Copy into Your Project

The core library of asbind20 is a header-only library. You can directly copy all the files under include/ into your project.

Additionally, files under io/, container/, and concurrent/ are optional components. You can omit those files if they are unnecessary for your project.

Note

About The Extension Library (asbind20::ext)

The extension part of library (under ext/) is not header-only. If you wish to use this part of library without building asbind20 separately, you need to copy necessary source files as well.

2. Integration Using CMake

CMake 3.20 or newer is required.

If you don’t want to build the extension library, you can set the CMake option asbind_build_ext to OFF.

cmake -Dasbind_build_ext=OFF # ...

A. Submodule

You can add asbind20 through git submodule and then use add_subdirectory.

add_subdirectory("directory/of/asbind20")

target_link_libraries(main PRIVATE asbind20::asbind20)

B. Build and Install

Additionally, you can build and install asbind20 using CMake.

cmake -GNinja -DCMAKE_BUILD_TYPE=Release -S . -B build
cmake --build build
cmake --install build

Then, link the library in a CMakeLists.txt.

find_package(asbind20 REQUIRED)

target_link_libraries(main PRIVATE asbind20::asbind20)

3. Integration with XMake Projects

Since the version 1.6.0, asbind20 has been accepted into the official package registry (xmake-repo). You can easily add asbind20 as a dependency of your project.

add_requires("asbind20")

target("main")
    -- ... --
    add_packages("asbind20")

The package includes the extension library by default. You can set the ext flag to false to disable it.

Please check the official documentation of XMake about adding packages for more details.