Modernize the plugin template a bit

- Update GitHub Actions with latest best practices
- Update cmkr to the latest version
- Update x64dbg-sdk to the latest snapshot
- Simplify cmake.toml
- Add documentation
- Add some actual example code

Author: mrexodia

.gitattributes

@@ -0,0 +1,3 @@
+# cmkr
+/**/CMakeLists.txt linguist-generated
+/cmake/*.cmake linguist-vendored

.github/workflows/build.yml

@@ -1,19 +1,20 @@
-name: Visual Studio
-
+name: Build
 on: [push, pull_request]
 
 jobs:
   build:
     # Skip building pull requests from the same repository
     if: ${{ github.event_name == 'push' || (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name != github.repository) }}
-    runs-on: windows-2019
+    runs-on: windows-2022
+    permissions:
+      contents: write # Allow job to create a release
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
-    
+      uses: actions/checkout@v3
+
     - name: Add msbuild to PATH
-      uses: microsoft/setup-msbuild@v1.0.2
-    
+      uses: microsoft/setup-msbuild@1ff57057b5cfdc39105cd07a01d78e9b0ea0c14c # v1.3.1
+
     - name: Build (x64)
       run: |
         mkdir package\x64\plugins
@@ -27,24 +28,25 @@ jobs:
         cmake -B build32 -A Win32
         cmake --build build32 --config Release
         copy build32\Release\*.dp32 package\x32\plugins\
-    
-    - uses: actions/upload-artifact@v2
+
+    - uses: actions/upload-artifact@v3
       with:
         name: ${{ github.event.repository.name }}-${{ github.sha }}
         path: package/
-    
+
     - name: Compress artifacts
-      uses: papeloto/action-zip@v1
+      uses: vimtor/action-zip@26a249fb00d43ca98dad77a4b3838025fc226aa1 # v1.1
       if: ${{ startsWith(github.ref, 'refs/tags/') }}
       with:
         files: package/
         dest: ${{ github.event.repository.name }}-${{ github.ref_name }}.zip
 
     - name: Release
-      uses: softprops/action-gh-release@v1
+      uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844 # v0.1.15
       if: ${{ startsWith(github.ref, 'refs/tags/') }}
       with:
         prerelease: ${{ !startsWith(github.ref, 'refs/tags/v') || contains(github.ref, '-pre') }}
         files: ${{ github.event.repository.name }}-${{ github.ref_name }}.zip
+        generate_release_notes: true
       env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CMakeLists.txt

@@ -1,6 +1,6 @@
 # PluginTemplate
 
-Template CMake project for x64dbg plugins. This uses [cmkr](https://build-cpp.github.io/cmkr/), `cmake.toml` contains the project configuration.
+Template CMake project for x64dbg plugins. This uses [cmkr](https://cmkr.build), `cmake.toml` contains the project configuration.
 
 ## Using the template
 
@@ -9,6 +9,17 @@ You can click the green *Use this template* button. See the article [*Creating a
 
 Alternatively you can download a ZIP of this repository and set up the template locally.
 
+## Getting started
+
+- Pretty much all of the available functionality can be found in [`bridgemain.h`](https://github.com/x64dbg/x64dbg/blob/97ff1ec98a5bbf543e6d80ebbbd2401edf6c8cca/src/bridge/bridgemain.h).
+- You can find some (commented) example code in [`src/plugin.cpp`](./src/plugin.cpp).
+- Example plugins: https://plugins.x64dbg.com.
+- References:
+  - https://help.x64dbg.com/en/latest/developers/plugins/index.html
+  - https://x64dbg.com/blog/2016/10/04/architecture-of-x64dbg.html
+  - https://x64dbg.com/blog/2016/10/20/threading-model.html
+  - https://x64dbg.com/blog/2016/07/30/x64dbg-plugin-sdk.html
+
 ## Building
 
 From a Visual Studio command prompt:
@@ -31,3 +42,10 @@ Alternatively you can open this folder in Visual Studio/CLion/Qt Creator.
 
 ![building animation](https://github.com/x64dbg/PluginTemplate/blob/3951eb4b320b7a26164616ab5141414e8cd5b0a1/building.gif?raw=true)
 
+## Creating releases
+
+This template has GitHub Actions set up in [`.github/workflows/build.yml`](./.github/workflows/build.yml). If you push a tag prefixed with `v` (for instance `v1.0`) it will automatically publish a GitHub release with the plugin binaries compiled for both architectures.
+
+## Automatic reloading
+
+You can set up the [PluginDevHelper](https://github.com/x64dbg/PluginDevHelper) utility to automatically unload and reload the plugin from x64dbg when compiling. See the README there for more detailled instructions.

README.md

@@ -3,29 +3,24 @@ version = "3.15"
 cmkr-include = "cmake/cmkr.cmake"
 
 [project]
-cmake-before = """
-# Set up a more familiar Visual Studio configuration
-# Override these options with -DCMAKE_OPTION=Value
-#
-# See: https://cmake.org/cmake/help/latest/command/set.html#set-cache-entry
-set(CMAKE_CONFIGURATION_TYPES "Debug;Release" CACHE STRING "")
-set(CMAKE_EXE_LINKER_FLAGS_RELEASE "/DEBUG:FULL /INCREMENTAL:NO" CACHE STRING "")
-set(CMAKE_SHARED_LINKER_FLAGS_RELEASE "/DEBUG:FULL /INCREMENTAL:NO" CACHE STRING "")
-set(CMAKE_BUILD_TYPE "Release" CACHE STRING "")
-set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>" CACHE STRING "")
-"""
 name = "PluginTemplate"
-include-after = [
-    "cmake/CPM.cmake",
-    "cmake/x64dbg.cmake",
+include-before = [
+	"cmake/msvc-static-runtime.cmake",
+	"cmake/msvc-configurations.cmake",
 ]
 
-[target.PluginTemplate]
+[fetch-content.x64dbg]
+url = "https://sourceforge.net/projects/x64dbg/files/snapshots/snapshot_2023-06-10_18-05.zip"
+sha1 = "04468bd61fb36d6b10d17f342f03ef12f5b2ce62"
+include-after = ["cmake/x64dbg.cmake"]
+
+[template.plugin]
 type = "shared"
+add-function = "x64dbg_plugin"
+
+[target.PluginTemplate]
+type = "plugin"
 sources = [
     "src/*.cpp",
     "src/*.h",
-]
-cmake-after = """
-x64dbg_plugin(${CMKR_TARGET})
-"""
+]