diff --git a/README.md b/README.md index 207cc04e..e2528397 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,36 @@ # DCS Olympus -*A DCS RTS-Style real-time mission editor* -`Or a better punchline` +*A real-time web interface to spawn and control units in DCS World* ### What is this? -[[Insert short description here]] +DCS Olympus is a mod for DCS World. It allows users to spawn, control, task, group, and remove units from a DCS World server using a real-time map interface, similarly to Real Time Strategy games. The user interface also provides useful informations units, like loadouts, fuel, tasking, and so on. In the future, more features for DCS World GCI and JTAC will be available. -### Features -- Feature 1 - - Feature description -- Feature 2 -- Feature 3 -... +### Features and how to use it +- Spawn air and ground units, with preset loadouts + - Double click on the map to spawn a blue and red units, both in the air and in the ground, with preset loadouts for air-to-air or air-to-ground tasks; +- Control units + - Select one ore more units to move them around. Hold down ctrl and click to create a route for the unit to follow; +- Attack other units + - After selecting one ore more units, double click on another unit and select "Attack" to attack it, depending on the available weapons. -### How to use it -[[Insert description on how to download, set up and run it]] +### Installing DCS Olympus +A prebuilt installer will soon be released and available here -#### Extra stuff -[[Extra boring stuff nobody reads, come on is the end of the readme, you think anyone is wasting time on reading this??]] \ No newline at end of file +### Building DCS Olympus +DCS Olympus is comprised of two modules: + +A "core" c++ .dll module, which is run by DCS and exposes all the necessary data, and provides endpoints for commands from a REST server. A Visual Studio 2017/2019/2022 solution is provided, and requires no additional configuration. The core dll solution has two dependencies, both can be installed using vcpkg (https://vcpkg.io/en/getting-started.html): + - cpprestsdk: `vcpkg install cpprestsdk:x64-windows` + - geographiclib: `vcpkg install geographiclib:x64-windows` + + +A "client" node.js typescript web app, which can be hosted on the server using express.js. A Visual Studio Code configuration is provided for debugging. The client requires node.js to be installed for building (https://nodejs.org/en/). After installing node.js, move in the client folder and run the following commands: + - `npm install` + - `npm -g install` + + After installing all the necessary dependencies you can start a development server executing the *client/debug.bat* batch file, and visiting http:\\localhost:3000 with any modern browser (tested with updated Chrome, Firefox and Edge). However, it is highly suggested to simply run the `Launch Chrome against localhost` debug configuration in Visual Studio Code. + + + + + +