# puerts

**Repository Path**: mingzhangok/puerts

## Basic Information

- **Project Name**: puerts
- **Description**: 在UE4或Unity中使用TypeScript编写游戏。Puerts可以读作puerh TS（普洱TS）
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2023-12-25
- **Last Updated**: 2024-06-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

![Logo](./doc/pic/puerts_logo.png)

[![license](https://img.shields.io/badge/license-BSD_3_Clause-blue.svg)](https://github.com/Tencent/puerts/blob/master/LICENSE)
[![unreal](https://img.shields.io/badge/unreal-v1.0.1-blue.svg)](https://github.com/Tencent/puerts/releases/tag/Unreal_v1.0.1)
[![unity](https://img.shields.io/badge/unity-v1.3.8-blue.svg)](doc/unity/zhcn/install.md)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-blue.svg)](https://github.com/Tencent/puerts/pulls)
![CI](https://github.com/Tencent/puerts/workflows/CI/badge.svg)

## What？
 
PuerTS is a TypeScript programming solution within game engines. | PuerTS是游戏引擎下的TypeScript编程解决方案
* provides a JavaScript Runtime | 提供了一个JavaScript运行时

* allows TypeScript to access the host engine by including: | 提供通过TypeScript访问宿主引擎的能力，包括:
  * module-binding on the JavaScript level | JavaScript层面的绑定
  * TypeScript declarations generation | TypeScript声明文件生成


## Why?

* Facililates game building processes by combining JavaScript ecosystem with the rendering power of professional game engines
* JavaScript生态有众多的库和工具链，结合专业商业引擎的渲染能力，快速打造游戏

> 

* In contrast to lua script, TypeScript supports static type checking, which significantly improves code robustness and maintainability.
* 相比游戏领域常用的lua脚本，TypeScript的静态类型检查有助于编写更健壮，可维护性更好的程序

> 

* High efficiency: supports reflection binding throughout the platform (engine) - no extra steps (code generation) needed for development.
* 高效：全引擎，全平台支持反射Binding，无需额外（生成代码）步骤即可开发

> 

* High performance：supports static binding throughout the platform (engine) - takes care of complex scenes
* 高性能：全引擎，全平台支持静态Binding，兼顾了高性能的场景

> 

* Talented WebGL Support: huge advantage in performance and dev efficiency compare to Lua.
* WebGL平台下的天生优势：相比Lua脚本在WebGL版本的表现，在性能和效率上都有极大提升。

---

## Documentation | 官方文档

* [Doc for Unity](https://puerts.github.io/unity/en/readme) | [Unity版文档](https://puerts.github.io/unity/zhcn/readme)
* [Doc for UE](https://puerts.github.io/unreal/en/readme) | [UE版文档](https://puerts.github.io/unreal/zhcn/readme)

## FAQ | 常见问题

* [general faq](doc/faq.md)
* [unreal faq](doc/unreal/zhcn/faq.md)
* [unity faq](doc/unity/zhcn/faq.md)

---

## How to Install | 最新版本安装

* [unreal](doc/unreal/zhcn/install.md)
* [unity](doc/unity/en/install.md)

### Changelog

* [unreal](doc/unreal/zhcn/changelog.md)
* [unity](doc/unity/zhcn/changelog.md)

### Known issues | 已知问题与解决办法

* [unreal](doc/unreal/zhcn/bugs.md)
* [unity](doc/unity/zhcn/bugs.md)

---

## Avaliable on these Engine | 引擎

* unreal engine 4.22 ~ latest

* unity 5 ~ latest

## Available on these Platform | 平台

* iOS，Android，Windows，Macos

* 任意.net环境 | Any .net project


## Ask for help | 技术支持

[Github Discussion](https://github.com/Tencent/puerts/discussions)

QQ群：942696334

UE4专属群：689643903

## 开发博客
[知乎专栏](https://www.zhihu.com/column/c_1355534112468402176)