WeChat Mini Game Example

https://github.com/wechat-miniprogram/minigame-demo
Admin
WeChat Mini Game Example is a comprehensive demo showcasing WeChat mini game development with cloud...
Tokens:12,124
Snippets:67
Trust Score:8.3
Update:6 months ago
Show doc for...
Tokens:
Raw
### File System Operations with wx.getFileSystemManager

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Provides examples of file system operations using wx.getFileSystemManager, including writing, reading, appending, copying, and deleting files. It handles potential errors like non-existent directories.

```javascript
const fs = wx.getFileSystemManager();
const filePath = `${wx.env.USER_DATA_PATH}/fileA/hello.txt`;

fs.writeFile({
    filePath: filePath,
    data: 'hello, world',
    success() {
        wx.showToast({ title: '写入成功', icon: 'success' });
    },
    fail(res) {
        if (res.errMsg.includes('fail no such file or directory')) {
            wx.showModal({
                title: '发生错误',
                content: '上级目录不存在，请先创建目录'
            });
        }
    }
});

fs.readFile({
    filePath: filePath,
    encoding: 'utf-8',
    success(res) {
        console.log('文件内容:', res.data);
        wx.showModal({ title: '读取成功', content: `内容: "${res.data}"` });
    }
});

fs.appendFile({
    filePath: filePath,
    data: ' - 追加的内容',
    success() {
        wx.showToast({ title: '追加成功', icon: 'success' });
    }
});

fs.copyFile({
    srcPath: filePath,
    destPath: `${wx.env.USER_DATA_PATH}/fileA/hello-copy.txt`,
    success() {
        wx.showToast({ title: '复制成功', icon: 'success' });
    }
});

fs.unlink({
    filePath: filePath,
    success() {
        wx.showToast({ title: '删除成功', icon: 'success' });
    }
});
```

--------------------------------

### wx.getGameRecorder - Game Recorder API

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Provides an interface to get a game recorder object for recording, pausing, resuming, stopping, and sharing game videos. It includes event listeners for time updates during recording and demonstrates creating a share button upon completion. Supports setting time ranges for sharing.

```javascript
// 获取游戏录屏对象
const gameRecorder = wx.getGameRecorder();
let recordDuration = 0;

// 开始录屏
gameRecorder.start().then((res) => {
    if (res.error.code) {
        console.error('录屏失败:', res.errMsg);
        return;
    }

    // 监听录制时长更新
    gameRecorder.on('timeUpdate', (result) => {
        recordDuration = Math.min(result.currentTime, 60000);  // 最长60秒
        console.log(`录制时长: ${recordDuration}ms`);
    });
});

// 暂停录屏
gameRecorder.pause().then((res) => {
    console.log('暂停录屏', res);
});

// 继续录屏
gameRecorder.resume().then((res) => {
    console.log('继续录屏', res);
});

// 结束录屏并创建分享按钮
gameRecorder.stop().then((res) => {
    if (res.error.code) return;

    gameRecorder.off('timeUpdate');

    // 创建分享按钮
    const shareButton = wx.createGameRecorderShareButton({
        style: {
            left: 100,
            top: 300,
            width: 100,
            height: 40,
            backgroundColor: '#ffffff',
            color: '#576b95'
        },
        text: '分享视频',
        share: {
            query: 'from=recorder',
            bgm: 'audio/bgm.mp3',
            timeRange: [[0, recordDuration]]
        }
    });

    shareButton.show();
});
```

--------------------------------

### Cloud Function: Database CRUD Operations

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Demonstrates cloud function examples for performing Create, Read, Update, and Delete operations on the 'activity' collection in the cloud database. Includes functions for adding and querying records.

```javascript
// cloudfunction/quickstartFunctions/addRecord/index.js
const cloud = require('wx-server-sdk');

cloud.init({
    env: cloud.DYNAMIC_CURRENT_ENV
});

const db = cloud.database();

// 添加记录
exports.main = async (event, context) => {
    try {
        const wxContext = cloud.getWXContext();

        await db.collection('activity').add({
            data: {
                creator: wxContext.OPENID,
                activityId: event.activityId,
                roomid: event.roomid,
                chatType: event.chatType,
                participant: event.participant,
                signIn: event.signIn,
                isFinished: event.isFinished,
                createTime: Date.now(),
                taskTitle: event.taskTitle
            }
        });

        return { success: true };
    } catch (e) {
        return { success: false, errMsg: e };
    }
};

// 查询记录
// cloudfunction/quickstartFunctions/selectRecord/index.js
exports.main = async (event, context) => {
    try {
        const resp = await db.collection('activity').where({
            activityId: event.activityId
        }).get();

        if (resp.data.length) {
            return {
                success: true,
                activityInfo: resp.data[0]
            };
        } else {
            return {
                success: false,
                errMsg: '未找到活动'
            };
        }
    } catch (error) {
        return { success: false, errMsg: error };
    }
};

// 客户端调用
wx.cloud.callFunction({
    name: 'quickstartFunctions',
    data: {
        type: 'addRecord',
        activityId: 'activity_001',
        taskTitle: '每日签到',
        isFinished: false
    },
    success(res) {
        console.log('添加结果:', res.result);
    }
});
```

