Tuanjie Engine

https://docs.unity.cn/cn/tuanjiemanual/Manual
Admin
Tuanjie Engine is the Unity China version engine, based on Unity 2022 LTS, offering solutions for...
Tokens:1,107,899
Snippets:14,738
Trust Score:9.8
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install Example Project on macOS

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/InstallingUnity.html

Install the example project to the /Users/Shared/Tuanjie/Standard-Assets folder on the specified volume.

```bash
sudo installer [-dumplog] -package Examples.pkg -target /
```

--------------------------------

### Install Example Project Silently on Windows

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/InstallingUnity.html

Use this command for a silent installation of the example project. The default directory is `C:\Users\Public\Documentation\Unity Projects\Standard Assets Example Project`.

```bash
UnityExampleProjectSetup.exe /S /D=E:\Development\Unity
```

--------------------------------

### Example: Create License Request File (Windows)

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/ManualActivationCmdWin.html

An example command demonstrating the creation of a license request file for a specific Unity Editor version and installation path.

```bash
"C:\Program Files\Unity\Hub\Editor\2022.2.0b4\Editor\Unity.exe" -batchmode -createManualActivationFile -logfile
```

--------------------------------

### Example Unity License Activation

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/ManualActivationCmdWin.html

This is a concrete example of the manual license activation command. It assumes a specific Unity Editor version and installation path, along with a user-defined path for the .ulf license file.

```bash
"C:\Program Files\Unity\Hub\Editor\2022.2.0b4\Editor\Unity.exe" -batchmode -manualLicenseFile "C:\Users\myAccount\Downloads\Unity_v2017.x.ulf" -logfile

```

--------------------------------

### Example: Create Manual Activation File on macOS

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/ManualActivationCmdMac.html

This is a concrete example of the command to create a manual activation file on macOS, using a specific editor version and installation path. The generated .alf file will be saved in the directory where this command is executed.

```bash
/Applications/Tuanjie/Hub/Editor/2022.2.0b4/Tuanjie.app/Contents/MacOS/Tuanjie -batchmode -createManualActivationFile -logfile

```

--------------------------------

### QNX Application Startup Timing Logs

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/qnx-install-player.html

Example log output showing application startup timings, including real and user time.

```text
[TIMING::STARTUP] Initial probing done: Real: 19 ms | User: 11 ms
[TIMING::STARTUP] SDL Initialized: Real: 64 ms | User: 54 ms
[TIMING::STARTUP] Scripting runtime loaded: Real: 97 ms | User: 86 ms
[TIMING::STARTUP] Plugins loaded: Real: 97 ms | User: 87 ms
[TIMING::STARTUP] Engine initialized (nogfx): Real: 104 ms | User: 94 ms
[TIMING::STARTUP] Player Prefs loaded: Real: 104 ms | User: 94 ms
[TIMING::STARTUP] Screen initialized: Real: 139 ms | User: 112 ms
[TIMING::STARTUP] Engine initialized (gfx): Real: 187 ms | User: 161 ms
[TIMING::STARTUP] Gfx initialized: Real: 190 ms | User: 163 ms
[TIMING::STARTUP] Input initialized: Real: 190 ms | User: 163 ms
[TIMING::STARTUP] SPLASH - Begin: Real: 190 ms | User: 164 ms
[TIMING::STARTUP] SPLASH - Primary scene assets loaded (async): Real: 2197 ms | User: 1670 ms
[TIMING::STARTUP] SPLASH - All engine initial states established: Real: 2197 ms | User: 1670 ms
[TIMING::FRAME] 60 fps
[TIMING::FRAME] 58 fps
[TIMING::FRAME] 59 fps

```

--------------------------------

### Incorrect Argument Formatting Example

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/openharmony-specify-command-line.html

This example shows the incorrect way to pass an argument starting with a hyphen, which may lead to it being recognized as an option.

```bash
 hdc shell aa start -a TuanjiePlayerAbility -b com.Company.MyGame --ps unity "-force-vulkan"
```

--------------------------------

### Display All Unity Accelerator Help Topics

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/UnityAccelerator.html

Use the --all-help flag to output all available command-line options and their descriptions. It is recommended to pipe this output to 'less' or redirect it to a file for easier reading.

