op2_sdk:programming_scenario_dlls [Outpost Universe Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Programming a Scenario ======

A complete Outpost 2 scenario (or mission) requires 3 files to work: a DLL, a MAP file, and a tech tree file. This page focuses on programming the DLL file. Outpost 2 scenarios are coded in C++ and require using legacy features of the language. See the [[op2_sdk:Software_Development_Kit_SDK|Software Development Kit Page]] for an overview of the MAP file and Tech tree file.

===== Scenario Programming Index =====

**Develop Environment Setup**
  * [[op2_sdk:ProjectCreation|Visual Studio Project Creation]]
  * [[op2_sdk:ProjectSettings|Advanced Visual Studio Project Settings]]
  * [[op2_sdk:Scenario Naming Conventions|Scenario Naming Conventions]]
  * [[op2_sdk:Debugging Scenarios]]
  * [[opu:repository|Outpost Universe Repository]]
  * [[outpost_2:technical_review:operating_system_compatibility|Operating System Compatibility]]

**Scenario Setup**
  * [[op2_SDK:PlayerColor|Player Color]]
  * [[op2_SDK:Setting Alliances|Setting Alliances]]
  * [[op2_sdk:Setting Resources|Setting Resources]]
  * [[op2_sdk:TubesAndWalls|Placing Tubes and Walls]]
  * [[op2_sdk:Placing Units|Placing Units]]

**Environmentals**
  * [[op2_sdk:Morale]]
  * [[op2_sdk:DayAndNight|Day & Night Cycles]]
  * [[op2_sdk:Disasters]]
  * [[op2_sdk:Volcanoes]]
  * [[op2_sdk:Blight|The Blight]]

**Game Mechanics**
  * [[op2_sdk:Victory And Defeat Conditions|Victory & Defeat Conditions]]
  * [[op2_sdk:Music|Music]]
  * [[op2_sdk:Difficulty Level|Difficulty level]]
  * Multiplayer

**AI Programming**
  * Vehicle Groups
  * Setting Patrol Routes

**In Game Dialog Boxes**
  * [[op2_sdk:TextDialogBox|Text Dialog Box]]
  * Yes/No Dialog Box

----

===== Scenario DLL overview =====

The required code for a scenario is stored in its own DLL (Dynamic Link Library) file. A DLL file contains code that can be linked into from other applications, like Outpost2.exe. DLLs are created by compilers that take code files and compiles them into and intermediate language or directly into assembly language. While many different programming languages can be compiled into DLLs, Outpost 2 scenarios are coded in C++. 

Code is usually written in special text editors that have knowledge of the programming language. Notepad++ is a good example. After writing the code, you have to find a compiler to compile the code into a DLL (or other file type). 

Text editors designed for coding are also included in an Integrated Development Environment (IDE). IDEs are software packages that usually contain both a special text editor and a compiler. This allows you to write the code and compile the program in the same application. A good example of an IDE is Microsoft Visual Studio. 

The Outpost 2 SDK comes packaged in a Microsoft Visual Studio 2015 C++ solution. Unless you are already knowledgeable enough to transfer the SDK to another IDE, it is recommended that you use Visual Studio since it will be easier to start coding without worrying about compiler setup requirements. Microsoft Visual Studio is free to use.

The filename of a scenario DLL must follow strict naming conventions to be recognized by Outpost 2. See the [[op2_sdk:Scenario Naming Conventions|Scenario Naming Conventions Page]] for details.

===== Scenario Administration =====

Programming Outpost 2 scenarios requires detailed knowledge of Integrated Development Environment (IDE) setup. The best way to share your scenario source code and access other Outpost Universe source code is through the Outpost Universe Repository.

==== Development Environment Settings ====

Typically, Outpost 2 scenarios are created using an Integrated Development Environment (IDE). Since new scenarios must be compatible with the Outpost 2 executable, which was compiled in 1997, several unusual IDE Project and compiler settings must be selected. See the [[op2_sdk:ProjectCreation|Project Creation Page]] for detailed instructions.

Once you have an Integrated Development Environment (IDE) installed and editing scenario DLLs, review [[op2_sdk:ProjectSettings|Advanced Project Settings Page]] for additional recommended settings that streamline the build process and debugging process.

==== Outpost Universe Repository ====

Source code meant for public access should be stored on the Outpost Universe Repository under the Outpost2 folder. For more information on how to use the repository, go to the [[opu:repository|Outpost Universe Repository Wiki Page]].
==== Project Management ====

The Outpost 2 SDK project management is handled on the Outpost Universe Redmine site. Reporting bugs or requesting new features can be made here. Read more at the [[opu:project_management|Outpost Universe Redmine Wiki Page]].

----
 - //Go Back to [[op2_sdk:Software_Development_Kit_SDK|Software Development Kit]]//\\
 - //Go Back to [[outpost_2:outpost_2|Outpost 2 Main page]]//\\
 - //Go Back to [[http://wiki.outpost2.net/doku.php?id=start|Wiki Home Page]]//