DCS World Typescript

Overview

This repository contains a collection of TypeScript first libraries for DCS World.

This collection of packages uses Typescript to author the code and TypeScriptToLua to transpile TypeScript code into Lua.

The shared code libraries are published to NPM where they can be installed separately for authoring further projects using the same technique.

Some useful Docs include:

• Getting started with TypescriptToLua: https://typescripttolua.github.io/docs/publishing-modules
• Sharing code and re-using modules with TypescriptToLua: https://typescripttolua.github.io/docs/getting-started
• Caveats to account for: https://typescripttolua.github.io/docs/caveats

Usage

Detailed usage instructions will be added soon.

Lua runtime

Every Lua script in this repo (the test:lua suites, the tslua-http-api dev server) runs on a repo-managed Lua 5.1.5 interpreter rather than whatever Lua the host has installed. It lives in packages/tslua-lua51: a small Rust CLI on mlua with vendored PUC Lua 5.1.5 (the version DCS ships) and statically linked LuaSocket.

The only host prerequisites are Node.js and rustup; the Rust toolchain version is pinned by packages/tslua-lua51/rust-toolchain.toml and installed automatically. Package scripts invoke it as lua51, which builds the interpreter on first use:

npx lua51 --setup                                   # build it now
npx lua51 script.lua                                # same arguments as stock `lua`
npx lua51 --preload dcs-doubles.lua tests.lua       # install DCS test doubles first
Copy

See the package README for details.

Updating

See the UPDATING.md file for instructions on updating the definitions.

Updating Dependencies

To check the dependencies across all monorepo packages, run the following command:

ncu
lerna exec -- ncu
Copy

To Update them all, run:

ncu -u
lerna exec -- ncu -u
Copy

Pros

• Type Safety: TypeScript provides static type-checking, which helps catch errors at compile time, leading to more robust and maintainable code.
• Familiar Syntax: TypeScript syntax is similar to JavaScript, making it easier for JavaScript developers to transition.
• Modern Features: TypeScript supports modern JavaScript features such as classes, modules, and async/await, which can be transpiled to Lua.
• Tooling and IDE Support: TypeScript has excellent tooling and IDE support, including autocompletion, refactoring, and debugging capabilities.

Cons

• Complexity: The transpilation process can add complexity to the build and deployment pipeline, requiring additional tools and configuration.
• Interoperability Issues: Some Lua features and idioms may not map directly to TypeScript, potentially causing interoperability issues.
• Learning Curve: Developers unfamiliar with TypeScript may face a learning curve, especially with its type system and advanced features.
• Debugging: Debugging transpiled Lua code can be challenging, as the source maps may not always accurately represent the original TypeScript code.

Take note of this list:

https://github.com/TypeScriptToLua/TypeScriptToLua/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A"missing+feature"

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.

There are various ways to datamine dcs and of course the docs are a great source of information.

Type exports are maintained through the repository's own DCS bridge (npm run dcs:start). See UPDATING.md for setup and troubleshooting.

Useful Resources

• https://www.digitalcombatsimulator.com/en/support/faq/1249/
• https://wiki.hoggitworld.com/view/Simulator_Scripting_Engine_Documentation

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.