```bash
unity-accelerator --all-help
```

--------------------------------

### Example Request JSON for Raw Data Export

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/UnityAnalyticsRawDataExport.html

Example JSON payload for creating a raw data export. Specifies start date, end date, format (tsv), and dataset (appStart).

```json
{ "startDate": "2016-05-15" , "endDate": "2016-05-16", "format": "tsv", "dataset": "appStart" }
```

--------------------------------

### Example Package Asset Path

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/upm-assets.html

An example demonstrating the full path to an image file within a specific package and subfolder.

```text
Packages/com.unity.images-library/Example/Images/image.png
```

--------------------------------

### Create Directory Example

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/qnx-qconnclient.html

Example of using QconnClient to create a directory on a remote QNX machine, specifying IP, log file, and timeout.

```bash
QconnClient.exe --ip=127.0.0.1 --logfile=C:/mylog/qconnclient_log.txt --time=3000 mkdir /data/home/root/test
```

--------------------------------

### Configure Build Profile for DevHost

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/webglhost.html

Configure the Build Profile for DevHost according to the quick start guide. This step is crucial for setting up your mini-game build.

```csharp
Configure DevHost Build Profile in the Inspector.
```

--------------------------------

### Initialize Unity IAP with IStoreListener

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/UnityIAPInitialization.html

Implement the IStoreListener interface and call UnityPurchasing.Initialize to start the IAP process. This setup is crucial for receiving purchase-related events.

```csharp
using UnityEngine;
using UnityEngine.Purchasing;

public class MyIAPManager : IStoreListener {

    private IStoreController controller;
    private IExtensionProvider extensions;

    public MyIAPManager () {
        var builder = ConfigurationBuilder.Instance(StandardPurchasingModule.Instance());
        builder.AddProduct("100_gold_coins", ProductType.Consumable, new IDs
        {
            {"100_gold_coins_google", GooglePlay.Name},
            {"100_gold_coins_mac", MacAppStore.Name}
        });

        UnityPurchasing.Initialize (this, builder);
    }

    /// <summary>
    /// Unity IAP 准备好可以进行购买时调用。
    /// </summary>
    public void OnInitialized (IStoreController controller, IExtensionProvider extensions)
    {
        this.controller = controller;
        this.extensions = extensions;
    }

    /// <summary>
    /// Unity IAP 遇到不可恢复的初始化错误时调用。
    ///
    /// 请注意，如果互联网不可用，则不会调用此项；Unity IAP
    /// 将尝试初始化，直到互联网变为可用。
    /// </summary>
    public void OnInitializeFailed (InitializationFailureReason error)
    {
    }

    /// <summary>
    /// 购买完成时调用。
    ///
    /// 可能在 OnInitialized() 之后的任何时间调用。
    /// </summary>
    public PurchaseProcessingResult ProcessPurchase (PurchaseEventArgs e)
    {
        return PurchaseProcessingResult.Complete;
    }

    /// <summary>
    /// 购买失败时调用。
    /// </summary>
    public void OnPurchaseFailed (Product i, PurchaseFailureReason p)
    {
    }
}
```

--------------------------------

### C# Script for Runtime UI Setup

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/UIE-relative-absolute-positioning-example.html

A C# script to get the UIDocument component. Attach this script to a GameObject to enable the UI document at runtime.

```csharp
using UnityEngine;
using UnityEngine.UIElements;

public class PostionTestRuntime : MonoBehaviour
{
    void OnEnable()
    {
        GetComponent<UIDocument>();
    }
   }
```

--------------------------------

### QNX Application Frame Rendering Logs

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/qnx-install-player.html

Example log output showing frame rendering times when both startup timing and frame quit parameters are used.

```text
[TIMING::STARTUP] Frame 1 rendered: Real: 2209 ms | User: 1687 ms
[TIMING::STARTUP] Frame 2 rendered: Real: 2210 ms | User: 1692 ms

```

--------------------------------

### Execute Binary with Environment Variable Example

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/qnx-qconnclient.html

Example of using QconnClient to execute a binary on a remote QNX machine with specified arguments and environment variables.

