Skip to content

Latest commit

 

History

History
120 lines (76 loc) · 5.71 KB

index.md

File metadata and controls

120 lines (76 loc) · 5.71 KB
Raw
title description
VEAF tools and scripts documentation site
VEAF tools and scripts documentation for mission makers, users and programmers

Navigation: you're on the main page

🚧 WORK IN PROGRESS 🚧

The documentation is being reworked, piece by piece. In the meantime, you can browse the old documentation.

Table of Contents

  • set up and use the VEAF tools (for all) - here
  • setup a VEAF mission-maker environment (for mission makers) - here
  • discover the VEAF mission-maker features (for mission makers) - here
  • learn how to program the scripts in Lua (for programmers) - here

Introduction

The VEAF Mission Creation Tools provides tools and scripts designed to easily create, share and maintain dynamic missions.

They regroup

  • tools to manipulate DCS mission files and servers
  • the VEAF mission scripts (organized in modules)
  • the VEAF server hooks
  • some of the community scripts, sometimes edited by VEAF (e.g., CTLD, MiST)
  • an easy mission creation, edition and publication workflow
  • tools to support this workflow, including a converter that build a dynamic mission from an existing static one
  • this documentation

Our GitHub repositories:

  • the main repository contains all the sources and the documentation base
  • the mission converter can be forked or downloaded to inject the scripts and tools into an existing mission
  • the demo mission (again, fork or download) is a small, simple mission that uses some of the latest features of the tools
  • the VEAF Caucasus training mission (fork or download) is a good working example of the scripts in a complex mission
  • the VEAF multiplayer mission repository contains mission that we played with the VEAF (some may be old and deprecated!)

What do I need to start?

You'll need to set up an environment, on your PC, with specific (free) software.

Read this page for more information.

What tools are there and how do I use them?

The VEAF Mission Creation Tools provides a lot of tools and scripts.

Most of them are meant to be used in the mission build pipeline (i.e., by a mission maker working on a mission, read the mission maker documentation), but some can be used as standalone tools:

  • the LUA dictionary normalizer which makes comparing LUA files easier
  • the Weather Injector which can generate multiple mission files with different starting times and weather conditions from a template
  • the Mission Selector which selects a starting mission for your dedicated server from a list of missions and a schedule.

How do I use the VEAF scripts in a mission I want to design?

Please read the mission maker documentation.

For those looking for a quick start, fork or download the mission converter and follow the instructions of the readme.md file. You'll learn how to can use the VEAF Mission Creation Tools in your own existing mission.

You can also fork or download the demo mission to see what can be done (usually only the latest features are demonstrated here), and the VEAF Caucasus training mission which is a very complex, open and dynamic training mission that uses a lot of the features.

How do I contribute to this wonderful repository?

First, thank you!

We always welcome help and new ideas.

Please always use branches and pull requests! Start with forking the VEAF-Mission-Creation-Tools repository, create a branch, hack away and publish your work.

I want to help maintain the documentation!

The easiest way of doing this is by editing the files directly on the Github website.

But you can also fork the main repository.

I need to add new features or correct bugs in the scripts!

Please read the programmer documentation.

Contacts

Made and maintained by the Virtual European Air Force, a French DCS pilot community.

VEAF-logo Badge-Discord

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