Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dawnarc/puertsgame

PuerTS example to demonstrate shooting and RPC in Unreal Engine 4.
https://github.com/dawnarc/puertsgame

debug example intellij-idea rpc shooting typescript ue4 unrealengine4

Last synced: 4 months ago
JSON representation

PuerTS example to demonstrate shooting and RPC in Unreal Engine 4.

Host: GitHub
URL: https://github.com/dawnarc/puertsgame
Owner: dawnarc
License: mit
Created: 2021-11-20T15:25:42.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2024-05-01T08:35:16.000Z (9 months ago)
Last Synced: 2024-10-09T18:40:16.713Z (4 months ago)
Topics: debug, example, intellij-idea, rpc, shooting, typescript, ue4, unrealengine4
Language: TypeScript
Homepage:
Size: 5.73 MB
Stars: 26
Watchers: 2
Forks: 6
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Branches Introduction

+ `main`: the newest content of this example.

+ `rpc`: implement shooting and `RPC` logic.

+ `shooting`: implement basic shooting logic only.

# Summary

[PuerTS](https://github.com/Tencent/puerts) is a high performance script system for Unity and Unreal that founded by [chexiongsheng](https://github.com/chexiongsheng).

This repository is the personal study note referenced to author's tutorial, since there're some issues haven't been mentioned in origin documents.

Official tutorial:

跟我用TypeScript做一个FPS游戏  

https://zhuanlan.zhihu.com/p/346531865

Showcase  

![screenshoots01](./docs/screenshoots/screenshoot_1.gif)

***

# Setup

+ Install Unreal Engine 4.

+ Install nodejs: https://nodejs.org/en/download/  

Check the option `Automatically install the necessary tools.` at the ending of installation.

![screenshoots02](./docs/screenshoots/screenshoot_1_2.png)

+ Clone puerts from https://github.com/Tencent/puerts

+ Copy directory `puerts/unreal/Puerts/` into this project:`PuertsGame/Plugins/Puerts/`.

+ Open cmd and address to directory `PuertsGame/Plugins/Puerts/`, execute command:

    

        node enable_puerts_module.js

    

+ Bulid from visual studio, and start editor, then click plugin button `ud.d.ts`:  

![screenshoots02](./docs/screenshoots/screenshoot_2.png)

+ If can't find `TS_BaseGun`, `TS_Player` and `TS_Rifle` in directory `PuertsGame/Blueprints/TypeScript/`, which were generated by `PuerTS`, in editor content browser.  

![screenshoots03](./docs/screenshoots/screenshoot_3.png)  

You need to fire hot compilcation by adding empty line in TypeScript source file.  

![screenshoots04](./docs/screenshoots/screenshoot_4.png)  

If add a blank line and save file, log would output that TypeScript source has been re-compiled:  

![screenshoots05](./docs/screenshoots/screenshoot_5.png)  

Then `PuerTS` would auto compile this TypeScript source and auto generate Unreal `.uasset` file under directory `PuertsGame/Blueprints/TypeScript/`.  

+ Set `GameMode` and `Default Pawn Class` in World Settings panel:  

![screenshoots05](./docs/screenshoots/screenshoot_5-1.png)  

***

# Debug in IntelliJ IDEA

+ UE4Editor -> Edit -> Project Settings -> Plugins -> Puerts Settings -> Enable `Debug Mode`, and set `Debug Port` as an unoccupied port (`8889` recommended).  

![screenshoots06](./docs/screenshoots/screenshoot_6.png)

+ IntelliJ IDEA -> Run -> Edit Configurations  

![screenshoots07](./docs/screenshoots/screenshoot_7.png)

+ Add New Configuration -> Attach to Node.js / Chrome  

![screenshoots08](./docs/screenshoots/screenshoot_8.png)

+ Set `Port` as the same as UE4Editor settings (`8889`)  

![screenshoots09](./docs/screenshoots/screenshoot_9.png)

+ Re-startup UE4Editor at first time.

+ Debug TypeScript in IntelliJ IDEA:  

![screenshoots10](./docs/screenshoots/screenshoot_10.png)

+ Play game in UE4Editor.

+ Then breakpoints in IntelliJ IDEA would be hit, and you can watch variables values:  

![screenshoots11](./docs/screenshoots/screenshoot_11.png)

***

# RPC

To enable RPC, add `"experimentalDecorators": true` in `PuertsGame/tsconfig.json`:

    {

        "compilerOptions": {

            "target": "esnext",

            "module": "commonjs",

            "experimentalDecorators": true,

            "jsx": "react",

            "sourceMap": true,

            "typeRoots": [

                "Plugins/Puerts/Typing",

                "./node_modules/@types"

            ],

            "outDir": "Content/JavaScript"

        },

        "include": [

            "TypeScript/**/*"

        ]

    }

Otherwise you would get warning:

    Error D:/PuertsGame/TypeScript/TS_Player.ts (101,5): Experimental support for decorators is a feature that is subject to change in a future release. Set the 'experimentalDecorators' option to remove this warning.

Open `BP_Target`.  

![screenshoots11](./docs/screenshoots/screenshoot_12.png)

Check `Replicates` in Detail panels.  

![screenshoots11](./docs/screenshoots/screenshoot_13.png)

Check `Replicates` in Detail panels.  

Then select `CubeMesh` of `BP_Target`, and check `Component Replicates`.  

![screenshoots11](./docs/screenshoots/screenshoot_14.png)

![screenshoots11](./docs/screenshoots/screenshoot_15.png)

Select property `Health` of `BP_Target`, then set Replication as `RepNotify`.  

![screenshoots11](./docs/screenshoots/screenshoot_16.png)

Implement function `On Rep Health` which was generated by Blueprint.  

![screenshoots11](./docs/screenshoots/screenshoot_17.png)

Remove node `Update Color` in function `Take Damage`.  

![screenshoots11](./docs/screenshoots/screenshoot_18.png)

Select `Net Mode` of `Multiplayer Options` as `Play as Client`.  

![screenshoots11](./docs/screenshoots/screenshoot_19.png)

Now you can run game with RPC demonstration.

# Package

## Issues 1

Project Settings -> Packaging -> Additional Non-Asset Directories To Copy -> Add directory `JavaScript`.

![screenshoots11](./docs/screenshoots/screenshoot_20.png)

Otherwise, you would get error on startup:

    Puerts: Error: (0x00000228FF6B3BF0) can not find [puerts/first_run.js]

    Puerts: Error: (0x00000228FF6B3BF0) can not find [puerts/polyfill.js]

    Puerts: Error: (0x00000228FF6B3BF0) can not find [puerts/log.js]

    Puerts: Error: (0x00000228FF6B3BF0) can not find [puerts/modular.js]

    Puerts: Error: (0x00000228FF6B3BF0) can not find [puerts/uelazyload.js]

    Puerts: Error: (0x00000228FF6B3BF0) can not find [puerts/events.js]

    Puerts: Error: (0x00000228FF6B3BF0) can not find [puerts/promises.js]

    Puerts: Error: (0x00000228FF6B3BF0) can not find [puerts/argv.js]

    Puerts: Error: (0x00000228FF6B3BF0) can not find [puerts/jit_stub.js]

    Puerts: Error: (0x00000228FF6B3BF0) can not find [puerts/hot_reload.js]

## Issues 2

Don't load object in Constructor since there are some limits in Unreal.

    Constructor() 

    {

        this.PS_BulletImpact = UE.ParticleSystem.Load("/Game/BlockBreaker/ParticleSystems/PS_BulletImpact");

    }

Otherwise, you would get error on startup:

    Assertion failed: AsyncLoadingThread.RecursionNotAllowed.Increment() == 1 [File:D:/Build/++UE4/Sync/Engine/Source/Runtime/CoreUObject/Private/Serialization/AsyncLoading.cpp] [Line: 3992] 

Alteration: load object in `ReceiveBeginPlay`:

    ReceiveBeginPlay(): void

    {

        this.PS_BulletImpact = UE.ParticleSystem.Load("/Game/BlockBreaker/ParticleSystems/PS_BulletImpact");

    }