Installation

Get the Plugify core and run the plug test application to try plugins and language modules without a game.

This page is for integrators: people who embed Plugify into their own application or work on the core. It shows how to get the core and run plug, the small test application that comes with it.

Setting up a game server? You do not need this page. Install a ready-made build instead.

What you get

The plugify repository contains:

the core library that your application links to;
plug, a console application that hosts the core. It loads modules and plugins from a folder and accepts the same management commands as the plg command of the game hosts.

plug is the quickest way to check a plugin or a language module outside a game.

Running the test application

Clone the repository

git clone https://github.com/untrustedmodders/plugify.git
cd plugify

Build

mkdir build && cd build
cmake ..
cmake --build . --target plug

The compiler and tools you need are listed in Build Instructions.

Add modules and plugins

Create an extensions folder in the folder you start plug from and put language modules and plugins into it, each in a folder of its own:

mkdir extensions

build/
- plug
- extensions/
  plugify-module-cpp/
  bin/
  cpp_module.pmodule
  my_plugin/
  bin/
  my_plugin.pplugin

Run

Run one command and exit:

./plug plugins

Or start the interactive console with -i. Type init first: it starts the core and loads the extensions. Then type commands such as plugins, modules and plugin <name>, and exit to quit:

./plug -i

plug uses the folder it is started from as its base folder. It finds every manifest in extensions, loads the modules and then the plugins. ./plug --help lists the commands.