veaf-mission-creation-tools/README.md

A set of tools that help set up a and run dynamic missions

# [![VEAF-logo]][VEAF website] Mission Creation Tools

[![Badge-Discord]][VEAF Discord]
![Badge-Wakatime]

All scripts, libraries and documentation needed to build a dynamic mission in DCS using the VEAF scripts

# /!\ Warning ! Version 5.0.0 has been released, please read the [migration guide](README-5.0.0.md) /!\
## How to work on this package ?

Read the [documentation][documentation-site]! It's a work in progress, but it's a good start.

In the meantime, the legacy documentation (unmaintained, uncomplete) is still available [here][documentation-old].

Speaking of work in progress, the [documentation repository][documentation-repo] is the place to go to contribute to the documentation, if you wish to help.

If you want to program with us, you can start by looking at the code, specially the `exampleObjectOrientedProgramming.lua` example

And if you like these tools, you can [buy me a coffee][Zip on coff.ee]!

## What is this ? Is it like Moose ?

A bit like that, and not.

It uses MiST (and a tiny teeny part of Moose, for air spawns) to handle lots of runtime functionality:
- spawning of units and groups (and portable TACANs)
- air-to-ground missions 
- air-to-air missions
- transport missions
- carrier operations (not Moose)
- tanker move
- weather and ATC
- shelling a zone, lighting it up
- managing assets (tankers, awacs, aircraft carriers) : getting info, state, respawning them if needed
- managing named points (position, info, ATC)
- managing a dynamic radio menu
- managing remote calls to the mission through NIOD (RPC) and SLMOD (LUA sockets)
- managing security (not allowing everyone to do every action)
- define groups templates

And also lots of design-time functionality:
- automatically populating FARPs and grass runways with all that is neeed
- spawning things at the start of a mission (interpreter of data stored in a fake unit on the mission)
- normalizing a mission file (removing useless key in the dictionary, sorting everything) so it's easy to compare versions
- injecting radio presets globally (e.g. all blue F18 get a standard freq plan)
- injecting real weather in a mission

And probably other things I forget ;)

Enjoy!

[Zip][Zip on Github].

## Contacts

If you need help or you want to suggest something, you can:

* contact [Zip on Github]
* go to the [VEAF website]
* post on the [VEAF forum]
* join the [VEAF Discord]


[Badge-Discord]: https://img.shields.io/discord/471061487662792715?label=VEAF%20Discord&style=for-the-badge
[Badge-Wakatime]: https://wakatime.com/badge/github/VEAF/VEAF-Mission-Creation-Tools.svg
[VEAF-logo]: https://veaf.github.io/documentation/images/logo.png
[VEAF Discord]: https://www.veaf.org/discord
[Zip on Github]: https://github.com/davidp57
[Zip on coff.ee]: https://coff.ee/veaf_zip
[VEAF website]: https://www.veaf.org
[VEAF forum]: https://www.veaf.org/forum

[documentation-old]: ./old_documentation/_index.md
[documentation-site]: https://veaf.github.io/documentation/
[documentation-repo]: https://github.com/VEAF/documentation