--------------------------------

### Cloud Function: Get User OpenID

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

A Cloud Function example to retrieve the user's OpenID, AppID, and UnionID.

```APIDOC
## Cloud Function: Get User OpenID

### Description
This Cloud Function retrieves the user's unique OpenID, AppID, and UnionID within the WeChat ecosystem.

### Method
`wx.cloud.callFunction()` (Client-side)
`cloud.getWXContext()` (Server-side)

### Endpoint
N/A (Cloud Function)

### Parameters
#### Client-side `wx.cloud.callFunction` Parameters
- **name** (string) - Required - The name of the Cloud Function to call (e.g., 'quickstartFunctions').
- **data** (object) - Optional - Data to pass to the Cloud Function (e.g., `{ type: 'getOpenId' }`).

#### Server-side `cloud.getWXContext()` Parameters
None

### Request Example
```javascript
// Client-side call
wx.cloud.callFunction({
    name: 'quickstartFunctions',
    data: { type: 'getOpenId' },
    success(res) {
        console.log('OpenID:', res.result.openid);
        console.log('AppID:', res.result.appid);
        console.log('UnionID:', res.result.unionid);
    }
});
```

### Response
#### Success Response (200)
- **openid** (string) - The user's OpenID.
- **appid** (string) - The Mini Program's AppID.
- **unionid** (string) - The user's UnionID (if available).

#### Response Example
```json
{
  "openid": "o6_bmasR...",
  "appid": "wx1234567890abcdef",
  "unionid": "o6_bmasR..."
}
```
```

--------------------------------

### Cloud Function: Get User OpenID, AppID, and UnionID

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

A cloud function example that retrieves the user's OpenID, AppID, and UnionID. It's designed to be called from the client-side.

```javascript
// cloudfunction/quickstartFunctions/getOpenId/index.js
const cloud = require('wx-server-sdk');

cloud.init({
    env: cloud.DYNAMIC_CURRENT_ENV
});

// 获取 openId 云函数
exports.main = async (event, context) => {
    const wxContext = cloud.getWXContext();

    return {
        openid: wxContext.OPENID,
        appid: wxContext.APPID,
        unionid: wxContext.UNIONID
    };
};

// 客户端调用
wx.cloud.callFunction({
    name: 'quickstartFunctions',
    data: { type: 'getOpenId' },
    success(res) {
        console.log('OpenID:', res.result.openid);
    }
});
```

--------------------------------

### wx.getBatteryInfo - Get Battery Information

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Get the device's current battery level and charging status.

```APIDOC
## wx.getBatteryInfo - Get Battery Information

### Description
Get the device's current battery level and charging status.

### Method
`wx.getBatteryInfo`

### Response
#### Success Response
- **level** (number) - The current battery level (0-100).
- **isCharging** (boolean) - Whether the device is currently charging.
```

--------------------------------

### wx.getLocation - Get Geolocation

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Get the user's current geolocation information.

```APIDOC
## wx.getLocation - Get Geolocation

### Description
Get the user's current geolocation information. Requires location permissions to be declared in `game.json`.

### Method
`wx.getLocation`

### Parameters
#### Request Body
- **type** (string) - Optional - The type of coordinate system to return. Can be 'wgs84' or 'gcj02'. Defaults to 'gcj02'.
- **altitude** (boolean) - Optional - Whether to return altitude information. Defaults to false.

### Request Example
```javascript
// Ensure permissions are declared in game.json:
// {
//     "permission": {
//         "scope.userLocation": {
//             "desc": "Your location information will be used for the effect display of the mini program's location interface"
//         }
//     }
// }

wx.getLocation({
    type: 'wgs84',
    success(res) {
        console.log('Latitude:', res.latitude);
        console.log('Longitude:', res.longitude);
        console.log('Speed:', res.speed);
        console.log('Accuracy:', res.accuracy);
    },
    fail(err) {
        console.error('Failed to get location:', err);
    }
});
```

### Response
#### Success Response
- **latitude** (number) - Latitude.
- **longitude** (number) - Longitude.
- **speed** (number) - Speed (meters/second).
- **accuracy** (number) - Accuracy (meters).
- **altitude** (number) - Altitude (meters), only returned if `altitude` is true.
```

--------------------------------

### Cloud Function: Database Operations

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Examples of Cloud Functions for performing CRUD (Create, Read, Update, Delete) operations on the Cloud Database.