```bash
QconnClient.exe --ip=127.0.0.1 exec /data/home/root/myApplication "-arg 1 &" "export TEST_PATH=/data/home/test"
```

--------------------------------

### Editor Log Example of Importer Inconsistency

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/ImporterConsistency.html

Editor logs provide detailed information about importer inconsistencies, including GUIDs, dependency hashes, and content hashes of assets.

```log
ConsistencyChecker - guid: a1945cd7aab67441ba89015f97494624, dependenciesHash.value: fb8cfb407bba82d4daded6031688ba9b, artifactid: 07078a054d3f597b4c2cc47e8e4c0bde, producedFiles[0].extension: , producedFiles[0].contentHash: 8490a5ed35a4361d679e6055a386969e

ConsistencyChecker - guid: a1945cd7aab67441ba89015f97494624, dependenciesHash.value: fb8cfb407bba82d4daded6031688ba9b, artifactid: 07078a054d3f597b4c2cc47e8e4c0bde, producedFiles[1].extension: .info, producedFiles[1].contentHash: 4bd9140e19d2e44782f1131172e514ba

ConsistencyChecker - guid: a1945cd7aab67441ba89015f97494624, dependenciesHash.value: fb8cfb407bba82d4daded6031688ba9b, artifactid: 646d6432767729ea7d288c636183de97, producedFiles[0].extension: , producedFiles[0].contentHash: 5ca760170f85012ce16aa8c22e8d9ea1

ConsistencyChecker - guid: a1945cd7aab67441ba89015f97494624, dependenciesHash.value: fb8cfb407bba82d4daded6031688ba9b, artifactid: 646d6432767729ea7d288c636183de97, producedFiles[1].extension: .info, producedFiles[1].contentHash: 4bd9140e19d2e44782f1131172e514ba

Importer(ScriptedImporter:Assembly-CSharp::RandomImporter) generated inconsistent result for asset(guid:a1945cd7aab67441ba89015f97494624) "Assets/first.rand"
```

--------------------------------

### Example macOS License Activation Command

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/ManualActivationCmdMac.html

An example of the manual license activation command for macOS, showing the full path to the Unity Editor executable and the .ulf file.

```bash
/Applications/Tuanjie/Hub/Editor/2022.2.0b4/Tuanjie.app/Contents/MacOS/Tuanjie -batchmode -manualLicenseFile /Users/myAccount/Downloads/Tuanjie_v2017.x.ulf -logfile

```

--------------------------------

### Call TuanjieMain Thread from UI Thread

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/openharmony-plugins-typescript-call-ui-thread-worker.html

Make calls from the UI thread to the TuanjieMain thread using POST_MESSAGE_TO_WORKER. This example shows how to update and get game data.

```typescript
import {POST_MESSAGE_TO_WORKER} from 'classesLib'

export class UIService {
  UpdateGameData(newData: string, callback: Function) {
    const msg: ESObject = {
      moduleName: "tuanjieLib",
      funcName: "GameService.UpdateData",
      args: [newData],
      callback: callback,
      timeoutMs: -1
    }

    POST_MESSAGE_TO_WORKER(msg, undefined)
  }

  GetGameData(callback: Function) {
    const msg: ESObject = {
      moduleName: "tuanjieLib",
      funcName: "GameService.GetData",
      args: [],
      callback: callback,
      timeoutMs: -1
    }

    POST_MESSAGE_TO_WORKER(msg, undefined)
  }
}
```

--------------------------------

### Absolute Path Examples for Local Dependencies (Linux/macOS)

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/upm-localpath.html

Specify absolute POSIX paths for local dependencies on Linux or macOS. Paths start with a forward slash `/` after the `file:` prefix.

```json
{
  "dependencies": {
    "my_package_a": "file:/Users/my_username/github/my_package_folder",
    "my_package_b": "file:/Users/my_username/Downloads/my_package_tarball.tgz"
  }
}
```

--------------------------------

### Sample Object Example

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/upm-manifestPkg.html

Defines a sample included in the package with a display name, description, and path.

```json
{
"displayName": "<name-to-appear-in-the-UI>",
"description": "<brief-description>",
"path": "Samples~/<sample-subfolder>"
}
```

