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

Revised documentation for AI_BALANCER

Browse Source 
-- Added new SPAWN test missions.
-- Added new AI_BALANCER test missions.
-- Revised the MOOSE launch page.
This commit is contained in:
FlightControl
2017-01-10 12:56:03 +01:00
parent 899d076399
commit 9258beffc8
114 changed files with 331 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
docs/README.md
View File

@@ -5,22 +5,39 @@ MOOSE is a **M**ission **O**bject **O**riented **S**cripting **E**nvironment, an
It allows to quickly setup complex missions using pre-scripted scenarios using the available classes within the MOOSE Framework.
MOOSE is designed to work with DCS world 1.5. and 2.0.
You can find the source of MOOSE here on GITHUB. It is free for download:
https://github.com/FlightControl-Master/MOOSE/
MOOSE has a broadcast channel on youtube. Various videos explain how to use the MOOSE classes in your missions.
These videos are grouped into playlists, which explain specific MOOSE capabilities,
and gradually build up the "understanding" and "what is possible" to do with the MOOSE framework.
I really, really encourage all to watch the explanation videos.
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.
![Banner](Presentations\MOOSE\Dia1.JPG)
# 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.
## GitHub Repository
You can find the source of MOOSE here on GITHUB. It is free for download:
https://github.com/FlightControl-Master/MOOSE/
## YouTube Broadcast Channel
MOOSE has a broadcast channel on youtube. Various videos explain how to use the MOOSE classes in your missions.
These videos are grouped into playlists, which explain specific MOOSE capabilities,
and gradually build up the "understanding" and "what is possible" to do with the MOOSE framework.
I really, really encourage all to watch the explanation videos.
Find the YouTube broadcast channel here:
## Test Missions
The framework comes with a couple of test missions, that you can try out and copy/paste code
templates to build your own missions, while still learning the MOOSE framework.
These exact test missions are demonstrated at the demo videos in the YouTube channel.
Find these test missions here at GITHUB:
https://github.com/FlightControl-Master/MOOSE/tree/master/Moose%20Test%20Missions
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.
# MOOSE Directory Structure
As you can see at the GitHub site, the MOOSE framework is devided into a couple of directories:
* 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.
@@ -43,11 +60,12 @@ IMPORTANT NOTE: When a new version of MOOSE is released, you'll have to UPDATE t
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.
# MOOSE Classes
The following classes are currently embedded within MOOSE and can be included within your mission scripts:
![Classes](Presentations\MOOSE\Dia2.JPG)
## MOOSE Core Classes
These classes define the base building blocks of the MOOSE framework. These classes are heavily used within the MOOSE framework.