```APIDOC
## Cloud Function: Database Operations

### Description
Provides examples of Cloud Functions for interacting with the Cloud Database, including adding, querying, updating, and deleting records.

### Method
`wx.cloud.callFunction()` (Client-side)
`cloud.database()` (Server-side)

### Endpoint
N/A (Cloud Function)

### Parameters
#### Client-side `wx.cloud.callFunction` Parameters
- **name** (string) - Required - The name of the Cloud Function to call (e.g., 'quickstartFunctions').
- **data** (object) - Optional - Data to pass to the Cloud Function (e.g., `{ type: 'addRecord', ... }`).

#### Server-side `cloud.database()` Operations
- **`db.collection('collectionName').add({ data: {...} })`**: Adds a new document.
- **`db.collection('collectionName').where(condition).get()`**: Queries documents matching the condition.
- **`db.collection('collectionName').doc(docId).update({ data: {...} })`**: Updates a document by its ID.
- **`db.collection('collectionName').doc(docId).remove()`**: Deletes a document by its ID.

### Request Example (Add Record)
```javascript
// Client-side call to add a record
wx.cloud.callFunction({
    name: 'quickstartFunctions',
    data: {
        type: 'addRecord',
        activityId: 'activity_001',
        taskTitle: 'Daily Sign-in',
        isFinished: false
    },
    success(res) {
        console.log('Add result:', res.result);
    }
});
```

### Response (Add Record)
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "success": true
}
```

### Request Example (Query Record)
```javascript
// Client-side call to query a record
wx.cloud.callFunction({
    name: 'quickstartFunctions',
    data: {
        type: 'selectRecord',
        activityId: 'activity_001'
    },
    success(res) {
        console.log('Query result:', res.result);
    }
});
```

### Response (Query Record)
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.
- **activityInfo** (object) - The queried activity information if found.

#### Response Example
```json
{
  "success": true,
  "activityInfo": {
    "_id": "some_id",
    "creator": "o6_bmasR...",
    "activityId": "activity_001",
    "taskTitle": "Daily Sign-in",
    "isFinished": false,
    "createTime": 1678886400000
  }
}
```
```

--------------------------------

### Cloud Function: Message Push

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

An example of a Cloud Function that uses Cloud API to send a subscription message to a user.

```APIDOC
## Cloud Function: Message Push

### Description
This Cloud Function demonstrates how to send a subscription message to a user using the `openapi.subscribeMessage.send` API.

### Method
`wx.cloud.callFunction()` (Client-side)
`cloud.openapi.subscribeMessage.send()` (Server-side)

### Endpoint
N/A (Cloud Function)

### Parameters
#### Client-side `wx.cloud.callFunction` Parameters
- **name** (string) - Required - The name of the Cloud Function to call (e.g., 'pushMessage').
- **data** (object) - Optional - Data to pass to the Cloud Function (e.g., `{ page: 'pages/index/index' }`).

#### Server-side `cloud.openapi.subscribeMessage.send` Parameters
- **touser** (string) - Required - The user's OpenID.
- **page** (string) - Optional - The page path to jump to when the user clicks the message.
- **data** (object) - Required - The content of the subscription message. Keys must match the template.
- **templateId** (string) - Required - The ID of the subscription message template.

### Request Example
```javascript
// Client-side call
wx.cloud.callFunction({
    name: 'pushMessage',
    data: {
        page: 'pages/index/index'
    },
    success() {
        wx.showToast({ title: 'Push successful', icon: 'success' });
    }
});
```

### Response
#### Success Response (200)
- **errcode** (number) - Error code (0 for success).
- **errmsg** (string) - Error message.

#### Response Example
```json
{
  "errcode": 0,
  "errmsg": "ok"
}
```
```

--------------------------------

### Cloud Function: Send Subscription Message

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

An example of a cloud function that uses cloud API to send a subscription message to a user. It requires a template ID and user information.

```javascript
// cloudfunction/pushMessage/index.js
const cloud = require('wx-server-sdk');

cloud.init();

// 发送订阅消息
exports.main = async (event) => {
    try {
        const result = await cloud.openapi.subscribeMessage.send({
            touser: cloud.getWXContext().OPENID,
            page: event.page,
            data: {
                time1: { value: '2020年1月9日' },
                thing2: { value: '体验订阅消息推送' }
            },
            templateId: 'wAniOv_NUi6TXiQWX74_1LD5E4_6EfqvaeSxUxhqllg'
        });

        return result;
    } catch (err) {
        return err;
    }
};

// 客户端调用
wx.cloud.callFunction({
    name: 'pushMessage',
    data: {
        page: 'pages/index/index'
    },
    success() {
        wx.showToast({ title: '推送成功', icon: 'success' });
    }
});
```

--------------------------------

### Initialize WeChat Mini Game with PIXI.js

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

This snippet demonstrates the entry point for a WeChat Mini Game. It initializes the cloud environment, configures the PIXI.js renderer with system-specific dimensions, maps touch coordinates, and handles asynchronous subpackage loading.

```javascript
import './js/libs/weapp-adapter';
import * as PIXI from './js/libs/pixi.min';

wx.cloud.init({ env: 'your-env-id' });
wx.updateShareMenu({ withShareTicket: true });

const { pixelRatio, windowWidth, windowHeight } = wx.getSystemInfoSync();

