full-template

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 9 Open GitHub ↗

A more complete example component with scripting, events, SDK calls, and multiple files.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

open.mp Full Component Template
=================================

This is a more in complete component start point template.  It demonstrates how to declare a component that other components can call, has events they can subscribe to, and a pawn scripting API.

## UID

Since this is a template, i.e. a start point for new components, it needs a Unique ID adding.  Don't forget to get a new one from here:

https://open.mp/uid

## Required Tools

* [CMake 3.19+](https://cmake.org/)
* [Conan 1.53+](https://conan.io/)
* [Visual Studio 2019+](https://www.visualstudio.com/) (on Windows)
* Clang (on Linux)

Visual Studio needs the `Desktop development with C++` workload with the `MSVC v142`, `Windows 10 SDK`, and `C++ Clang tools for Windows` components.

## Sources

```bash
# With HTTPS:
git clone --recursive https://github.com/openmultiplayer/full-template
# With SSH:
git clone --recursive git@github.com:openmultiplayer/full-template
```

Note the use of the `--recursive` argument, because this repository contains submodules.  A useful setting when cloning recursive repos is:

```bash
git config --global url."git@github.com:".insteadOf "https://github.com/"
```

Which allows you to push `https://` repos you have permissions on.

## Building on Windows

```bash
mkdir build
cd build
cmake .. -A Win32 -T ClangCL
```

Open Visual Studio and build the solution.

## Building on Linux

```bash
mkdir build
cd build
# May need to configure this line.
export CC=/usr/lib/llvm/13/bin/clang CXX=/usr/lib/llvm/13/bin/clang++
cmake .. -G Ninja -DCMAKE_C_FLAGS=-m32 -DCMAKE_CXX_FLAGS=-m32 -DCMAKE_BUILD_TYPE=Debug \
cmake --build . --config Debug
```

Change `Debug` to `Release` for final versions.

## Building with Docker

```bash
cd docker
.\build.sh
```

You may need to set up some directories first:

```bash
mkdir build
mkdir conan
sudo chown 1000 build
sudo chown 1000 conan
```

Instead you run the script as root, and target a specific distro:

```bash
UBUNTU_VERSION=18.04 sudo .\build.sh
```

The output is in `docker/build/`

full-template

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README