--------------------------------

### Clone Sample Project

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/QuickStartPlayable.html

Clone the sample project repository to start building your playable ad.

```bash
git clone https://cnb.cool/tuanjie/MiniGame/Tuanjie_PlayableAds_Sample_Shot
```

--------------------------------

### Example Script for RethrowError Analyzer Test

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/roslyn-analyzers.html

This C# script is used to test the installation and functionality of Roslyn analyzers, specifically the ErrorProne.NET analyzer, by demonstrating a suspicious exception handling pattern.

```csharp
using System;
using UnityEngine;

public class RethrowError : MonoBehaviour
{
    void Update()
    {
        try
        {
            DoSomethingInteresting();
        }
        catch (Exception e)
        {
            Debug.Log(e.Message);
            throw e;
        }
    }

    private void DoSomethingInteresting()
    {
        throw new System.NotImplementedException();
    }
}
```

--------------------------------

### Relative Path Examples for Local Dependencies

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/upm-localpath.html

Use relative paths to reference local package folders or tarballs. Paths starting with `..` are relative to the project's `Packages` folder.

```json
{
  "dependencies": {
    "my_package_a": "file:../github/my_package_folder",
    "my_package_b": "file:../Downloads/my_package_tarball.tgz"
  }
}
```

--------------------------------

### Run Tuanjie Accelerator with Options

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/TuanjieAccelerator-commnadline.html

Starts the Accelerator server with various optional configurations. Debug mode, auto-updates, and port settings can be controlled.

```bash
tuanjie-accelerator run --debug --log-stdout-also --no-auto-updates --http-port 8080

```

--------------------------------

### Example of Multiple Jobs with Dependencies

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/JobSystemJobDependencies.html

Demonstrates setting up and scheduling two jobs with a dependency. The second job depends on the first job's completion. Ensure to dispose of NativeArrays after use.

```csharp
using UnityEngine;
using Unity.Collections;
using Unity.Jobs;

public class MyDependentJob : MonoBehaviour
{
    // Create a native array of a single float to store the result. This example waits for the job to complete.
    NativeArray<float> result;
    // Create a JobHandle to access the results 
    JobHandle secondHandle;

    // Set up the first job
    public struct MyJob : IJob
    {
        public float a;
        public float b;
        public NativeArray<float> result;

        public void Execute()
        {
            result[0] = a + b;
        }
    }

    // Set up the second job, which adds one to a value
    public struct AddOneJob : IJob
    {
        public NativeArray<float> result;

        public void Execute()
        {
            result[0] = result[0] + 1;
        }
    }

    // Update is called once per frame
    void Update()
    {
        // Set up the job data for the first job
        result = new NativeArray<float>(1, Allocator.TempJob);

        MyJob jobData = new MyJob
        {
            a = 10,
            b = 10,
            result = result
        };

        // Schedule the first job
        JobHandle firstHandle = jobData.Schedule();

        // Setup the data for the second job
        AddOneJob incJobData = new AddOneJob
        {
            result = result
        };

        // Schedule the second job
        secondHandle = incJobData.Schedule(firstHandle);
    }

    private void LateUpdate()
    {
        // Sometime later in the frame, wait for the job to complete before accessing the results.
        secondHandle.Complete();

        // All copies of the NativeArray point to the same memory, you can access the result in "your" copy of the NativeArray
        // float aPlusBPlusOne = result[0];

        // Free the memory allocated by the result array
        result.Dispose();

    }

}
```

--------------------------------

### Reporting a 'Secret Found' Event with Data

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/UnityAnalyticsCustomEventScripting.html

This example demonstrates sending a 'secret_found' event with associated data like the secret ID and time elapsed. The event data keys cannot start with 'unity'.

```csharp
public void ReportSecretFound(int secretID){
    AnalyticsEvent.Custom("secret_found", new Dictionary<string, object>
    {
        { "secret_id", secretID },
        { "time_elapsed", Time.timeSinceLevelLoad }
    });
}

```

--------------------------------

### Example .npmrc file with _auth

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/upm-config-scoped.html

This is an example of an .npmrc file containing the _auth property and email for authentication.

