{DESCRIPTION ABOUT MODULE HERE}

The only supported compilation platform for this project on Windows is Visual Studio 2017 on release mode {TODO: REMOVE THIS PART IF NOT APPLICABLE}. However, it's possible it'll work with Visual Studio 2015, Visual Studio 2019 and Visual Studio 2022 because of the unified runtime.

On Linux, everything should work fine as is, on release mode {TODO: REMOVE THIS PART IF NOT APPLICABLE}.

For macOS, any Xcode (using the GCC compiler) version MIGHT work as long as the Mac OSX 10.7 SDK is used, on release mode {TODO: REMOVE THIS PART IF NOT APPLICABLE}.

These restrictions are not random; they exist because of ABI compatibility reasons.

If stuff starts erroring or fails to work, be sure to check the correct line endings (\n and such) are present in the files for each OS.

This project requires garrysmod_common, a framework to facilitate the creation of compilations files (Visual Studio, make, XCode, etc). Simply set the environment variable GARRYSMOD_COMMON or the premake option --gmcommon=path to the path of your local copy of garrysmod_common.

We also use SourceSDK2013. The links to SourceSDK2013 point to my own fork of VALVe's repo and for good reason: Garry's Mod has lots of backwards incompatible changes to interfaces and it's much smaller, being perfect for automated build systems like Azure Pipelines (which is used for this project).

This is a template repository for Garry's Mod native modules.

Parts to be replaced:

• First heading ({MODULE NAME HERE}), content below it ({DESCRIPTION ABOUT MODULE HERE}) and remove release mode comments, if not applicable ({TODO: REMOVE THIS PART IF NOT APPLICABLE}) on this README

• Header of the license ({MODULE NAME HERE}) and description ({DESCRIPTION ABOUT MODULE HERE}) on the license

• Either remove or change .appveyor.yml, .travis.yml or azure-pipelines.yml ({MODULE NAME HERE}, {ENCRYPTED API KEY ...} and {NAME OF YOUR GITHUB SERVICE CONNECTION ...})

• Change premake5.lua ({MODULE NAME HERE} and what needs to be included)

• Change source/main.cpp ({MODULE NAME HERE})