summaryrefslogtreecommitdiff
path: root/src/server/scripts/Custom/README.md
blob: 5eee67576bb979f8826f957dd95d61914a26e765 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# Custom folder

Here you can create a CMakeLists.txt file where to add your custom scripts.
They will be git-ignored.

Remember to use cmake macros inside your CMakeLists.txt to correctly add your scripts to the project solution.

**/!\ BTW, we strongly suggest you to use our module system to create your custom powerful module instead of simple scripts.**

---------------------------

## How to add your custom script:

**1 - Create a CMakeLists.txt in this directory**

Example (everything below is needed, just replace with your scripts' names):

```
set(scripts_STAT_SRCS
  ${scripts_STAT_SRCS}
  ${AC_SCRIPTS_DIR}/Custom/your_script.cpp
  ${AC_SCRIPTS_DIR}/Custom/your_script.h
)

AC_ADD_SCRIPT_LOADER("Custom" "ScriptLoader.h")

message("  -> Prepared: My custom scripts")
```

**2 - Add the script to ../ScriptLoader.cpp**

Open the file `ScriptLoader.cpp` and go at the end to know what to edit.