WeChat Mini Game Tuanjie Engine Adapter SDK

To install the SDK in your Unity or Tuanjie Engine project, use the Unity Package Manager to add the repository via its Git URL.

1. Open your project in Unity or Tuanjie Engine.
2. Navigate to Window -> Package Manager in the menu bar.
3. Click the + button in the top-right corner.
4. Select Add package from git URL....
5. Enter the repository Git URL: https://github.com/wechat-miniprogram/minigame-tuanjie-transform-sdk.git.

The complete WeChat SDK surface is aggregated into a single object and attached to the global GameGlobal.WXWASMSDK namespace. This object provides access to a wide range of WeChat Mini Game capabilities, including:

• User & Social: userInfo, share, gameClub, authorize, chat
• Storage & Filesystem: storage, fs (File System)
• Media: audio, video, videoDecoder, texture, camera, recorder, gameRecorder, font
• Networking: TCPSocket, UDPSocket, uploadFile, cloud
• Hardware & Input: bluetooth, gyroscope, touch, mobileKeyboard
• Game Services: ad (Ads), openData, sdk (Core SDK)
• Utilities: util, logger, canvasContext, canvasHelper

The SDK provides a unified interface for Unity/Tuanjie engine integration within WeChat Mini Games. All core functionalities are aggregated into the GameGlobal.WXWASMSDK object. This includes modules for:

• Canvas & Rendering: canvasHelper, canvasContext, texture
• File System: fs
• Audio & Video: audio, video, videoDecoder
• Input: touch, mobileKeyboard
• Utilities: util, logger, sdk
• Special Callbacks: specialCallbacks

Additionally, GameGlobal.unityNamespace.unityVersion is available to check the current Unity version.

The Unity SDK provides a JavaScript interface for managing video playback within WeChat Mini Games. This interface allows you to create video instances, control playback (play, pause, seek, loop), manage audio tracks, and update WebGL textures with video frames.

Note that the API uses a handle-based system where most functions take a video ID (returned by _JS_Video_Create) as their first argument.

// Example conceptual usage:
// const videoId = _JS_Video_Create('https://example.com/video.mp4');
// _JS_Video_Play(videoId, false);
// _JS_Video_Seek(videoId, 10.5);

The gyroscope interface allows you to control the device's gyroscope sensor within a Unity/Tuanjie engine project running on WeChat Mini Games. It provides methods to start/stop the sensor and register callbacks for sensor changes and operation results (success/fail/complete).

// Note: These functions are exported by the SDK and intended to be called from the Unity/C# side via the bridge.

// 1. Register callbacks to handle asynchronous results
WX_RegisterStartGyroscopeCallback(startCallback);
WX_RegisterStopGyroscopeCallback(stopCallback);
WX_RegisterOnGyroscopeChangeCallback(changeCallback);

// 2. Start the gyroscope
WX_StartGyroscope(id, { interval: 100 });

// 3. Listen for sensor changes
WX_OnGyroscopeChange();

// 4. Stop the gyroscope
WX_StopGyroscope(id, {});

// 5. Unsubscribe from changes
WX_OffGyroscopeChange();

To handle touch input within the Unity/Tuanjie engine environment, you must first register a callback function using the WX_RegisterOnTouch...Callback methods. These callbacks are invoked via WebAssembly (Wasm) using a pointer to the touch data.

Once a callback is registered, you must enable the event listeners using the WX_OnTouch... methods to start receiving events from the WeChat Mini Game environment.

import touchSDK from './path/to/touch/index.js';

// 1. Register the callback that will receive the data pointer
touchSDK.WX_RegisterOnTouchStartCallback((dataPtr, touchesCount, changedTouchesCount) => {
    // Handle touch data via the pointer in your C#/Wasm layer
    console.log('Touch started');
});

// 2. Enable the WeChat event listener
touchSDK.WX_OnTouchStart();

If your game project exports successfully but throws errors when running in the WeChat Developer Tools, it is likely because the WeChat Runtime package was pruned during the Tuanjie Engine export process.

This happens when the game project is empty or the game code never invokes any runtime capabilities of the WXSDK. To resolve this, ensure you call at least one WXSDK capability within your game code to prevent the engine from stripping the runtime package during export.

The project.config.json file is the primary configuration file for the WeChat Minigame project. It defines the project type, app ID, simulator settings, and various compilation and packaging behaviors. For Unity/Tuanjie engine projects using this SDK, ensure compileType is set to game and libVersion is specified to match your target environment.

{
  "description": "项目配置文件",
  "setting": {
    "es6": true,
    "enhance": true,
    "minified": true,
    "useMultiFrameRuntime": true
  },
  "compileType": "game",
  "libVersion": "3.5.1",
  "appid": "$APP_ID",
  "projectname": "$PROJECT_NAME",
  "simulatorType": "wechat"
}