美文网首页
游戏接入文档

游戏接入文档

作者: 798798123 | 来源:发表于2023-12-03 13:55 被阅读0次

    宝门科技游戏接入文档

    一、说明

    文本档用于H5游戏插件对接秀觅趣动app时使用,游戏插件接口基于本文档定义函数及方法进行设计,app基于本文档定义函数进行接入。协议方法以’showme_’开头。
    如有需要针对某一操作单独定义接口时,商议后再更新至文档。

    二、通用接口

    2.1 App调用Js方法

    函数名: showme_sendAppData(command, json)
    cmd:执行操作命令
    json:关联数据,json格式
    

    2.2 游戏调用App方法

    函数名:showme_sendWebData(command, json)
    cmd:执行操作命令
    json:关联数据,json格式
    

    三、游戏说明

    健腹轮游戏
    功能 命令 数据 说明 备注
    开始游戏 gameStart 参数1 App执行JS
    卧推数值更新 pushStatus 参数2 App执行JS
    兑换请求 exchange 参数3 游戏JS调用
    兑换回调 exchangeCallBack 参数4 App执行JS
    分数上报 finishPlay 参数5 游戏JS调用
    开始锯木头 startCutWood 游戏JS调用
    退出游戏 quitGame 游戏JS调用

    参数 1开始游戏

    woodConfig:三种木头配置
    woodConfig.name:木头名字
    woodConfig.dayMax:今天已经获得的木头数
    woodConfig.cutTimes:锯断木头需要的次数
    exhibitImageRootUrl:exhibit图片的根目录(完整地址为exhibitImageRootUrl+image1)
    woodName:三种木头的名称
    exhibit:所有展示物品的信息,含义为[id,物品名,解锁所需物品,灰色图片,彩色图片,合成预览大图片]
    netErrorSecondTime:请求多久未响应为网络异常、单位秒
    id:唯一标识id。
    物品名:物品名字,因为字体压缩问题,名字线上之后不能私自修改增加。
    图片名:不能私自修改增加。
    解锁所需物品:sm松木、hx红橡、zt紫檀,解锁需要的各个数量。
    smNum:玩家拥有 【松木】 的数量
    hxNum:玩家拥有 【红橡】 的数量
    ztNum:玩家拥有 【紫檀】 的数量
    exhibitHad:玩家拥有家具数量
    todayCutNum:今天已经获得各个木头的数量
    todayCutNum.sm:今天已经获得【松木】的数量
    todayCutNum.hx:今天已经获得【红橡】的数量
    todayCutNum.zt:今天已经获得【紫檀】的数量
    
    { "woodConfig": [ { "name": "松木", "dayMax": 10, "cutTimes": 2 }, { "name": "红橡", "dayMax": 11, "cutTimes": 4 }, { "name": "紫檀", "dayMax": 12, "cutTimes": 6 } ], "exhibitImageRootUrl": "http://ljyxhj.xyz/lumber/resources/show/", "exhibit": [["10001", "高脚凳1", [{"key": "hx", "value": 10}, {"key": "sm", "value": 10}], "gray/stool1.png", "bright/stool1.png", "lighting/stool1.png"],["10002", "高脚凳2", [{"key": "hx", "value": 10}, {"key": "sm", "value": 10}], "gray/stool2.png", "bright/stool2.png", "lighting/stool2.png"],["10003", "高脚凳3", [{"key": "hx", "value": 10}, {"key": "sm", "value": 10}], "gray/stool3.png", "bright/stool3.png", "lighting/stool3.png"],["20001", "餐桌1", [{"key": "hx", "value": 10}, {"key": "sm", "value": 10}], "gray/table1.png", "bright/table1.png", "lighting/table1.png"],["20002", "餐桌2", [{"key": "hx", "value": 10}, {"key": "sm", "value": 10}], "gray/table2.png", "bright/table2.png", "lighting/table2.png"],["20003", "餐桌3", [{"key": "hx", "value": 10}, {"key": "sm", "value": 10}], "gray/table3.png", "bright/table3.png", "lighting/table3.png"],["30001", "衣柜1", [{"key": "hx", "value": 10}, {"key": "sm", "value": 10}], "gray/cabinet1.png", "bright/cabinet1.png", "lighting/cabinet1.png"],["30002", "衣柜2", [{"key": "hx", "value": 10}, {"key": "sm", "value": 10}], "gray/cabinet2.png", "bright/cabinet2.png", "lighting/cabinet2.png"],["30003", "衣柜3", [{"key": "hx", "value": 10}, {"key": "sm", "value": 10}], "gray/cabinet3.png", "bright/cabinet3.png", "lighting/cabinet3.png"],["40001", "实木床1", [{"key": "hx", "value": 10}, {"key": "sm", "value": 10}], "gray/bed1.png", "bright/bed1.png", "lighting/bed1.png"],["40002", "实木床2", [{"key": "hx", "value": 10}, {"key": "sm", "value": 10}], "gray/bed2.png", "bright/bed2.png", "lighting/bed2.png"],["40003", "实木床3", [{"key": "hx", "value": 10}, {"key": "sm", "value": 10}], "gray/bed3.png", "bright/bed3.png", "lighting/bed3.png"] ], "netErrorSecondTime": 2,"userData": { "smNum": 0, "hxNum": 0, "ztNum": 0, "exhibitHad": { "10001": 0 }, "todayCutNum": { "sm": 10, "hx": 10, "zt": 10 }}}
    

    参数2:健腹轮发生移动时,通知游戏进行更新,推push,拉pull

    {"data":[{"Type": "push"}]}
    

    参数3 展览进行兑换时将游戏内的数据通知APP

    {
        "exchangeId": 10001//发起兑换的id
    }
    

    参数4
    发起展览物兑换的请求回调
    成功回调

    {
      "result": 1
    }
    

    失败回调,前端会进行兑换限制、如果失败、即前后端数据不一致、重新进行数据校准

    {
      "result": 0,
      "userData":{
          //与参数1里userData一致
      }
    }
    

    参数5

     {
          "addHxNum": 100, //获得红橡的数量,目前一次只能获得一种木材,所以此字段可能会不存在
          "addSmNum": 100, //获得松木的数量,目前一次只能获得一种木材,所以此字段可能会不存在
          "addZtNum": 100, //获得紫檀的数量,目前一次只能获得一种木材,所以此字段可能会不存在
          "startTime" : 1692236174826,//游戏开始时间,毫秒时间戳
          "endTime" : 1692236175250//游戏结束时间,毫秒时间戳
          "gameTime" : 86400//玩家游玩时间,毫秒
      }
    

    三、异常定义

    异常定义
    错误码 说明
    0 正常
    201 网络错误

    相关文章

      网友评论

          本文标题:游戏接入文档

          本文链接:https://www.haomeiwen.com/subject/hywkgdtx.html