Initial commit

README.md

@@ -0,0 +1,54 @@
+# Installation Instructions
+
+Once your mission has been created and saved in the Arma 3 Eden Editor, download the latest mission template zip and copy its contents to the folder where your mission file lives.
+
+The only file which should be pre-existing in your mission folder is `mission.sqm`
+
+Once copied, the final structure should appear similar to the following:
+```markdown
+├── functions/
+├── images/
+├── scripts/
+├── sounds/
+├── description.ext
+├── mission.jpg
+├── mission.sqm
+├── mission_settings.hpp
+```
+
+After the requisite configuration file edits have been made, your mission is ready to be packed into a pbo for deployment.
+
+# Files
+
+Almost none of the template files should be edited in anyway as they have been formatted specially and specifically for their purpose. 
+
+*The following files however **must** be edited:*
+`mission_settings.hpp`
+
+*The following files however **should** be edited:*
+`mission.jpg`
+
+## mission_settings.hpp
+
+The contents of this file must be edited to reflect the naming of your mission for display purposes. All variables are self-documented inside the file to clearly identify the purpose of each piece of required text
+
+The contents of the lower half of the file are where the mission maker is able to add/replace/modify the built in `#ace-fortify` preset
+
+## mission.jpg
+
+This file will be displayed the client mission loading screen.
+File should remain small *(under 300KiB)* and should optimally be `1024px by 512px` in resolution
+
+## images/
+
+This directory is for organizational purposes for any images you wish to use in your mission
+
+## scripts/
+
+This directory is for organizational purposes for any custom scripts you wish to use in your mission. 
+> **Note**: Scripts may need to be edited to account for their new location
+
+## sounds/
+
+This directory is for organizational purposes for any custom scripts you wish to use in your mission.
+> **Note:** Using custom sounds require adding the proper CfgSounds codeblock into mission_settings.hpp