ModAPI SDK v2.3.1

This GitHub page hosts the develpment kit, used to create mods with the ModAPI. To use those mods, you need the ModAPI Launcher and Installers.

Pre-requisites

To use the ModAPI, you need to have installed:

• The Windows 10 SDK (you might need to use different versions if you don’t have Windows 10): https://developer.microsoft.com/en-US/windows/downloads/windows-10-sdk
• Visual Studio 2017. You can download the free version here: https://visualstudio.microsoft.com/vs/community/

Setting up the SDK

Download the Spore.ModAPI.Development.Kit.2.3.1.zip file provided in this release. Unzip it to whatever directory you want (it will be your workspace).

Inside the folder you will find a file called Spore ModAPI Templates.vsix. If you have installed Visual Studio correctly, you will be able to execute the file. Once the installer is open, press Install.

Finally, open Visual Studio. Go to Tools -> Code Snippets Manager… . In the dialog that opens, ensure that the Language: field is set to Visual C++. Press the button Add… and find the folder called ModAPISnippets, which is inside the ModAPI tools folder we unzipped before.

If you had already installed previous versions

For those that installed older versions of the ModAPI Development Kit, we need to take an extra step to get this working. If this is the first time you install it, you can skip this step.

1. Open Visual Studio. Go to Tools -> Extensions and Updates… . There, find the item called Spore ModAPI Templates and uninstall it.
2. Go to the directory %APPDATA%\Microsoft\VisualStudio. There you will see multiple folders, it’s recommended that you do these steps for all of them. Inside each of these folders, you go to ProjectTemplatesCache\Visual C++ Project. If you see a folder called Spore ModAPI Template.zip, delete it.

Now you can install the tempates as explained before.

Creating a project

Go to File -> New -> Project… . A dialog will open; under the tab Visual C++, select the template called Spore ModAPI Template. Now in the bottom part of the dialog there are two fields you must modify:

• Name: Insert the name of your mod; do not to use whitespaces.
• Location: Where your mod files will be saved. Use the button Browse… to navigate to the Projects folder inside the ModAPI directory you unzipped before.

Now, there is one more thing you might need to do. Open the project configuration, ensure the Configuration box is set to All Configurations like shown in the picture below. Now, in the General categories, there are two settings you must pay attention to.

• Windows SDK Version: Ensure this setting is set to the latest SDK version.
• Platform Toolset: Ensure this setting is set to Visual Studio 2017 (not necessarily v141)