Skip to content

Commit

Permalink
modified the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
davidp57 committed Oct 18, 2020
1 parent 7ebd44e commit 42428c7
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 2 deletions.
32 changes: 31 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,36 @@

All scripts, libraries and documentation needed to build a mission containing the VEAF framework with [dcs-liberation](https://github.com/Khopa/dcs_liberation).

## Installing the plugin in dcs-liberation

Could not be simpler :
- create a new `veaf` directory in dcs-liberation's `resources\plugins`
- copy all the files in `dist` to this new folder
- edit dcs-liberation's `resources\plugins\plugins.json` file to add the veaf plugin to the top of the plugins list ; the result should look like :
```json
[
"veaf",
"jtacautolase",
"base"
]
```

## Using the VEAF plugin in dcs-liberation

In the *Settings* window, you'll see an option to select this new plugin in the *LUA Plugins* section :

![VEAF Plugin](doc\0.png "VEAF Plugin")

Also, you can change the default options in the *LUA Plugins Options* section :

![VEAF Plugin Options](doc\1.png "VEAF Plugin Options")

These options are :

- *Allow spawn commands* : if disabled, no command can spawn additional units (disables SPAWN, SHORTCUTS, CASMISSION and TRANSPORTMISSION)
- *Allow assets respawn* : if disabled, the ASSET menu will show the assets but it will not be possible to respawn or dispose them (not yet functional)
- *Allow CTLD transport missions* : if disabled, CTLD will be disabled altogether

## Playing in such a mission

*TODO*
Expand All @@ -15,5 +45,5 @@ Requirements:
* npm - you can install [node.js from here](https://nodejs.org/en/download/)

Edit the `package.json` file to change the version of the VEAF framework you want to fetch.
Run the `build.cmd` script and then check that the scripts in `src` have been updated.
Run the `build.cmd` script and then check that the scripts in `dist` have been updated.
Commit.
Binary file added doc/0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"license": "MIT",
"repository": {
"type": "git",
"url": "git+https://github.com/dcs-liberation-veaf-framework.git"
"url": "git+https://github.com/veaf/dcs-liberation-veaf-framework.git"
},
"dependencies": {
"veaf-mission-creation-tools": "2.22.1"
Expand Down

0 comments on commit 42428c7

Please sign in to comment.