const app = new PIXI.Application({
    width: windowWidth * pixelRatio,
    height: windowHeight * pixelRatio,
    view: canvas,
    backgroundColor: 0xf6f6f6,
    preserveDrawingBuffer: true,
    antialias: true,
    resolution: 1,
    forceCanvas: true
});

PIXI.interaction.InteractionManager.prototype.mapPositionToPoint = (point, x, y) => {
    point.x = x * pixelRatio;
    point.y = y * pixelRatio;
};

PIXI.loader.add(['images/icon1.png', 'images/icon2.png']).load(() => {
    wx.loadSubpackage({
        name: 'api',
        success() {
            const router = require('./js/api/game');
            router(PIXI, app, { width: windowWidth * pixelRatio, height: windowHeight * pixelRatio, pixelRatio });
        }
    }).onProgressUpdate((res) => {
        console.log('下载进度:', res.progress);
    });
});

wx.onShow((res) => {
    const query = res.query;
    if (query && query.pathName) {
        window.router.navigateTo(query.pathName, query, res);
    }
});
```

--------------------------------

### Configure WeChat Cloud Initialization

Source: https://github.com/wechat-miniprogram/minigame-demo/blob/master/CLOUD_README.md

This snippet shows how to initialize WeChat Cloud Development by setting the environment ID. It involves searching for `wx.cloud.init` in the project and replacing the placeholder environment ID with the actual one obtained from the Cloud Development console. This step is crucial for connecting the mini program to its cloud backend.

```javascript
wx.cloud.init({ env: 'YOUR_ENVIRONMENT_ID' })
```

--------------------------------

### Manage Local Storage with wx.setStorage and wx.getStorage

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Demonstrates how to store, retrieve, and clear data from the local cache using wx.setStorage, wx.getStorage, and wx.clearStorage. Data is stored as key-value pairs, and operations include success and fail callbacks.

```javascript
wx.setStorage({
    key: 'userScore',
    data: { score: 1000, level: 5 },
    success() {
        wx.showModal({ content: '数据存储成功' });
    }
});

wx.getStorage({
    key: 'userScore',
    success(res) {
        console.log('读取数据:', res.data);
        wx.showModal({
            title: '读取数据成功',
            content: `data: ${JSON.stringify(res.data)}`
        });
    },
    fail() {
        wx.showModal({
            title: '读取数据失败',
            content: '找不到 key 对应的数据'
        });
    }
});

wx.clearStorage({
    success() {
        wx.showModal({ content: '清除数据成功' });
    }
});
```

--------------------------------

### Initialize Cloud Development

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Initializes the Cloud Development environment, enabling features like Cloud Functions, Cloud Database, and Cloud Storage.

```APIDOC
## Initialize Cloud Development

### Description
Initializes the Cloud Development environment, enabling features like Cloud Functions, Cloud Database, and Cloud Storage.

### Method
`wx.cloud.init()`

### Endpoint
N/A (Client-side API)

### Parameters
#### Options
- **env** (string) - Required - The Cloud Development environment ID.
- **traceUser** (boolean) - Optional - Whether to record user access when calling Cloud Functions. Defaults to false.

### Request Example
```javascript
// Initialize Cloud Development (call in the game.js entry file)
wx.cloud.init({
    env: 'your-env-id',  // Cloud Development environment ID
    traceUser: true      // Whether to record user access when calling Cloud Functions
});
```

### Response
N/A (This is an initialization function.)
```

--------------------------------

### Create and Manage Rewarded Video Ads with wx.createRewardedVideoAd

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Demonstrates the creation and management of rewarded video ads using wx.createRewardedVideoAd. It covers loading ads, handling user interactions (watching the video), closing the ad, and managing various error codes.

```javascript
const errorCodes = {
    1000: '后端接口调用失败',
    1001: '参数错误',
    1002: '广告单元无效',
    1003: '内部错误',
    1004: '无合适的广告',
    1005: '广告组件审核中',
    1006: '广告组件被驳回',
    1007: '广告组件被封禁',
    1008: '广告单元已关闭'
};

wx.showLoading({ title: '正在初始化...' });

const rewardedVideo = wx.createRewardedVideoAd({
    adUnitId: 'adunit-367ee566b15d46b3',
    multiton: true
});

rewardedVideo.onError((res) => {
    wx.showModal({
        title: errorCodes[res.errCode],
        content: res.errMsg
    });
});

rewardedVideo.load()
    .then(() => wx.hideLoading())
    .catch(() => wx.hideLoading());

rewardedVideo.show()
    .then(() => {
        rewardedVideo.onClose((res) => {
            if (res.isEnded) {
                wx.showModal({ title: '演示结果', content: '已获得奖励' });
            } else {
                wx.showModal({ title: '演示结果', content: '视频还没看完，获取奖励失败' });
            }
            rewardedVideo.offClose();
        });
    })
    .catch((res) => {
        wx.showModal({
            title: errorCodes[res.errCode],
            content: res.errMsg
        });
        rewardedVideo.load();
    });

