ACE3/documentation/development/extension-guidelines.md

61 lines
1.5 KiB
Markdown
Raw Normal View History

2015-04-09 19:09:49 +00:00
---
layout: wiki
title: Extension Guidelines
description:
2015-04-12 12:42:49 +00:00
group: development
2015-04-09 19:09:49 +00:00
parent: wiki
order: 9
---
2015-05-04 11:43:33 +00:00
## 1. Basics
2015-04-09 19:09:49 +00:00
2015-05-04 11:43:33 +00:00
### 1.1 Requirements
2015-04-09 19:09:49 +00:00
- A compiler (VS/GCC/Clang)
- If starting with Visual Studio, you need to make sure to use the Visual studio command prompt
2015-04-09 19:09:49 +00:00
- cmake 3.0 or later in your path
2015-05-04 11:43:33 +00:00
### 1.2 Cross-Platform Guidelines
2015-04-09 19:09:49 +00:00
2015-05-04 11:43:33 +00:00
### 1.3 C++ basic style and naming guide
2015-04-09 19:09:49 +00:00
2015-05-04 11:43:33 +00:00
### 1.4 ace_common cpp library
2015-04-09 19:09:49 +00:00
---
2015-05-04 11:43:33 +00:00
## 2 Building Extensions on Windows
2015-04-09 19:09:49 +00:00
2015-05-04 11:43:33 +00:00
### 2.1 Compiling
2015-04-09 19:09:49 +00:00
2015-05-04 11:43:33 +00:00
#### 2.1.1 Windows - Creating a Visual Studio Project
2015-04-09 19:09:49 +00:00
1. Open your compiling command prompt (which has cmake and your compiler)
2. From this directory, you need to use cmake to build the appropriate build files. Change the -G property appropriately. run cmake --help to get a list of the options.
```
cd extensions\build
2015-07-27 04:29:07 +00:00
cmake .. -G "Visual Studio 14 2015"
2015-04-09 19:09:49 +00:00
```
A Visual studio project file will now be generated in your build directory.
2015-05-04 11:43:33 +00:00
#### 2.1.2 Windows - Visual Studio - Compile only (nmake)
2015-04-09 19:09:49 +00:00
1. Open your compiling command prompt (which has cmake and your compiler)
2. From this directory, you need to use cmake to build the appropriate build files. Change the -G property appropriately. run cmake --help to get a list of the options.
```
cd extensions\build
cmake .. -G "NMake Makefiles"
nmake
```
The extensions will not be built in its appropriate project folder, for example:
```
extensions\
build\
fcs\ace_fcs.dll
somethingElse\ace_somethingElse.dll
```
2015-05-04 11:43:33 +00:00
### 2.2 Creating a New Extension