@flying-dice/tslua-dcs-gui-types
v0.33.0
Published
Typescript type definitions for DCS GUI environment
Readme
DCS World TypeScript Type Definitions
This repository contains TypeScript type definitions for DCS Worlds GUI Environment, enabling developers to use TypeScript’s powerful type system when scripting for DCS World. These type definitions are designed to be used with TypeScriptToLua to transpile TypeScript code into Lua, which is the scripting language used by DCS World.
Installation
To use these type definitions in your project, you need to have Node.js and npm installed. You can then install the type definitions via npm with the command
npm install @flying-dice/tslua-dcs-gui-typesUsage
TBC
Contribution
Contributions to this project are welcome. If you find an issue or have suggestions for improvements, please open an issue or submit a pull request.
Exports use DCS Studio's GUI bridge. Follow the canonical update guide, start DCS at the main menu, and run npm run export.
Exports
To refresh generated interface data, run
npm run exportThis will
- Read
scripts/export.bridge.lua - Connect to the installed DCS Studio GUI bridge and traverse configured namespaces
- Assemble a foundation typescript interface
From here you can extend the underlying interface and replace the typing information.
Updating the packages/tslua-dcs-gui-types/src/index.d.ts with a variable where the type is of your extending interface will allow it to be used.
To add namespaces, update scripts/config.ts and run npm run export again.
Useful Resources
- https://wiki.hoggitworld.com/view/DCS_server_gameGUI
- C:\Program Files\Eagle Dynamics\DCS World OpenBeta\API\DCS_ControlAPI.html
License
This project is licensed under the MIT License.
Acknowledgments
- Thanks to the TypeScriptToLua team for their incredible tool.
- Special thanks to the DCS World community for their continuous support and contributions.
Contact
For any inquiries or contributions, please open an issue on this repository.
