odk-ts Monorepo

This repository is the monorepo for the odk-ts TypeScript library and its sample application.

Structure

• repos/odk-ts/: The main odk-ts TypeScript library.
• repos/sample-app/: A sample Overwolf app demonstrating usage of odk-ts.

Installing & Building

Run these commands in the root folder of the monorepo:

Clone

The Overwolf API type declarations come from the overwolf/types repository, wired in as a git submodule. Clone with submodules:

git clone --recurse-submodules https://github.com/overwolf/odk-ts-monorepo.git

If you already cloned without them, npm install below will fetch them for you.

Install dependencies

npm install

This installs dependencies for all packages, and initializes the submodules if they are missing—without them TypeScript cannot resolve the overwolf namespace and the build fails.

Build odk-ts

npm run build:odk

Build the Sample App

npm run build:sample:dev   # For development build
# or
npm run build:sample        # For production build

Loading the Sample App in Overwolf

After building, you can load the sample app as a package using the Overwolf Packages page.

---

Documentation

• Your first window in 5 minutes—start here.
• odk-ts README—guide to windows, options, positioning and events.
• API reference—generated from the source: every class, method, event, option and enum.
• sample-app README—architecture of the working sample app.