3 Star 9 Fork 5

yhh / mini-game-utils

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

game-utils 游戏支持库

该库涵盖两部分

  • api库(包含微信小游戏,QQ小游戏,头条小游戏,vivo小游戏的sdk定义)可直接调用进行使用

    文件名 介绍
    platform_basic.d.ts 基础api
    platform_render.d.ts 渲染api
    platform_ad.d.ts 广告api
    platform_interface.d.ts 界面api
    platform_open.d.ts 开放接口api
  • et库(包含常用的游戏辅助类及一些高级扩展方法)

适用范围

支持引擎

  • egret
  • cocos
  • laya
  • pixi

支持小游戏

  • 微信小游戏
  • QQ小游戏
  • 头条小游戏
  • vivo小游戏

如何使用

初始化核心类 et.app

  • 自动处理 切换后台/返回前台 事件
  • 自动处理 文本框黑色 问题
var app = new et.app();
app.init(this.stage);

资源管理

// 预加载资源组(这里只是预先把需要加载的资源缓存起来)
et.egretRes.pushRes("preload", (event: egret.Event)=>{
    // TODO: 资源进度通知事件
    console.log("资源进度:" + Math.round(event.itemsLoaded / event.itemsTotal * 100) + "%", event.groupName);
}, (event: egret.Event)=>{
    // TODO: 资源加载完成事件
}, (event: egret.Event)=>{
    // TODO: 资源加错报错事件
    // 可无需写该方法 框架自动处理
});

// 也可直接这么加载资源
et.egretRes.pushRes("common");

// 开始加载资源(这里才是真正开始加载资源)
// true: 加载完成后从资源缓存列表移除
et.egretRes.loadRes(true);

初始化游戏信息

// 为微信平台创建游戏信息
let appInfo = new et.AppInfo(et.Platform.Wxgame);
appInfo.appId = "您的appid";
appInfo.bannerId = "您的bannerId";
appInfo.videoId = "您的激励视频Id";
// 使用上面核心类
et.app.instance.initApp(appInfo);

显示banner广告

// 需要为平台创建游戏信息后才可以显示
await et.app.instance.showBannerAd();

小游戏API

所有小游戏无需关注命名空间,可一份代码发布到多个平台。命名空间全部调整为api

以下为各个平台示例最终输出的api,快速方便

// wx.getSystemInfoSync() 微信小游戏写法
// qq.getSystemInfoSync() QQ小游戏写法
// tt.getSystemInfoSync() 头条小游戏写法
// qg.getSystemInfoSync() 快应用小游戏写法(vivo/oppo/小米)
let systemInfo = api.getSystemInfoSync();	// 只需要使用api命名空间即可调用这些

目前支持API

为了方便查找是否支持,进行分库处理

注意: 以下只用于查询微信平台、别的平台暂未支持

基础库
api名称 是否支持
getSystemInfoSync 完全支持
getSytemInfo 完全支持
getUpdateManager 完全支持
onShow 完全支持
onHide 完全支持
offShow 完全支持
offHide 完全支持
getLaunchOptionsSync 完全支持
exitMiniProgram 完全支持
onError 完全支持
onAudioInterruptionEnd 完全支持
onAudioInterruptionBegin 完全支持
offError 完全支持
offAudioInterruptionEnd 完全支持
offAudioInterruptionBegin 完全支持
onTouchStart 完全支持
onTouchMove 完全支持
onTouchEnd 完全支持
onTouchCancel 完全支持
offTouchStart 完全支持
offTouchMove 完全支持
offTouchEnd 完全支持
offTouchCancel 完全支持
triggerGC 完全支持
markScene 完全支持
getPerformance 完全支持
loadSubpackage 完全支持
setEnableDebug 完全支持
getLogManager 完全支持
console 完全支持
LogManager 完全支持
clearInterval 完全支持
clearTimeout 完全支持
setInterval 完全支持
setTimeout 完全支持
渲染库
createCanvas 完全支持
Canvas 完全支持
RenderingContext 完全支持
wxBindCanvasTexture 引擎提供
setPreferredFramesPerSecond 完全支持
cancelAnimationFrame 完全支持
requestAnimationFrame 完全支持
loadFont 完全支持
getTextLineHeight 完全支持
createImage 完全支持
Image 完全支持
  • 广告库
createRewardedVideoAd 完全支持
createInterstitialAd 完全支持
createBannerAd 完全支持
BannerAd 完全支持
InterstitialAd 完全支持
RewardedVideoAd 完全支持
  • 界面库
showToast 完全支持
showModal 完全支持
showLoading 完全支持
showActionSheet 完全支持
hideToast 完全支持
hideLoading 完全支持
updateKeyboard 完全支持
showKeyboard 完全支持
onKeyboardInput 完全支持
onKeyboardConfirm 完全支持
onKeyboardComplete 完全支持
offKeyboardInput 完全支持
offKeyboardConfirm 完全支持
offKeyboardComplete 完全支持
hideKeyboard 完全支持
setMenuStyle 完全支持
getMenuButtonBoundingClientRect 完全支持
onWindowResize 完全支持
offWindowResize 完全支持
  • 网络库
request 完全支持
RequestTask 完全支持
downloadFile 完全支持
DownloadTask 完全支持
uploadFile 完全支持
UploadTask 完全支持
WebSocket 不支持
UDP通信 不支持
  • 开放接口库
navigateToMiniProgram 完全支持
getUserInfo 完全支持
getUserGameLabel 完全支持
createUserInfoButton 完全支持
UserInfo 完全支持
UserInfoButton 完全支持
login 完全支持
checkSession 完全支持
authorize 完全支持
shareMessageToFriend 完全支持
setUserCloudStorage 完全支持
removeUserCloudStorage 完全支持
onInteractiveStorageModified 完全支持
modifyFriendInteractiveStorage 完全支持
getUserInteractiveStorage 不支持
getUserCloudStorage 不支持
getSharedCanvas 不支持
getPointialFriendList 不支持
getGroupCloudStorage 不支持
getFriendCloudStorage 不支持
FriendInfo 不支持
KVData 完全支持
UserGameData 不支持
onMessage 不支持
getOpenDataContext 不支持
OpenDataContext 不支持
checkIsUserAdvisedToRest 不支持
createFeedbackButton 不支持
FeedBackButton 不支持
openSetting 不支持
getSetting 不支持
createOpenSettingButton 不支持
AuthSetting 不支持
OpenSettingButton 不支持
createGameClubButton 不支持
GameClubButton 不支持
openCustomerServiceConversation 不支持
getWeRunData 不支持
openCard 不支持
addCard 不支持
reportMonitor 不支持
requestSubscribeSystemMessage 不支持
requestSubscribeMessage 不支持
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

用于微信小游戏、QQ小游戏、头条小游戏、vivo小游戏的辅助库 展开 收起
TypeScript
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
TypeScript
1
https://gitee.com/clengine/egret-utils.git
git@gitee.com:clengine/egret-utils.git
clengine
egret-utils
mini-game-utils
master

搜索帮助