Setup (Local)

Local development setup

Everything you need to know to have CoopR Mod locally running and ready for development. The first thing you need is to setup a mandatory directory structure and download all addons CoopR is depending on. All you need to know is written down in the following steps. If you need help or having questions just hit our #mod-development discord channel: https://discord.gg/jyGYZU

1.1 Mod Source

First of all you need to checkout the mods source files in order to do changes on it at all. Important to note is that the official repository is locked and therefore you only can contribute through your forked version. So please first fork CoopR-Mod and then continue. Now you should clone your forked version of CoopR-Mod. Here is an example for the command line way: git clone [email protected]:<your_username>/CoopR-Mod.git 'C:\Program Files (x86)\Steam\steamapps\common\Arma 3\x\coopr'. Please be aware that your path to ArmA 3 might differ. Change it accordingly.

1.2 Local Database (extDB3)

As for the current state it is needed to have a running MySQL server and extDB3 mod active. This isn't very complicated to get done. First you can just download extDB3 via Steam Workshop. To run a MySQL server locally you can just use XAMPP which gives you a running MySQL server in a few clicks. Simply follow these steps:

1. Install XAMPP
2. Start XAMPP and run a MySQL server with the User Interface (Guide to use XAMPP and MySQL)
3. Create a database called coopr_local and a user with login coopr and password coopr that has access to the DB.
4. Download extDB3
5. Open the mod folder of extDB3 and open the extdb3_conf.ini and add the following:

[Database] // << important it is called "Database" and not a custom name
IP = 127.0.0.1
Port = 3306
Username = coopr
Password = coopr
Database = coopr_local

6. That's it. Starting CoopR Mod later on should not through an error and creating a character should work.

Alternatively you can watch the video guide for this step

1.3 Prerequisite Setup (Unpacked)

To develop with the unpacked mod sources you have to do several steps. For this mod these steps are the following:

1. Create a folder path matching the path structure defined in $PBOPREFIX$ in your Arma3 root directory. This might look like this in the end: C:\Program Files (x86)\Steam\steamapps\common\Arma 3\x\coopr. If you executed the git command mentioned in 1.1 Get Mod Source then this already happened. However rechecking the whole is never a bad idea.
2. Please also download @CBA_A3 because CoopR-Mod does depend on this addon. Get it here: Steam Workshop

1.4 Validate Setup

1. Now visit the mods source location C:\Program Files (x86)\Steam\steamapps\common\Arma 3\x\coopr. This should not be empty.

2. Check the deploy_local.cmd script (Windows) if the modpath variable in the script is matching the path you have defined for your Arma 3 installation. Please do not commit these changes ;)

3. Start using build_deploy_local.cmd (Windows) to build the mod and deploy it directly to your mod folder. Just run it from your CMD while within the root of the mod folder. The output of the build and deploy script should look like this: build_deploy_local.cmd output

4. Now let's see if ArmA 3 is starting with CoopR-Mod enabled. Use the your favorite launcher and load @CoopR as Mod and @CBA_A3 as well. Start ArmA 3 and check if the mod loaded successfully by looking at the bottom of the main menu screen. There should be an icon that shows "CoopR Mod" when hovering over it.

5. You should the be ready to use CoopR-Mod. Check the repository for the demo_missions folder. There are two missions. One with the future Altis server mission and one for development purposes. Use the DEV mission to implement new features. It needs the least amount of mods to run. So now copy this mission to your mpmissions so you can select it.

6. Before running this mission you need some additional addons. Here is a screenshot of the actual mod list you need to run the CoopR_dev.VR mission.

Red: Mandatory

Blue: Recommended