商业化公共模板使用指南

六安🐟片 · 发表于前天 10:42

本帖最后由六安🐟片于 2024-10-25 13:27 编辑

大家好！为了帮助各位开发者更快速地为自己的项目接入商业化，并灵活地为玩家举办各类活动以提升玩家的活跃度，我们为大家准备了一套完整的商业化模板。该模板包含了首充礼包、累充自选商品、试用商品、综合礼包商城、零售商店、充值礼包等多种功能，同时还提供了全套的商业化UI设计供开发者选择使用。大家可以灵活使用（×）魔改（√）模板中的代码及UI来适配自己的项目。

1. 内容演示
首先来看看使用演示：

2. 模板下载

IAPTemplate.rar (1.73 MB, 下载次数: 10)

前天 13:27 上传

点击文件名下载附件

3. 内容介绍
下图红色框中标注了示例项目中的主要内容：

IAP核心模块
不同IAP功能的UI页面
关联的一些核心工具

此外，项目中也包含CurrencyTempModule和ShopTempModule两个临时模块，由于不同项目中，实现货币和商城的方式各有所不同，所以只做了简单实现。

3.1 IAP核心模块

相关代码：
- IAPConfigProxy.ts 配置代理文件，负责公共模块与游戏本体配置文件的互通
- IAPData.ts IAP模块数据类，负责记录相关购买行为，活动状态等数据
- IAPModuleC.ts IAP客户端模块，负责关联UI购买交互，客户端与服务器的通信，及物品发放的客户端表现
- IAPModuleS.ts IAP服务端模块，负责处理的订单配送，处理各种相关信息的权威端验证。

3.2 商城大厅页面：
商城大厅页面是一个总的页面，其中有一个大的canvas来方式不同类型活动的子页面。通过tab来切换不同页面的显示。

相关UI：
- MallPanel.ui 大厅页面
- IAPTab.ui 大厅页面切换不同子页面的tab按钮
相关代码：
- MallPanel.ts
- IAPTab.ts

3.3 首充页面：
首充活动页面。当玩家第一次充值后，即可领取对应的奖励。

相关UI：
- FirstRechargePanel.ui 首充页面UI
- FirstRechargeItem.ui 首充页面中物品对象UI
相关代码：
- FirstRechargePanel.ts

3.4 累充页面：
当玩家累计充值达到指定数额时，即可从指定的奖励中多选一领取一个。

相关UI：
- AddRechargePanel.ui 累充页面UI
- AddRechargeItemUI.ui 累充页面中物品对象UI
相关代码：
- TotalRechargeMain.ts

3.5 限时体验页面：
活动期间，玩家可以体验使用指定的几件商品，当达到体验次数时不可再进行体验。可以直接点击对应商品永久购买。

相关UI：
- TrialPanel.ui 限时体验页面UI
- TrialItem.ui 限时体验页面中物品对象UI
相关代码：
- TrialShopMain.ts
- TrialItem.ts

3.6 精选礼包页面：
玩家可以购买对应的礼包。可配置礼包的奖励内容，价格，折扣等。

相关UI：
- GiftPackPanel.ui 礼包页面UI
- GiftPackItem.ui 礼包页面中礼包对象UI
- GiftPackSubItem.ui 礼包页面中礼包中的物品对象UI
相关代码：
- GiftPanel.ts

3.7 零售商店页面：
玩家可以使用派对币/游戏内货币购买对应商品。

相关UI：
- RetailMainPanel.ui 零售商店页面UI
- RetailTab.ui 零售商店页面中的页签对象UI
- ShopItem.ui 零售商店页面中礼包中的商品对象UI
相关代码：
- RetailShopPanel.ts

3.8 充值页面页面：
玩家可以购买对应的货币礼包。可配置礼包的首次购买bonus等。

相关UI：
- CoinPackPanel.ui 充值页面UI
- CoinPackItem.ui 充值页面中不同档位对象UI
相关代码：
- AddCoinPanel.ts

4. 配置方法
该模板中使用到了四个表格来实现礼包，活动，商品的配置。
4.1 IapGlobal表
全局表，配置了不同活动页面的启用状态，开启/结束时间，活动奖励内容以及其他参数。同时还配置了涉及不同品质商品的底图/颜色配置。

4.2 IapItem表
物品表，包含了所有货币，资源，商品的基础属性
.jpg

4.3 IapGiftPack
礼包表，共有两个类型，（货币）充值礼包以及综合礼包。可配置礼包的配置，价格，限购数量，刷新周期等属性。

4.4 IapCommodity
商业化商品表，配置了所有需要用派对币直接购买的商品，在此模板中，主要有礼包及一些高级零售商品。分别对应了礼包表及物品表中的对象。
.jpg

如果自身的项目中已经有一些配置表格，不想再新增表格，可以在对应的表格中添加符合以上表格的字段，使得表格导出的配置类型符合模板中定义的接口要求，然后重写IAPConfigProxy中的initCfg()方法，将自己的表格配置文件关联到模块当中。

export class IAPConfigProxy {    static itemConfig: ConfigBase<IIAPItemConfig>;    static globalConfig: ConfigBase<IIAPGlobalConfig>;    static giftPackConfig: ConfigBase<IIAPGiftPackConfig>;    static commodityConfig: ConfigBase<IIAPCommodityConfig>;    /** 初始化配置，如果开发者使用自身的配置表，需要相关配置表中包含对应表格配置的接口，然后在方法内将自己的表格配置关联到相应的配置项上 */    static initCfg() {        // TODO 关联自身项目的表格配置        this.itemConfig = GameConfig.IapItem;        this.globalConfig = GameConfig.IapGlobal;        this.giftPackConfig = GameConfig.IapGiftPack;        this.commodityConfig = GameConfig.IapCommodity;    }

5. 相关接口说明
在将模板迁移到自己的项目中时，需要注意并实现以下接口，来实现对应商品及资源的互通。

5.1 物品发放回调IAPConfigProxy.onItemsDelivered

/** * 物品发放回调, 需要开发者根据自身项目实现 */static onItemsDelivered(player: Player, items: number[][]): boolean {    // 以下为示例项目逻辑，开发者需要根据自身项目实现不同物品的添加逻辑    items.forEach(info => {        const cfg = this.Item.getElement(info[0]);        switch (cfg.type) {            // 货币            case 1:                ModuleService.getModule(CurrencyTempModuleS).changeCurrency(CurrencyType.Token, info[1], player.playerId);                break;            // 物品            default:                ModuleService.getModule(ShopTempModuleS).addItem(cfg.id, player.playerId);                break;        }    })    return true;}

5.2 接入自身的游戏内货币购买商品逻辑试玩活动及零售商店中包含可以使用游戏内货币购买的商品，TrialShopMain及RetailShopPanel相关位置需要修改为自身项目的商城/物品购买接口。

5.3 对应物品试玩/结束试玩接口
如果使用试玩功能，需要调用相关代理实现对应物品的试玩逻辑：
客户端：IAPModuleC

/** 试用商品开始 */public onTrialItemStart: Action1<number> = new Action1();/** 试用商品结束 */public onTrialItemEnd: Action1<number> = new Action1();

服务端：IAPModuleS

/** 试用商品开始 * @param playerId 玩家ID * @param itemId 商品ID */public onTrialItemStart: Action2<number, number> = new Action2();/** 试用商品结束 * @param playerId 玩家ID * @param itemId 商品ID */public onTrialItemEnd: Action2<number, number> = new Action2();