Implement GameFi SDK for Cocos.

.github/workflows/deploy-docs.yml

@@ -2,10 +2,6 @@
 name: Deploy static content to Pages
 
 on:
-  # Runs on pushes targeting the default branch
-  push:
-    branches: ['main']
-
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 

.github/workflows/publish-npm.yml

@@ -15,7 +15,7 @@ jobs:
       - id: get-package
         run: |
           PACKAGE_NAME=$(echo ${GITHUB_REF#refs/tags/} | cut -d- -f1)
-          ALLOWED_PACKAGES=("phaser") # Add more package names if needed
+          ALLOWED_PACKAGES=("phaser" "cocos")
           if [[ " ${ALLOWED_PACKAGES[@]} " =~ " ${PACKAGE_NAME} " ]]; then
             echo "::set-output name=package::${PACKAGE_NAME}"
             echo "::set-output name=version::${GITHUB_REF#refs/tags/}"

README.md

@@ -1,13 +1,17 @@
 # game-engines-sdk
 
 TON blockchain bindings and utilities for game engines:
-* Phaser.io
-* Cocos2d (coming soon)
+* [Phaser](https://phaser.io)
+* [Cocos](https://www.cocos.com/en)
 
 # Getting started
 Installation:
 ```sh
-npm install --save @ton/phaser-sdk
+# for Phaser
+npm install --save @ton/phaser-sdk@beta
+
+# for Cocos
+npm install --save @ton/cocos-sdk@beta
 ```
 
 Creating GameFi instance:
@@ -79,7 +83,10 @@ This can be used for:
 | [merchantJettonAddress](https://ton-org.github.io/game-engines-sdk/classes/GameFi.html#merchantJettonAddress) | in-game shop's jetton used as in-game currency |
 
 # Use cases
-To learn complex use cases read [TON GameFi article](https://gist.github.com/barinbritva/b3db1605f2667b7562b53a23877c0e73) and check out the source code of demo [Flappy Bird game](https://github.com/ton-community/flappy-bird).
+To learn complex use cases:
+- read [TON GameFi article](https://gist.github.com/barinbritva/b3db1605f2667b7562b53a23877c0e73)
+- check out the source code of [Flappy Bird](https://github.com/ton-community/flappy-bird) demo for Phaser
+- check out the example of [Flappy Bird](https://github.com/CocosTechLabs/flappy-bird) for Cocos
 
 # References
 The full [typedoc references](https://ton-org.github.io/game-engines-sdk/index.html).

package.json

@@ -4,10 +4,10 @@
         "node": ">=18.0.0",
         "npm": ">=9.0.0"
     },
-    "workspaces": ["packages/phaser"],
+    "workspaces": ["packages/phaser", "packages/cocos"],
     "scripts": {
         "check-types": "tsc --noEmit",
-        "typedoc": "typedoc --out docs packages/phaser/src/index.ts",
+        "typedoc": "typedoc --out docs packages/phaser/src/index.ts packages/cocos/src/index.ts",
         "lint": "prettier --check \"./**/*.{js,jsx,ts,tsx,json,yml}\""
     },
     "devDependencies": {

packages/cocos/README.md

@@ -0,0 +1,7 @@
+# cocos-sdk
+
+TON blockchain bindings and utilities for [Cocos](https://www.cocos.com/en) game engine.
+
+# Documentation
+
+Please read the documentation in the official [repository](https://github.com/ton-org/game-engines-sdk).

packages/cocos/package.json

@@ -0,0 +1,23 @@
+{
+    "name": "@ton/cocos-sdk",
+    "version": "0.0.1-beta.1",
+    "files": ["./dist"],
+    "main": "dist/index.ts",
+    "types": "dist/cocos/src/index.d.ts",
+    "module": "dist/index.ts",
+    "scripts": {
+        "dev": "webpack --mode development --watch",
+        "build": "webpack --mode production"
+    },
+    "dependencies": {
+        "@tonconnect/ui": "^2.0.1-beta.0",
+        "@ton/ton": "^13.9.0",
+        "@orbs-network/ton-access": "^2.3.3",
+        "@ton-community/assets-sdk": "0.0.4-beta.1"
+    },
+    "devDependencies": {
+        "webpack": "^5.92.0",
+        "webpack-cli": "^5.1.4",
+        "ts-loader": "^9.5.1"
+    }
+}

packages/cocos/src/game-fi.ts

@@ -0,0 +1,11 @@
+import {GameFiBase, GameFiInitializationParams} from '../../common/game-fi';
+
+export class GameFi extends GameFiBase {
+  /**
+   * Setups and creates GameFi instance.
+   * The instance provides all the needed functionality via various methods.
+   */
+  public static async create(params: GameFiInitializationParams = {}): Promise<GameFi> {
+    return new GameFi(await GameFi.createDependencies(params));
+  }
+}

packages/cocos/src/index.ts

@@ -0,0 +1,5 @@
+export * from '../../common/content-resolver';
+export * from '../../common/external';
+export * from '../../common/game-fi';
+export * from '../../common/interfaces';
+export * from './game-fi';

packages/cocos/tsconfig.dev.json

@@ -0,0 +1,3 @@
+{
+    "extends": ["./tsconfig.json", "../../tsconfig.dev.json"]
+}

packages/cocos/tsconfig.json

@@ -0,0 +1,9 @@
+{
+    "extends": "../../tsconfig.json",
+    "compilerOptions": {
+        "outDir": "./dist",
+        "module": "ES2022",
+        "target": "ES2022"
+    },
+    "include": ["./src"]
+}

packages/cocos/webpack.config.js

@@ -0,0 +1,37 @@
+const path = require('path');
+const webpack = require('webpack');
+
+module.exports = {
+  mode: 'production',
+  entry: './src/index.ts',
+  module: {
+    rules: [
+      {
+        test: /\.tsx?$/,
+        use: 'ts-loader',
+        exclude: /node_modules/
+      }
+    ]
+  },
+  resolve: {
+    extensions: ['.tsx', '.ts', '.js'],
+    fallback: {
+      buffer: require.resolve('buffer/')
+    }
+  },
+  output: {
+    filename: 'index.ts',
+    path: path.resolve(__dirname, './dist'),
+    libraryTarget: 'module'
+  },
+  experiments: {
+    outputModule: true
+  },
+  target: ['web', 'browserslist:> 0.5%'],
+  externals: [],
+  plugins: [
+    new webpack.ProvidePlugin({
+      Buffer: ['buffer', 'Buffer']
+    })
+  ]
+};