rewardedVideo.destroy();
```

--------------------------------

### wx.createUserInfoButton - User Info Button API

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Creates a button that allows users to grant permission for the mini game to access their public information like nickname and avatar. It handles user authorization success and denial, and retrieves user info upon successful authorization. Includes functionality to destroy the button.

```javascript
// 创建用户信息按钮
const userInfoButton = wx.createUserInfoButton({
    type: 'text',
    text: '获取用户信息',
    style: {
        left: 100,
        top: 200,
        width: 200,
        height: 40,
        lineHeight: 40,
        backgroundColor: '#1aad19',
        color: '#ffffff',
        textAlign: 'center',
        fontSize: 16,
        borderRadius: 4
    }
});

// 监听按钮点击
userInfoButton.onTap((res) => {
    if (res.errMsg === 'getUserInfo:fail auth deny') {
        // 用户拒绝授权
        wx.showModal({
            title: '授权失败',
            content: '用户不授权是无法获取到用户信息的'
        });
        return;
    }

    // 授权成功，获取用户信息
    wx.getUserInfo({
        success(result) {
            console.log('用户信息:', result.userInfo);
            // userInfo 包含: nickName, avatarUrl, gender, country, province, city
        }
    });
});

// 销毁按钮
// userInfoButton.destroy();
```

--------------------------------

### Initialize Cloud Development Environment

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Initializes the cloud development environment for WeChat Mini Programs, enabling features like cloud functions, database, and storage. This should be called in the entry file (e.g., game.js).

```javascript
wx.cloud.init({
    env: 'your-env-id',  // 云开发环境 ID
    traceUser: true      // 是否在调用云函数时记录用户访问
});
```

--------------------------------

### wx.getGameRecorder - Game Screen Recording

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Provides an interface to record, pause, resume, and stop game screen capture.

```APIDOC
## wx.getGameRecorder

### Description
Retrieves the recorder instance to manage screen capture.

### Method
wx.getGameRecorder()

### Response
#### Success Response (200)
- **recorder** (object) - Instance with start(), pause(), resume(), and stop() methods.
```

--------------------------------

### wx.createUserInfoButton - User Info Authorization

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Creates a button that, when tapped, requests user permission to access profile information.

```APIDOC
## wx.createUserInfoButton

### Description
Creates a button to trigger user authorization for profile data.

### Method
wx.createUserInfoButton(object)

### Parameters
- **type** (string) - Required - Button type ('text' or 'image').
- **text** (string) - Required - Button display text.
- **style** (object) - Required - CSS-like styles for button positioning.

### Response
#### Success Response (200)
- **userInfo** (object) - Contains nickName, avatarUrl, gender, etc.
```

--------------------------------

### Multi-threading with wx.createWorker

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Illustrates how to create and manage a worker thread using wx.createWorker to perform heavy computations without blocking the main UI thread. It includes sending messages to the worker and receiving results.

```javascript
// 主线程代码
const worker = wx.createWorker('workers/index.js');

worker.postMessage({
    msg: 40  // 计算第 40 个斐波那契数
});

worker.onMessage((result) => {
    console.log('Worker 计算结果:', result.msg);
    wx.showModal({ title: '计算结果', content: `${result.msg}` });
});

// 不使用 Worker 的主线程计算（会阻塞UI）
function fibonacci(n) {
    return n < 2 ? n : fibonacci(n - 1) + fibonacci(n - 2);
}

// workers/index.js - Worker 线程代码
worker.onMessage((data) => {
    const fibonacci = (n) => {
        return n < 2 ? n : fibonacci(n - 1) + fibonacci(n - 2);
    };

    const result = fibonacci(data.msg);
    worker.postMessage({ msg: result });
});
```

--------------------------------

### Create and Manage Banner Ads with wx.createBannerAd

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Shows how to create, display, hide, and destroy a banner ad component using wx.createBannerAd. It includes handling ad loading and error events, and setting refresh intervals.

```javascript
const bannerAd = wx.createBannerAd({
    adUnitId: 'adunit-2e20328227ca771b',
    adIntervals: 30,  // 广告自动刷新间隔（秒），需 >= 30
    style: {
        left: 0,
        top: 500,
        width: 300
    }
});

wx.showLoading({ title: '广告打开中...', mask: true });

bannerAd.onLoad(() => {
    wx.hideLoading();
    bannerAd.show();  // 显示广告
});

bannerAd.onError((res) => {
    wx.hideLoading();
    wx.showModal({ title: '发生错误', content: res.errMsg });
});

bannerAd.hide();

bannerAd.show();

bannerAd.destroy();
```

--------------------------------

### Set Preferred Frames Per Second with wx.setPreferredFramesPerSecond

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Demonstrates how to set the desired rendering frame rate for the game using wx.setPreferredFramesPerSecond. This can be used to optimize performance or conserve battery by adjusting the FPS.

```javascript
wx.setPreferredFramesPerSecond(60);

wx.setPreferredFramesPerSecond(30);
```

--------------------------------

### wx.showToast - Message Prompt

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Display a message prompt box with various styles.

```APIDOC
## wx.showToast - Message Prompt

