MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

move examples to the examples folder

develop
myk002 2022-08-02 12:56:44 -07:00 committed by Myk
parent 7a903c8322
commit 2f9021a3a0
6 changed files with 2 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/Dev-intro.rst
Unescape Escape View File

@ -22,7 +22,7 @@ Plugins
DFHack plugins are written in C++ and located in the ``plugins`` folder. DFHack plugins are written in C++ and located in the ``plugins`` folder.
Currently, documentation on how to write plugins is somewhat sparse. There are Currently, documentation on how to write plugins is somewhat sparse. There are
templates that you can use to get started in the ``plugins/skeleton`` templates that you can use to get started in the ``plugins/examples``
folder, and the source code of existing plugins can also be helpful. folder, and the source code of existing plugins can also be helpful.
If you want to compile a plugin that you have just added, you will need to add a If you want to compile a plugin that you have just added, you will need to add a
@ -35,7 +35,7 @@ other commands).
Plugins can also register handlers to run on every tick, and can interface with Plugins can also register handlers to run on every tick, and can interface with
the built-in `enable` and `disable` commands. For the full plugin API, see the the built-in `enable` and `disable` commands. For the full plugin API, see the
skeleton plugins or ``PluginManager.cpp``. example plugins or ``PluginManager.cpp``.
Installed plugins live in the ``hack/plugins`` folder of a DFHack installation, Installed plugins live in the ``hack/plugins`` folder of a DFHack installation,
and the `load` family of commands can be used to load a recompiled plugin and the `load` family of commands can be used to load a recompiled plugin

6
plugins/CMakeLists.txt
Unescape Escape View File

@ -185,12 +185,6 @@ if(BUILD_SUPPORTED)
# see instructions for adding "external" plugins at the end of this file. # see instructions for adding "external" plugins at the end of this file.
endif() endif()
# this is the skeleton plugin. If you want to make your own, make a copy and then change it
option(BUILD_SKELETON "Build the skeleton plugin." OFF)
if(BUILD_SKELETON)
add_subdirectory(skeleton)
endif()
macro(subdirlist result subdir) macro(subdirlist result subdir)
file(GLOB children ABSOLUTE ${subdir}/ ${subdir}/*/) file(GLOB children ABSOLUTE ${subdir}/ ${subdir}/*/)
set(dirlist "") set(dirlist "")

0
plugins/skeleton/skeleton.cpp → plugins/examples/skeleton.cpp
Unescape Escape View File

0
plugins/skeleton/skeletonShort.cpp → plugins/examples/skeletonShort.cpp
Unescape Escape View File

36
plugins/skeleton/CMakeLists.txt
Unescape Escape View File

@ -1,36 +0,0 @@
project(skeleton)
# A list of source files
set(PROJECT_SRCS
skeleton.cpp
)
# A list of headers
set(PROJECT_HDRS
skeleton.h
)
set_source_files_properties(${PROJECT_HDRS} PROPERTIES HEADER_FILE_ONLY TRUE)
# mash them together (headers are marked as headers and nothing will try to compile them)
list(APPEND PROJECT_SRCS ${PROJECT_HDRS})
# option to use a thread for no particular reason
option(SKELETON_THREAD "Use threads in the skeleton plugin." ON)
if(UNIX)
if(APPLE)
set(PROJECT_LIBS
# add any extra mac libraries here
${PROJECT_LIBS}
)
else()
set(PROJECT_LIBS
# add any extra linux libraries here
${PROJECT_LIBS}
)
endif()
else()
set(PROJECT_LIBS
# add any extra windows libraries here
${PROJECT_LIBS}
)
endif()
# this makes sure all the stuff is put in proper places and linked to dfhack
dfhack_plugin(skeleton ${PROJECT_SRCS} LINK_LIBRARIES ${PROJECT_LIBS})

1
plugins/skeleton/skeleton.h
Unescape Escape View File

@ -1 +0,0 @@
#pragma once