```ini
registry=https://example.com:1234/mylocation
_auth=<AUTH TOKEN>
email=<EMAIL>
always-auth=true
```

--------------------------------

### cURL Request to Get Specific Raw Data Export

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/UnityAnalyticsRawDataExport.html

Example cURL command to fetch a specific Raw Data Export. Replace placeholders with your Unity Project ID and API Key.

```cURL
curl --user {UNITY_PROJECT_ID}:${API_KEY} https://analytics.cloud.unity3d.com/api/v2/projects/{UNITY_PROJECT_ID}/rawdataexports/${ID}
```

--------------------------------

### Build AssetBundles with Options

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/AssetBundles-Building.html

Demonstrates building AssetBundles with specific options, such as compression types. Ensure the output directory exists before building.

```csharp
BuildPipeline.BuildAssetBundles("Assets/AssetBundles", BuildAssetBundleOptions.ChunkBasedCompression, EditorUserBuildSettings.activeBuildTarget);
```

--------------------------------

### Instanced Vertex and Fragment Shader with Per-Instance Color

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/gpu-instancing-shader.html

This Vertex and Fragment Shader example demonstrates instancing with per-instance color. It requires manual setup of instance IDs using UNITY_SETUP_INSTANCE_ID and UNITY_TRANSFER_INSTANCE_ID.

```hlsl
Shader "Custom/SimplestInstancedShader"
{
    Properties
    {
        _Color ("Color", Color) = (1, 1, 1, 1)
    }

    SubShader
    {
        Tags { "RenderType"="Opaque" }
        LOD 100

        Pass
        {
            CGPROGRAM
            #pragma vertex vert
            #pragma fragment frag
            #pragma multi_compile_instancing
            #include "UnityCG.cginc"

            struct appdata
            {
                float4 vertex : POSITION;
                UNITY_VERTEX_INPUT_INSTANCE_ID
            };

            struct v2f
            {
                float4 vertex : SV_POSITION;
                UNITY_VERTEX_INPUT_INSTANCE_ID // use this to access instanced properties in the fragment shader.
            };

            UNITY_INSTANCING_BUFFER_START(Props)
                UNITY_DEFINE_INSTANCED_PROP(float4, _Color)
            UNITY_INSTANCING_BUFFER_END(Props)

            v2f vert(appdata v)
            {
                v2f o;

                UNITY_SETUP_INSTANCE_ID(v);
                UNITY_TRANSFER_INSTANCE_ID(v, o);
                o.vertex = UnityObjectToClipPos(v.vertex);
                return o;
            }

            fixed4 frag(v2f i) : SV_Target
            {
                UNITY_SETUP_INSTANCE_ID(i);
                return UNITY_ACCESS_INSTANCED_PROP(Props, _Color);
            }
            ENDCG
        }
    }
}
```

--------------------------------

### Play Animation Clip with AnimationPlayableUtilities

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/Playables-Examples.html

This example shows how to use AnimationPlayableUtilities for simplified creation and playback of animation clips. It requires an Animator component and an AnimationClip. The utility handles the graph creation and setup.

```csharp
using UnityEngine;

using UnityEngine.Playables;

using UnityEngine.Animations;

[RequireComponent(typeof(Animator))]
public class PlayAnimationUtilitiesSample : MonoBehaviour
{
    public AnimationClip clip;
    PlayableGraph playableGraph;

    void Start()
    {
        AnimationPlayableUtilities.PlayClip(GetComponent<Animator>(), clip, out playableGraph);

    }

    void OnDisable()
    {
        // 销毁该图创建的所有可播放项和输出。
        playableGraph.Destroy();

    }

}
```

--------------------------------

### Example Third Party Notices

Source: https://docs.unity.cn/cn/tuanjiemanual/Manual/cus-legal.html

This example demonstrates the structure for a Third Party Notices.md file, listing components, their license types, and links to license details.

```markdown
This package contains third-party software components governed by the license(s) indicated below:

Component Name: Semver

License Type: "MIT"

[SemVer License](https://github.com/myusername/semver/blob/master/License.txt)

Component Name: MyComponent

License Type: "MyLicense"

[MyComponent License](https://www.mycompany.com/licenses/License.txt)


```
Tokens:
Raw