npm:ts2gamesparks

README

Installing

Install ts2gamesparks

$ npm install -g ts2gamesparks

Install GameSparks typings

$ npm install --save-dev gamesparks-typings

Add to tsconfig.json

// tsconfig.json
{
  "compilerOptions": {
    ...
    "types": [
      "gamesparks-typings"
    ],
  }
}

Init tsconfig files

$ mkdir src && cd src
$ ts2gs --init

These three files will be created:

src/tsconfig.json
src/rtScript/tsconfig.json
src/rtModules/tsconfig.json

If you are not sure, please do not modify these files.

Using

Prevent global namespace pollution

If the script does not import or export anything, the script will not be recognized as a module, and the variables in the script will exist in the global namespace. In order to solve it, just add export { } to the first line of the script.

Export something

:warning: Do not use export in directories other than modules/ and rtModules/

// src/modules/foo.ts

export function func() {
    /* ... */
}
export const bar = "bar"

Import something

:white_check_mark: Do it

import /* ... */ from "foo";

:x: Don't do it!

import /* ... */ from "./foo";
import /* ... */ from "../modules/foo";

Output javascript

When tsconfig.json under root directory

$ ts2gs

When tsconfig.json under ./src

$ cd src && ts2gs

Example

https://github.com/johnsoncodehk/gamesparks-cloud-code-typescript-example

Usage no npm install needed!