weyne/MOOSE
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE.git synced 2025-08-15 10:47:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated Home (markdown)

Applevangelist
2021-10-02 10:10:58 +02:00
parent 118199df8e
commit 67aa94fbfa
1 changed files with 8 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
Home.md

@@ -2,13 +2,11 @@
MOOSE is a **M**ission **O**bject **O**riented **S**cripting **E**nvironment, and is meant for mission designers and mission hosters.
It allows to quickly setup complex missions using pre-scripted scenarios using the available classes within the MOOSE Framework.
MOOSE is currently still in alpha version, but will evolve over time. Right now, it has been updated to work with DCS world 1.5. and 2.0.
MOOSE is currently still in alpha version, but will evolve over time. It has been updated to work with each version of DCS world.
You can find the source of MOOSE here on GITHUB. It is free for download:
https://github.com/FlightControl-Master/MOOSE/
Note: MOOSE is complementary to [MIST](https://github.com/mrSkortch/MissionScriptingTools/releases), so if you use MIST in parallel with MOOSE objects, this should work.
# Goals
The goal of MOOSE is to allow mission designers to enhance their scripting with mission orchestration objects, which can be instantiated from defined classes within the framework. This will allow to write mission scripts with minimal code embedded. Of course, the richness of the framework will determine the richness of the misson scenarios. We can expect that MOOSE will evolve over time, as more missions will be designed within the framework.
@@ -18,24 +16,24 @@ The goal of MOOSE is to allow mission designers to enhance their scripting with
* Moose Development: Contains the collection of lua files that define the MOOSE classes. You can use this directory to build the dynamic luadoc documentation intellisense in your eclipse development environment.
* Moose Mission Setup: Contains the Moose.lua file to be included in your scripts when using MOOSE classes (see below the point Mission Design with Moose).
* Moose Test Missions: Contains a directory structure with Moose Test Missions and examples. In each directory, you will find a miz file and a lua file containing the main mission script.
* Moose Training: Contains the documentation of Moose generated with luadoc from the Moose source code. The presentations used during the videos in my [youtube channel](https://www.youtube.com/channel/UCjrA9j5LQoWsG4SpS8i79Qg), are also to be found here.
* Moose Training: Contains the documentation of Moose generated with luadoc from the Moose source code. The presentations used during the videos in my [youtube channel](https://www.youtube.com/channel/UCjrA9j5LQoWsG4SpS8i79Qg), are also to be found here. [NOTE: Videos not updated since several years, take with a pinch of salt].
# Mission Design with Moose
In order to create a mission using MOOSE, you'll have to include a file named **Moose.lua**:
1. Create a new mission in the DCS World Mission Editor.
2. In the mission editor, create a new trigger.
3. Name the trigger Moose Load and let it execute only at MISSION START.
4. Add an action DO SCRIPT FILE (without a condition, so the middle column must be empty).
5. In the action, browse to the **[Moose.lua](https://github.com/FlightControl-Master/MOOSE/tree/master/Moose%20Mission%20Setup)** file in the **Moose Mission Setup** directory, and include this file within your mission.
6. Make sure that the "Moose Load" trigger is completely at the top of your mission.
2. In the mission editor, create a new ONCE trigger.
3. Name the trigger Moose Load and add an action DO SCRIPT FILE after (TIME MORE) 3-5 seconds.
4. In the action, browse to the **[Moose.lua](https://github.com/FlightControl-Master/MOOSE_INCLUDE/tree/master/Moose_Include_Static)** file in the **Moose Mission Setup** directory, and include this file within your mission.
5. Make sure that the "Moose Load" trigger is completely at the top of your mission.
6. Do do same for every LUA mission file you want to load, space out 1-2 seconds.
Voila, MOOSE is now included in your mission. During the execution of this mission, all MOOSE classes will be loaded, and all MOOSE initializations will be exectuted before any other mission action is executed.
IMPORTANT NOTE: When a new version of MOOSE is released, you'll have to UPDATE the Moose.lua file in EACH OF YOUR MISSION.
This can be a tedious task, and for this purpose, a tool has been developed that will update the Moose.lua files automatically within your missions.
Refer to the tool at [Moose Mission Setup\Moose Mission Update](https://github.com/FlightControl-Master/MOOSE/tree/master/Moose%20Mission%20Setup/Moose%20Mission%20Update) directory for further information included in the [READ.ME]() file.
Refer to the tool at [Moose Mission Setup\Moose Mission Update](https://flightcontrol-master.github.io/MOOSE_DOCS/) directory for further information included in the [READ.ME]() file.
# MOOSE LUA Classes