Build Module
Detailed instructions on building and packaging C# language module.
The C# Language Module (plugify-module-dotnet
) is a core component of Plugify that enables the creation and management of C# plugins. This guide will walk you through the process of building the module from source.
Prerequisites
Before building the C# Language Module, ensure you have the following installed:
- CMake (version 3.14 or later)
- C++ Compiler (supporting C++20 or later, for native components)
- Clang 15+
- GCC 11+
- MSVC 2022+
- Plugify Core Library (built and available)
Steps to Build the C# Language Module
Clone the Repository
Clone the plugify-module-dotnet
repository to your local machine:
Generate Build Files
Create a build
directory and generate the build files using CMake:
Build the Module
Build the module using the following command. The target name is plugify-module-dotnet
.
Verify the Build
Once the build process is complete, the compiled module will be located in the build
directory. Verify the build by checking for the following files:
plugify-module-dotnet.dll
(Windows)libplugify-module-dotnet.so
(Linux)libplugify-module-dotnet.dylib
(macOS)
Integrating the C# Language Module
After building the module, you can integrate it into your Plugify setup:
- Copy the compiled module file to the
modules
directory of your Plugify installation. - Ensure the Plugify core library is properly configured to load the module.
- Start Plugify, and the C# Language Module will be automatically detected and loaded.
Troubleshooting
Common Issues
- Build Fails:
- Ensure that you have the correct version of CMake, .NET SDK, and a compatible C++ compiler installed.
- Verify that the Plugify core library is built and available.
- Module Not Loaded:
- Ensure the module file is placed in the correct directory (
modules
). - Check the Plugify logs for any errors related to module loading.
- Ensure the module file is placed in the correct directory (
- Missing Symbols:
- Ensure that the module is built with the same compiler and C++ version as the Plugify core library.
Advanced Configuration
For more detailed instructions on building Language Modules (e.g., configuring CMake options, enabling tests, or building documentation), refer to the Building Plugify guide. The process is similar but contains much more info.