Puerts Starter Kit

screenshot of Puerts Starter Kit

puerts unity 项目手脚架

Overview:

Unity Puerts is a starter project that utilizes the puerts library in a Unity empty project. It provides a scaffold for TypeScript compilation and debugging tools, IDE configuration, and a compatible web API layer. The project does not include any game frameworks but offers optimized Console API for Unity. It also supports commonly used web APIs and has basic unit testing functionality. The project uses Webpack for script building and defaults to using ESBuild for code compilation in development mode. It also supports features such as source maps, VSCode debugging, and can be easily published on platforms like WebGL, WeChat mini-games, and TikTok mini-games using the puerts-webgl solution. The installation process requires basic knowledge of Unity, TypeScript/JavaScript, NodeJS, and npm/yarn.

Features:

  • Basic Unit Testing: Provides simple unit testing functionality.
  • Commonly Used WebAPI Functionalities: Implements commonly used web API functionalities.
  • Webpack Script Building: Uses Webpack for script building.
  • ESBuild for Code Compilation: Defaults to using ESBuild for code compilation in development mode.
  • Code Obfuscation and Compression: Supports code obfuscation and compression when publishing.
  • Source Maps and VSCode Debugging Support: Configured with Source Maps and provides VSCode debugging support.
  • Out-of-the-box Platform Support: Supports publishing on platforms such as WebGL, WeChat mini-games, and TikTok mini-games using the puerts-webgl solution.

Summary:

Unity Puerts is a starter project that provides a scaffold for developing Unity games with TypeScript. It utilizes the puerts library and offers features such as basic unit testing, commonly used web API functionalities, Webpack script building, ESBuild code compilation, code obfuscation and compression, source maps, and VSCode debugging support. The project supports publishing on various platforms like WebGL, WeChat mini-games, and TikTok mini-games using the puerts-webgl solution. Installation requires knowledge of Unity, TypeScript/JavaScript, NodeJS, and npm/yarn.

eslint
Eslint

ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.

typescript
Typescript

TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.

webpack
Webpack

Webpack is a popular open-source module bundler for JavaScript applications that bundles and optimizes the code and its dependencies for production-ready deployment. It can also be used to transform other types of assets such as CSS, images, and fonts.