{"id":13480569,"url":"https://github.com/Tencent/puerts","last_synced_at":"2025-03-27T11:30:32.842Z","repository":{"id":36958078,"uuid":"287706896","full_name":"Tencent/puerts","owner":"Tencent","description":"PUER(普洱) Typescript. Let's write your game in UE or Unity with TypeScript.","archived":false,"fork":false,"pushed_at":"2024-10-29T07:18:59.000Z","size":314208,"stargazers_count":5046,"open_issues_count":236,"forks_count":702,"subscribers_count":86,"default_branch":"master","last_synced_at":"2024-10-29T15:17:30.551Z","etag":null,"topics":["dotnet","javascript","nodejs","quickjs","typescript","unity","unrealengine","v8"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Tencent.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-08-15T08:20:44.000Z","updated_at":"2024-10-29T07:19:04.000Z","dependencies_parsed_at":"2023-11-15T03:27:22.017Z","dependency_job_id":"5bb7c212-4a70-4298-bff3-153a80f949a6","html_url":"https://github.com/Tencent/puerts","commit_stats":{"total_commits":3255,"total_committers":124,"mean_commits":26.25,"dds":"0.42949308755760374","last_synced_commit":"2cde5c6c1bde9b024c0390aea98b151702acbb17"},"previous_names":[],"tags_count":149,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tencent%2Fpuerts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tencent%2Fpuerts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tencent%2Fpuerts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tencent%2Fpuerts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Tencent","download_url":"https://codeload.github.com/Tencent/puerts/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245543427,"owners_count":20632648,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dotnet","javascript","nodejs","quickjs","typescript","unity","unrealengine","v8"],"created_at":"2024-07-31T17:00:41.564Z","updated_at":"2025-03-27T11:30:32.835Z","avatar_url":"https://github.com/Tencent.png","language":"C++","readme":"![Logo](./doc/pic/puerts_logo.png)\n\n[![license](https://img.shields.io/badge/license-BSD_3_Clause-blue.svg)](https://github.com/Tencent/puerts/blob/master/LICENSE)\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-blue.svg)](https://github.com/Tencent/puerts/pulls)\n\n[![unreal](https://img.shields.io/badge/unreal-v1.0.8-blue.svg)](https://github.com/Tencent/puerts/releases/tag/Unreal_v1.0.8)\n\n[![unity](https://img.shields.io/badge/unity(stable)-v2.2.0-blue.svg)](doc/unity/zhcn/install.md)\n![Unity_Test](https://github.com/Tencent/puerts/workflows/unity%20unittest/badge.svg)\n\n[跳转中文](#what---普洱ts是什么)\n\n## WHAT is PuerTS (PUER Typescript)?\n \n`PuerTS` is a TypeScript programming solution in Unity/Unreal/DotNet.\n* provides a JavaScript Runtime.\n* allows TypeScript to access the host engine with the help of TypeScript declarations generation.\n\n## WHY should I use PuerTS?\n\n* Facilitates game-building processes by combining JavaScript/Node.js ecosystem and professional game engines\n* In contrast to Lua script, TypeScript supports static type checking, which significantly improves code robustness and maintainability.\n* High efficiency: supports reflection call throughout the host - no extra steps needed for interop with C++/C#.\n* High performance: supports static wrapper generation - handles complex scenes with high-performance demands.\n* Talented WebGL Support: massive advantage in performance and dev efficiency compared to Lua, even faster than pure C# in some cases.\n\n## HOW can I start to use PuerTS\n[Documentation](https://puerts.github.io/en)\n\n---\n\n## FAQ\n\n* [general faq](doc/faq.md)\n* [unreal faq](doc/unreal/en/faq.md)\n* [unity faq](doc/unity/en/faq.md)\n\n## How to Install\n\n* [unreal](doc/unreal/en/install.md)\n* [unity](doc/unity/en/install.md)\n\n### Changelog\n\n* [unreal](doc/unreal/en/changelog.md)\n* [unity](unity/Assets/core/upm/changelog.md)\n\n### Known issues\n\n* [unreal](doc/unreal/en/bugs.md)\n* [unity](doc/unity/en/bugs.md)\n\n---\n\n## Select Script Engine\n\nCurrently puerts supports three script engines: v8, quickjs, nodejs, choose the one that suits you.\n\n* V8 (default): Generally excellent performance, moderate code size, only includes the implementation of the ECMAScript specification, does not include Node.js API or browser API.\n\n* QuickJS: Performance is not as good as V8, does not support debugging, but has a small code size, suitable for scenarios where code size is critical.\n\n* Node.js: Supports Node.js API (OpenSSL-related APIs are not supported on Unreal Engine's mobile platform), but has a larger code size.\n\n\n| Script Engine | Node api | Performance | Code Size | Debugging | Notes |\n| --- | --- | --- | --- | --- | --- |\n| V8 | ❌ | `*****` | `***` | ✔️ | |\n| QuickJS | ❌ | `**` | `*` | ❌ | |\n| Node.js | ✔️ | `*****` | `*****` | ✔️ | OpenSSL may be disabled |\n\n## Avaliable on these Engine\n\n* unreal engine 4.22 ~ latest\n\n* unity 5 ~ latest\n\n* Any .net project\n\n## Available on these Platform\n\n* iOS\n* Android\n* OpenHarmony\n* Windows\n* Macos\n\n\n## Ask for help\n\n[Github Discussion](https://github.com/Tencent/puerts/discussions)\n\n------\n\n## WHAT - 普洱TS是什么?\nPuerTS是 Unity/Unreal/Dotnet 下的TypeScript编程解决方案\n\n* 提供了一个JavaScript运行时\n* 提供TypeScript声明文件生成能力，易于通过TypeScript访问宿主引擎，\n\n\n## WHY - 为什么我该用普洱TS?\n\n* JavaScript生态有众多的库和工具链，结合专业商业引擎的渲染能力，快速打造游戏\n* 相比游戏领域常用的lua脚本，TypeScript的静态类型检查有助于编写更健壮，可维护性更好的程序\n* 高效：全引擎，全平台支持反射调用，无需额外步骤即可与宿主C++/C#通信。\n* 高性能：全引擎，全平台支持生成静态调用桥梁，兼顾了高性能的场景。\n* WebGL平台下的天生优势：相比Lua脚本在WebGL版本的表现，PuerTS在性能和效率上都有极大提升，目前极限情况甚至比C#更快。\n\n## HOW - 我该怎么开始\n\n* [官方文档](https://puerts.github.io)\n\n---\n\n\n## 常见问题\n\n* [通用 faq](doc/faq.md)\n* [unreal faq](doc/unreal/zhcn/faq.md)\n* [unity faq](doc/unity/zhcn/faq.md)\n\n## 最新版本安装\n\n* [unreal](doc/unreal/zhcn/install.md)\n* [unity](doc/unity/zhcn/install.md)\n\n### 改动日志\n\n* [unreal](doc/unreal/zhcn/changelog.md)\n* [unity](unity/Assets/core/upm/changelog-hans.md)\n\n### 已知问题与解决办法\n\n* [unreal](doc/unreal/zhcn/bugs.md)\n* [unity](doc/unity/zhcn/bugs.md)\n\n---\n\n## 脚本引擎选择\n\n目前puerts支持三种脚本引擎：v8、quickjs、nodejs，选择合适你的那个。\n\n* v8（默认）：综合比较优秀，高性能，代码体积适中，仅包含ecmascript规范的实现，不包含nodejs api、浏览器 api\n\n* quickjs： 性能不如v8，不支持调试，但代码体积小，适用于代码段大小敏感型业务\n\n* nodejs：支持nodejs api（unreal engine的移动平台下不支持openssl相关api），代码体积较大\n\n| 脚本引擎 | Node api | 性能 | 代码体积 | 调试 | 补充 |\n| --- | --- | --- | --- | --- | --- |\n| V8 | ❌ | `*****` | `***` | ✔️ | |\n| QuickJS | ❌ | `**` | `*` | ❌ | |\n| Node.js | ✔️ | `*****` | `*****` | ✔️ | OpenSSL 可能被禁用 |\n\n## 可用引擎\n\n* unreal engine 4.22 ~ latest\n\n* unity 5 ~ latest\n\n* 任意.net环境\n\n## 可用平台\n\n* iOS\n* Android\n* 鸿蒙（OpenHarmony）\n* Windows\n* Macos\n\n\n## 技术支持\n\n[Github Discussion](https://github.com/Tencent/puerts/discussions)\n\nQQ群：942696334\n\nUE4专属群：689643903\n\n## 开发博客\n[知乎专栏](https://www.zhihu.com/column/c_1355534112468402176)\n","funding_links":[],"categories":["C++","Scripting","Open Source Repositories"],"sub_categories":["Scriptings"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTencent%2Fpuerts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FTencent%2Fpuerts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTencent%2Fpuerts/lists"}