### Description
Display a message prompt box with various styles, including default, loading, and success.

### Method
`wx.showToast`

### Parameters
#### Request Body
- **title** (string) - Required - The text to display.
- **icon** (string) - Optional - The icon to display. Can be 'success', 'loading', or 'none'. Defaults to 'success'.
- **duration** (number) - Optional - The duration to display the toast in milliseconds. Defaults to 1500.
- **mask** (boolean) - Optional - Whether to display a mask to prevent user interaction. Defaults to false.

### Request Example
```javascript
// Default toast
wx.showToast({
    title: '操作成功'
});

// Custom duration toast
wx.showToast({
    title: '处理中...',
    duration: 3000
});

// Loading toast
wx.showToast({
    title: '加载中',
    icon: 'loading',
    duration: 5000
});
```

### Related Functions
- `wx.hideToast()`: Manually hide the toast message.
```

--------------------------------

### Manage User Cloud Storage and Social Data

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Demonstrates how to upload user scores to the cloud, interact with the open data context for leaderboards, and subscribe to system messages for social notifications.

```javascript
const score = Math.floor(Math.random() * 1000 + 1);
wx.setUserCloudStorage({
    KVDataList: [{
            key: 'rankid',
            value: JSON.stringify({ wxgame: { score: score, update_time: parseInt(+new Date() / 1000) } })
        }],
    success: () => { wx.showToast({ title: `分数上报成功: ${score}分`, icon: 'none' }); }
});
const openDataContext = wx.getOpenDataContext();
openDataContext.postMessage({ event: 'showFriendRank' });
wx.requestSubscribeSystemMessage({
    msgTypeList: ['SYS_MSG_TYPE_INTERACTIVE', 'SYS_MSG_TYPE_RANK'],
    success(res) {
        let tips = '成功订阅';
        if (res.SYS_MSG_TYPE_INTERACTIVE === 'accept') tips += '好友互动提醒';
        if (res.SYS_MSG_TYPE_RANK === 'accept') tips += '和排行榜好友超越提醒';
        wx.showToast({ title: tips, icon: 'none' });
    }
});
```

--------------------------------

### Display UI Modals and Toasts

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Shows how to trigger modal dialogs for user interaction and display various toast notifications for feedback.

```javascript
wx.showModal({
    title: '弹窗标题',
    content: '弹窗内容，告知当前状态、信息和解决方法',
    showCancel: false,
    confirmText: '确定',
    success(res) { if (res.confirm) console.log('用户点击确定'); }
});
wx.showToast({ title: '操作成功' });
wx.showToast({ title: '加载中', icon: 'loading', duration: 5000 });
```

--------------------------------

### Clone WeChat Mini Game Repository

Source: https://github.com/wechat-miniprogram/minigame-demo/blob/master/README.md

Command to clone the official WeChat Mini Game sample project from GitHub. This is the first step to setting up the development environment.

```shell
git clone https://github.com/wechat-miniprogram/minigame-demo.git
```

--------------------------------

### wx.connectSocket - WebSocket Connection

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Create a WebSocket connection for bidirectional communication with a server.

```APIDOC
## wx.connectSocket - WebSocket Connection

### Description
Create a WebSocket connection for bidirectional communication with a server.

### Method
`wx.connectSocket`

### Parameters
#### Request Body
- **url** (string) - Required - The URL of the WebSocket server.
- **protocols** (Array<string>) - Optional - An array of protocols.
- **alias** (string) - Optional - An alias for the connection.

### Request Example
```javascript
wx.showLoading({ title: 'Connecting...', mask: true });

wx.onSocketOpen(() => {
    wx.hideLoading();
    wx.showToast({ title: 'Socket connected', icon: 'success' });
    console.log('WebSocket connected');
    // Send a message after connection is established
    wx.sendSocketMessage({ data: 'Hello Server!' });
});

wx.onSocketClose(() => {
    console.log('WebSocket disconnected');
});

wx.onSocketError((error) => {
    wx.hideLoading();
    console.error('Socket error:', error);
    wx.showModal({ title: 'Error', content: JSON.stringify(error) });
});

wx.onSocketMessage((message) => {
    console.log('Received message:', message.data);
    wx.showToast({ title: 'Message received', icon: 'none' });
});

// Establish the connection
wx.connectSocket({
    url: 'wss://echo.websocket.org'
});

// To send messages later:
// wx.sendSocketMessage({ data: 'Your message here' });

// To close the connection:
// wx.closeSocket({
//     success() {
//         wx.showToast({ title: 'Socket closed', icon: 'success' });
//     }
// });
```

### Response
#### Event Listeners
- **onOpen**: Callback when the connection is successfully opened.
- **onClose**: Callback when the connection is closed.
- **onError**: Callback when an error occurs.
- **onMessage**: Callback when a message is received from the server.
```

--------------------------------

### wx.showModal - Modal Dialog

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Display a modal dialog with or without a title.

```APIDOC
## wx.showModal - Modal Dialog

