Skip to content

Latest commit

 

History

History
29 lines (20 loc) · 1.02 KB

README.md

File metadata and controls

29 lines (20 loc) · 1.02 KB
Raw

mc_rtc new plugin template

This project is a template for a new plugin wihtin mc_rtc

It comes with:

  • a CMake project that can build a plugin for mc_rtc, the project can be put within mc_rtc source-tree for easier updates
  • clang-format files
  • automated GitHub Actions builds on three major platforms

Quick start

  1. Renaming the controller from NewPlugin to MyPlugin. In a shell (Git Bash on Windows, replace sed with gsed on macOS):
sed -i -e's/NewPlugin/MyPlugin/g' `find . -type f`
git mv src/NewPlugin.cpp src/MyPlugin.cpp
git mv src/NewPlugin.h src/MyPlugin.h
git mv etc/NewPlugin.in.yaml etc/MyPlugin.in.yaml

  1. You can customize the project name in vcpkg.json as well, note that this must follow vcpkg manifest rules

  2. Build and install the project

  3. Run using your mc_rtc interface of choice, add MyPlugin to the Plugins configuration entry or enable the autoload option