Initial commit

.github/workflows/build.yml

@@ -0,0 +1,50 @@
+name: Visual Studio
+
+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
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Add msbuild to PATH
+      uses: microsoft/[email protected]
+
+    - name: Build (x64)
+      run: |
+        mkdir package\plugins\x64
+        cmake -B build64 -A x64
+        cmake --build build64 --config Release
+        copy build64\Release\*.dp64 package\plugins\x64\
+
+    - name: Build (x32)
+      run: |
+        mkdir package\plugins\x32
+        cmake -B build32 -A Win32
+        cmake --build build32 --config Release
+        copy build32\Release\*.dp32 package\plugins\x32\
+    
+    - uses: actions/upload-artifact@v2
+      with:
+        name: ${{ github.event.repository.name }}-${{ github.sha }}
+        path: package/
+
+    - name: Compress artifacts
+      uses: papeloto/action-zip@v1
+      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
+      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
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -0,0 +1,5 @@
+build*/
+.idea/
+.vs/
+cmake-build-*/
+/CMakeSettings.json

CMakeLists.txt

@@ -0,0 +1,73 @@
+# This file is automatically generated from cmake.toml - DO NOT EDIT
+# See https://github.com/build-cpp/cmkr for more information
+
+cmake_minimum_required(VERSION 3.15)
+
+if(CMAKE_SOURCE_DIR STREQUAL CMAKE_BINARY_DIR)
+	message(FATAL_ERROR "In-tree builds are not supported. Run CMake from a separate directory: cmake -B build")
+endif()
+
+# Regenerate CMakeLists.txt automatically in the root project
+set(CMKR_ROOT_PROJECT OFF)
+if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
+	set(CMKR_ROOT_PROJECT ON)
+
+	# Bootstrap cmkr
+	include("cmake/cmkr.cmake" OPTIONAL RESULT_VARIABLE CMKR_INCLUDE_RESULT)
+	if(CMKR_INCLUDE_RESULT)
+		cmkr()
+	endif()
+
+	# Enable folder support
+	set_property(GLOBAL PROPERTY USE_FOLDERS ON)
+endif()
+
+# Create a configure-time dependency on cmake.toml to improve IDE support
+if(CMKR_ROOT_PROJECT)
+	configure_file(cmake.toml cmake.toml COPYONLY)
+endif()
+
+# 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 "")
+
+project(PluginTemplate)
+
+include("cmake/CPM.cmake")
+include("cmake/x64dbg.cmake")
+
+# Target PluginTemplate
+set(CMKR_TARGET PluginTemplate)
+set(PluginTemplate_SOURCES "")
+
+list(APPEND PluginTemplate_SOURCES
+	"src/plugin.cpp"
+	"src/pluginmain.cpp"
+	"src/plugin.h"
+	"src/pluginmain.h"
+)
+
+list(APPEND PluginTemplate_SOURCES
+	cmake.toml
+)
+
+set(CMKR_SOURCES ${PluginTemplate_SOURCES})
+add_library(PluginTemplate SHARED)
+
+if(PluginTemplate_SOURCES)
+	target_sources(PluginTemplate PRIVATE ${PluginTemplate_SOURCES})
+endif()
+
+source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR} FILES ${PluginTemplate_SOURCES})
+
+x64dbg_plugin(${CMKR_TARGET})
+
+unset(CMKR_TARGET)
+unset(CMKR_SOURCES)
+

LICENSE

@@ -0,0 +1,23 @@
+Boost Software License - Version 1.0 - August 17th, 2003
+
+Permission is hereby granted, free of charge, to any person or organization
+obtaining a copy of the software and accompanying documentation covered by
+this license (the "Software") to use, reproduce, display, distribute,
+execute, and transmit the Software, and to prepare derivative works of the
+Software, and to permit third-parties to whom the Software is furnished to
+do so, all subject to the following:
+
+The copyright notices in the Software and this entire statement, including
+the above license grant, this restriction and the following disclaimer,
+must be included in all copies of the Software, in whole or in part, and
+all derivative works of the Software, unless such copies or derivative
+works are solely in the form of machine-executable object code generated by
+a source language processor.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
+SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
+FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,33 @@
+# PluginTemplate
+
+Template CMake project for x64dbg plugins. This uses [cmkr](https://build-cpp.github.io/cmkr/), `cmake.toml` contains the project configuration.
+
+## Using the template
+
+You can click the green *Use this template* button. See the article [*Creating a repository from a template*
+](https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template) by GitHub for more details.
+
+Alternatively you can download a ZIP of this repository and set up the template locally.
+
+## Building
+
+From a Visual Studio command prompt:
+
+```
+cmake -B build64 -A x64
+cmake --build build64 --config Release
+```
+
+You will get `build64\PluginTemplate.sln` that you can open in Visual Studio.
+
+To build a 32-bit plugin:
+
+```
+cmake -B build32 -A Win32
+cmake --build build32 --config Release
+```
+
+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)
+

cmake.toml

@@ -0,0 +1,31 @@
+[cmake]
+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",
+]
+
+[target.PluginTemplate]
+type = "shared"
+sources = [
+    "src/*.cpp",
+    "src/*.h",
+]
+cmake-after = """
+x64dbg_plugin(${CMKR_TARGET})
+"""