### Description
Display a modal dialog with or without a title. Supports custom confirm and cancel buttons.

### Method
`wx.showModal`

### Parameters
#### Request Body
- **title** (string) - Optional - The title of the modal.
- **content** (string) - Required - The content of the modal.
- **showCancel** (boolean) - Optional - Whether to show a cancel button. Defaults to true.
- **confirmText** (string) - Optional - The text of the confirm button. Defaults to '确定'.
- **cancelText** (string) - Optional - The text of the cancel button. Defaults to '取消'.

### Request Example
```javascript
// Modal with title
wx.showModal({
    title: '弹窗标题',
    content: '弹窗内容，告知当前状态、信息和解决方法',
    showCancel: false,
    confirmText: '确定',
    success(res) {
        if (res.confirm) {
            console.log('用户点击确定');
        }
    }
});

// Modal without title (with cancel button)
wx.showModal({
    content: '弹窗内容，告知当前状态、信息和解决方法',
    confirmText: '确定',
    cancelText: '取消',
    success(res) {
        if (res.confirm) {
            console.log('用户点击确定');
        } else if (res.cancel) {
            console.log('用户点击取消');
        }
    }
});
```

### Response
#### Success Response (Callback)
- **confirm** (boolean) - True if the confirm button was pressed, false otherwise.
- **cancel** (boolean) - True if the cancel button was pressed, false otherwise.
```

--------------------------------

### wx.shareAppMessage - Social Sharing

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Programmatically triggers the share interface to allow users to share the game with friends or groups.

```APIDOC
## wx.shareAppMessage

### Description
Opens the share interface for the user.

### Method
wx.shareAppMessage(object)

### Parameters
- **title** (string) - Required - The title of the shared message.
- **imageUrl** (string) - Optional - The image path or URL for the share card.
- **query** (string) - Optional - Query parameters to append to the shared link.
```

--------------------------------

### wx.login - WeChat Login API

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Initiates WeChat login to obtain a user's login credential (code). This code can then be sent to a backend server to exchange for the user's unique OpenID and session key. Handles success and failure scenarios.

```javascript
wx.login({
    success(res) {
        if (res.code) {
            // 登录成功，获取到 code
            console.log('登录凭证:', res.code);

            // 发送 code 到后端换取 openId 和 session_key
            wx.request({
                url: 'https://your-server.com/login',
                data: { code: res.code },
                success(response) {
                    console.log('服务器返回:', response.data);
                }
            });
        } else {
            console.log('登录失败！' + res.errMsg);
        }
    },
    fail(err) {
        console.error('登录接口调用失败:', err);
    }
});
```

--------------------------------

### wx.login - WeChat Login

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Obtain a temporary login code to exchange for user OpenID and session_key on your server.

```APIDOC
## wx.login

### Description
Initiates the WeChat login process to obtain a temporary code.

### Method
wx.login()

### Parameters
- **success** (function) - Required - Callback function for success.
- **fail** (function) - Optional - Callback function for failure.

### Request Example
wx.login({ success: (res) => { ... } })

### Response
#### Success Response (200)
- **code** (string) - The temporary login credential.

#### Response Example
{ "code": "0123456789abcdef" }
```

--------------------------------

### Implement WebSocket Communication

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Handles the lifecycle of a WebSocket connection, including opening, listening for messages, handling errors, and closing the connection.

```javascript
wx.connectSocket({ url: 'wss://echo.websocket.org' });
wx.onSocketOpen(() => { console.log('WebSocket 已连接'); });
wx.onSocketMessage((message) => { console.log('收到消息:', message); });
wx.sendSocketMessage({ data: 'Hello, MiniGame!' });
wx.onSocketClose(() => { console.log('WebSocket 已断开'); });
```

--------------------------------

### wx.setUserCloudStorage - Open Data Domain

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Write user data to the open data domain to implement social features like friend leaderboards.

```APIDOC
## wx.setUserCloudStorage - Open Data Domain

### Description
Write user data to the open data domain to implement social features like friend leaderboards.

### Method
`wx.setUserCloudStorage`

### Parameters
#### Request Body
- **KVDataList** (Array<Object>) - Required - A list of key-value pairs to be stored.
  - **key** (string) - Required - The key for the data.
  - **value** (string) - Required - The value for the data, typically JSON stringified.

### Request Example
```javascript
const score = Math.floor(Math.random() * 1000 + 1);

wx.setUserCloudStorage({
    KVDataList: [
        {
            key: 'rankid',
            value: JSON.stringify({
                wxgame: {
                    score: score,
                    update_time: parseInt(+new Date() / 1000)
                }
            })
        }
    ],
    success: () => {
        wx.showToast({
            title: `分数上报成功: ${score}分`,
            icon: 'none'
        });
    }
});
```

### Related Functions
- `wx.getOpenDataContext()`: Get the open data context.
- `openDataContext.postMessage()`: Send messages to the open data context.
```

--------------------------------

### wx.requestSubscribeMessage - Subscription Messaging

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Requests permission from the user to send push notifications via templates.

```APIDOC
## wx.requestSubscribeMessage

