- added Docs folder as a placeholder for future documentation

- README.md - created full readme
- TODO - todo list with features/bug still present
This commit is contained in:
Slawek Mikula 2017-10-21 00:26:14 +02:00
parent d60078f893
commit 2a51603965
4 changed files with 51 additions and 3 deletions

1
Docs/intro.md Normal file
View File

@ -0,0 +1 @@
# Introdution to Missions Addon

View File

@ -1,7 +1,6 @@
<?xml version="1.0"?>
<PropertyList>
<presets>
<airport-id>KLVK</airport-id>
<altitude>-9999</altitude>

View File

@ -1,2 +1,44 @@
# flightgear-addon-missions
Missions addon for FlightGear
# About
Flightgear missions addon. Written in NASAL. Adds ability to perform mutliple missions/tasks.
# Running
- extract zip (if downloaded as a zip) to a given location. For example let's
say we have /myfolder/addons/mission with contents of the mission addon.
- run flightgear with --addon directive. WARNING this is not "additional settings"
window in the launcher ! you have to modify windows shortcut or linux startup
script for example to looks like this (in linux):
Code:
```
./fgbin/bin/fgfs --fg-root=./fgdata --launcher \
--prop:/sim/fg-home=/myfolder/flightgear/fghome \
--addon="/myfolder/addons/mission"
```
# Running
- after FG startup there is new main menu available "Missions"
- there is mission browser, which provides GUI selector for various missions
- read carefully mission description, because it sometimes have information about
startup airport
- you can start the mission from the mission selector's GUI
- when running mission, you can stop it by selecting Missions->Stop mission menu
entry
# History
- 0.1 - initial release as an FG addon
# Authors
- Marius_A - concept, coding
# Links
- FlightGear wiki: [Wiki](http://wiki.flightgear.org/Missions)
- FlightGear forum: [Forum](https://forum.flightgear.org/viewtopic.php?f=79&t=31057)
# License
GNU General public license version 3

6
TODO Normal file
View File

@ -0,0 +1,6 @@
- bug - presets does not work - reloading FG causes whole addon reload and lost of mission state
- actions documentation
- fully working all example missions
- hoops - dynamic mission generator
- tours - dynamic mission generator
- skills - dynamic mission generator