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

First step of cleanup. Replacement of the README.md

Browse Source
This commit is contained in:
Rolf Geuenich 2023-11-09 17:12:22 +01:00
parent ea32e2f861
commit 0f5b253aaa
1 changed files with 13 additions and 110 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

123
README.md
View File

@ -1,116 +1,19 @@
[![Moose-Includes](https://github.com/FlightControl-Master/MOOSE/actions/workflows/build-includes.yml/badge.svg?branch=master)](https://github.com/FlightControl-Master/MOOSE/actions/workflows/build-includes.yml)
# MOOSE Framework
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 works with the current version of DCS world and earlier versions.
![MOOSE Banner](Images\MOOSE.JPG)
You can find documentation for MOOSE in the following places:
## 1. **[MOOSE Starters Guide](Moose_Starters_Guide.html)**
You need to write lua code (scripts) to apply the MOOSE framework.
But it is not really that hard, if you understand a couple of principles.
## 2. **[MOOSE Mission Designers Guide](Moose_Designers_Guide.html)**
This section is meant for those who really want to start using MOOSE and write lua scripts for their missions.
The section provides a comprehensive overview of the different classes that form the complete MOOSE framework.
Here you find a high-level explanation and features, how to:
* Setup AI dispatchers to create complex and coordinated AI behaviour.
* Cargo handling
* Setup task dispatchers for Mission completion
* How to use MOOSE wrapper classes
* The different components of the core MOOSE engine
Each class will link you further down into the MOOSE Classes guide, for more detailed information on each MOOSE class.
## 3. **[MOOSE Classes Guide](Documentation/index.html)**
Here you can find detailed documentation for each MOOSE class.
Click on the hamburger menu on the left upper corner of each page to navigate to other MOOSE classes.
## 4. MOOSE Setup
The delivery of MOOSE follows a structured release process. Over time, new features are added that can be used in your mission.
### The latest release of MOOSE can be downloaded **[here](https://github.com/FlightControl-Master/MOOSE/releases)**.
There are 3 different ways how you can use MOOSE, each with a different engagement and complexity level:
### 4.1. Setup for **[Mission Designers](Moose_Setup_Guide.html)**
This section shows how to setup a development environment for Mission Designers using the MOOSE framework.
- Download and install Java.
- Setup Lua Development Tools IDE (from the Eclipse suite).
- Setup a logging tool.
- Tweak your DCS environment.
### 4.2. Setup for **[Alpha or Beta Testing Guide](Beta_Test_Guide.html)**.
Beta testers of MOOSE are requested to install additional software.
As a return or as a reward, testers get:
* Newly developed features planned for the next MOOSE release can be tested and incorporated in your missions early.
* You can evaluate and contribute to the stability of the next release.
* Your mission creation workflow becomes very flexible. New features are dynamically added to you missions.
Please read the detailed **[Beta Test Guide](Beta_Test_Guide.html)** for more information.
### 4.3. Contribute on the MOOSE development
Those people who have experience in lua development or are excited to contribute to the MOOSE project are welcome.
Please consult the **[Contribution Guide](Contribution_Guide.html)** for more information.
### 4.4. Debug your code interactively using LDT
Have a look at the **[Interactive Debug Guide](Interactive_Debug_Guide.html)** to setup your system so you can debug your mission code.
## 5. MOOSE Support Channels
MOOSE is broadcasted, documented and supported through various social media channels.
Click here for the **[communities guide](Communities.html)** of the MOOSE framework.
## 6. MOOSE framework goal
The goal of MOOSE is to allow mission designers to **enhance the mission designs** by using **mission orchestration objects**,
which can be _instantiated_ from defined classes within the framework.
This will allow to write exciting missions and multi player cooperative operation scenarios.
Of course, the richness of the framework will determine the richness of the misson scenarios.
The MOOSE is a service that is produced while being consumed ... ,
it will evolve further as more classes are developed for the framework, and as more users are using it.
MOOSE is NOT meant to be a one-man show, it is meant to evolve within a growing community around the framework.
Within the community, key users will support, document, explain and even create new classes for the framework.
It is the ambition to grow this framework as a de-facto standard for mission designers to use within the DCS World community.
## 7. [MOOSE community on Discord](https://discord.gg/Tf3hYy3ZYb)
Join our MOOSE community on Discord.
A place where mission designers and developers come together to discuss the latest features.
There are a lot of people supporting Mission Designers on Discord.
Thank you!
The Moose Team
- Generated documentation of all MOOSE classes:
- For the `master` branch: [MOOSE_DOCS]
- For the `develop` branch: [MOOSE_DOCS_DEVELOP]
- Documentation:
- The old Guides can be found in our [archive].
- Visit our new documentation at the [MOOSE GitHub page].
- Overview of all [MOOSE repositories] on GitHub.
[MOOSE_DOCS]: https://flightcontrol-master.github.io/MOOSE_DOCS/Documentation/index.html
[MOOSE_DOCS_DEVELOP]: https://flightcontrol-master.github.io/MOOSE_DOCS_DEVELOP/Documentation/index.html
[archive]: https://flightcontrol-master.github.io/MOOSE/archive/
[MOOSE GitHub page]: https://flightcontrol-master.github.io/MOOSE/
[MOOSE repositories]: https://flightcontrol-master.github.io/MOOSE/repositories.html