Skip to content

Latest commit

 

History

History
39 lines (22 loc) · 2.06 KB

File metadata and controls

39 lines (22 loc) · 2.06 KB

README

IMPORTANT LICENSING INFORMATION

We're still finalising the license under which this code can be modified and redistributed. Until the new license is published, you can modify this work under the original license within this repository, further to the conditions stated here: https://community.sogpf.com/d/198-modifying-mike-force.

IMPORTANT BUILD INFORMATION

We're in the process of updating our build tools for Mike Force. They're in their final review phase, but we didn't want to prematurely push out buggy build tools. For now, the old tools should still work on Windows - see setup_dev_environment.py and build.py.

Issue Reporting

Report issues using the "Issues" section above. Please be sure to follow the template, and include as much detail as possible to help us figure out the best solution!

Downloading

Mike Force is hosted on the Steam Workshop. It's strongly advised to use Steam Workshop to manage the gamemode, and regularly check for updates, in case you're missing out on fixes or features!

Running

The gamemode is a self-contained mission file. Simply download the mission from Steam Workshop into your server's mpmissions folder, and select it from the in-game mission list.

Creating Custom Mike Force Missions

Follow one of the 'Setup' instruction sets in the GitHub Wiki.

Development

Follow the GitHub Desktop setup instructions in the GitHub Wiki

If you prefer to use git on the command line you'll likely be able to work it out from the wiki above, just replace the GitHub Desktop steps with the relevant git commands.

generated doc file

A simple documentation generator : https://github.com/ryantownshend/sqf_tools

The file mikeforce_api.html is a super crude parse of the header comments from within the project.