Overwatch Script To Workshop

OSTW is a high-level programming language designed for the Overwatch workshop. It provides several programming constructs and developer experience improvements, including:

• Control Flow: if...else statements, switch cases, and loops (while, for, foreach).
• Data & Logic: Easy string creation and easy operation trees.
• Abstraction: Support for functions and classes.
• IDE Support: Syntax highlighting and autocompletion.

To install OSTW, download the latest release from the GitHub releases page. After downloading, you must configure your environment by setting the ostw.deltintegerPath setting to point to the location of your deltinteger.exe file.

Set ostw.deltintegerPath to <path_to_deltinteger.exe>

The tmlanguage-generator package provides a programmatic API to construct complex regular expression trees and convert them into TextMate language grammars. It uses a functional approach to compose RegexNode objects using logic, quantifiers, and symbols, which can then be used to generate TmLanguage structures via createTextmateGrammar.

import { createTextmateGrammar, Or, Digit, Whitespace, Match } from 'overwatch-script-to-workshop/tmlanguage-generator';

// Example of composing a regex pattern
const pattern = Or(Digit(), Whitespace());

// The actual grammar generation is handled by createTextmateGrammar (exported from TextmateGenerator)
// using the patterns defined via this API.

The OstwLangServer class is the main entrypoint for the Language Server Protocol (LSP) implementation. It manages protocol handlers for various IDE features like completion, definition, hover, and more.

To instantiate the server, you must provide a ITomlDiagnosticReporter, an IDocumentEvent handler, and optionally a logger and a file getter factory. The server uses a LanguageServerBuilder to coordinate the internal components.

// Example instantiation pattern
var server = new OstwLangServer(
    tomlDiagnosticsReporter,
    documentEventHandler,
    langLogger,
    createFileGetterFunc,
    settingsProvider
);

The ostw object is the primary entry point for interacting with the Overwatch Script To Workshop logic via the JavaScript bridge. It is exported from the main module and provides access to the underlying .NET assembly's functionality through a JavaScript interface. To use it, you must ensure the dotnet framework is initialized and the assembly exports are loaded.

Note: This module is designed to run in an environment where the dotnet framework (provided by ./_framework/dotnet.js) is available, typically a browser-based WebAssembly environment.

import { ostw } from './Deltinteger/Deltinteger/main.js';

// Use ostw to interact with the workshop logic
// ostw is an instance of OstwJavascript
await ostw.someMethod();

The GetRegexNode function is a utility that normalizes different input types into a single RegexNode. This allows you to pass a variety of types into the composition functions.

Supported Regexable types:

• string: Converted to a Literal node.
• RegExp: Converted to an ExpressionGroup node.
• RegexNode: Used directly.
• RegexNode[]: Flattened into a ChainNode.
• Regexable[]: Recursively processed and flattened.

import { GetRegexNode } from 'overwatch-script-to-workshop/tmlanguage-generator';

// These all result in valid RegexNodes
const node1 = GetRegexNode('abc');
const node2 = GetRegexNode(/abc/);
const node3 = GetRegexNode(['abc', /def/]);

The makeRepository function provides a structured way to collect and name multiple Pattern objects into a single lookup object. It accepts a callback function that provides an add method to register patterns.

Note: When registering a name, any # character is stripped from the resulting key in the repository object.

import { makeRepository, Digit, OneOrMore } from 'overwatch-script-to-workshop/tmlanguage-generator';

const myRepo = makeRepository((add) => {
    add('number#pattern', OneOrMore(Digit()));
    add('simple_text', Digit());
});

// myRepo will be: { 'numberpattern': Pattern, 'simple_text': Pattern }
console.log(myRepo['numberpattern']);