### Description
Requests user subscription to specific message templates.

### Method
wx.requestSubscribeMessage(object)

### Parameters
- **tmplIds** (array) - Required - List of template IDs to request.
```

--------------------------------

### wx.onAccelerometerChange - Accelerometer Sensor

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Listen for accelerometer data changes to implement features like shake detection.

```APIDOC
## wx.onAccelerometerChange - Accelerometer Sensor

### Description
Listen for accelerometer data changes. Used for features like shake detection.

### Method
`wx.onAccelerometerChange`

### Parameters
#### Callback Function
- **res** (Object) - The accelerometer data.
  - **x** (number) - Acceleration value on the X-axis.
  - **y** (number) - Acceleration value on the Y-axis.
  - **z** (number) - Acceleration value on the Z-axis.

### Request Example
```javascript
let accelerometerCallback;

// Start listening
function startAccelerometer() {
    wx.startAccelerometer({
        interval: 'game' // 'game' interval is suitable for games, approx. 20ms/callback
    });

    accelerometerCallback = (res) => {
        console.log('X-axis:', res.x);
        console.log('Y-axis:', res.y);
        console.log('Z-axis:', res.z);
    };

    wx.onAccelerometerChange(accelerometerCallback);
}

// Stop listening
function stopAccelerometer() {
    wx.stopAccelerometer();
    if (accelerometerCallback && wx.offAccelerometerChange) {
        wx.offAccelerometerChange(accelerometerCallback);
        accelerometerCallback = null;
    }
}

// Example usage:
// startAccelerometer();
// setTimeout(stopAccelerometer, 5000); // Stop after 5 seconds
```

### Related Functions
- `wx.startAccelerometer()`: Start listening to accelerometer data.
- `wx.stopAccelerometer()`: Stop listening to accelerometer data.
- `wx.offAccelerometerChange()`: Remove the accelerometer change listener.
```

--------------------------------

### wx.shareAppMessage - Share Message API

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Initiates the WeChat forward message interface, allowing users to share the mini game to friends or groups. Supports custom titles, using current screen captures as share images, and passing query parameters. Also includes an event listener for successful sharing.

```javascript
// 主动拉起转发分享
wx.shareAppMessage({
    title: '我在玩一个超好玩的小游戏',
    // 使用当前画面截图作为分享图片
    imageUrl: canvas.toTempFilePathSync({
        x: 0,
        y: 0,
        width: canvas.width,
        height: (canvas.width * 4) / 5  // 5:4 比例
    }),
    query: 'level=5&score=1000'  // 分享携带的参数
});

// 监听分享成功事件
wx.onShareAppMessage(() => {
    return {
        title: '分享标题',
        imageUrl: 'https://example.com/share.png',
        query: 'from=share'
    };
});
```

--------------------------------

### wx.requestSubscribeMessage - Subscribe Message API

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Triggers the mini game's subscribe message interface, enabling users to opt-in to receiving template messages. Upon user acceptance, it calls a cloud function to push the message. Handles both acceptance and rejection scenarios, providing user feedback.

```javascript
// 请求订阅消息
wx.requestSubscribeMessage({
    // 模板消息 ID 数组
    tmplIds: ['wAniOv_NUi6TXiQWX74_1LD5E4_6EfqvaeSxUxhqllg'],
    success(res) {
        // 检查用户订阅结果
        if (res['wAniOv_NUi6TXiQWX74_1LD5E4_6EfqvaeSxUxhqllg'] === 'accept') {
            // 用户允许订阅，调用云函数推送消息
            wx.cloud.callFunction({
                name: 'pushMessage',
                data: {
                    page: 'pages/index/index'
                },
                success() {
                    wx.showToast({ title: '推送成功', icon: 'success' });
                },
                fail: console.error
            });
        }

        if (res['wAniOv_NUi6TXiQWX74_1LD5E4_6EfqvaeSxUxhqllg'] === 'reject') {
            wx.showModal({
                title: '订阅失败',
                content: '你已拒绝消息订阅，可前往设置中打开'
            });
        }
    },
    fail() {
        wx.showModal({
            title: '订阅失败',
            content: '你已拒绝消息订阅'
        });
    }
});
```

--------------------------------

### Access Device Sensors and Info

Source: https://context7.com/wechat-miniprogram/minigame-demo/llms.txt

Retrieves geolocation, monitors accelerometer data for motion detection, and checks battery status.

```javascript
wx.getLocation({
    type: 'wgs84',
    success(res) { console.log('纬度:', res.latitude, '经度:', res.longitude); }
});
wx.startAccelerometer({ interval: 'game' });
wx.onAccelerometerChange((res) => { console.log('x轴:', res.x, 'y轴:', res.y, 'z轴:', res.z); });
wx.getBatteryInfo({ success(res) { console.log('当前电量:', res.level + '%'); } });
```
Tokens:
Raw