> For the complete documentation index, see [llms.txt](https://paraverse-technology.gitbook.io/larkxr/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://paraverse-technology.gitbook.io/larkxr/quickstart-guide/deploy-applications.md). # Deploy Applications ## Preparing the Application * Package your Unreal Engine (UE), Unity, or other 3D engine project into a **Windows executable (.exe)** file. * Run your the **Windows executable (.exe)** locally (without using LarkXR) to confirm it runs well on your machine. ## Uploading Application Packages Navigate to `http://localhost:8182` or `http://:8182`, go to **Applications → Package**, and click **Add Package**. There are two methods: #### **Method 1: Local Program (the Windows executable (.exe) is stored on the same Machine)** 1. Select **Type Of Installed Program**, then click **Next**.
2. Enter the package name and version. 3. Locate the executable file (recommand to use the exe under the Binaries), right click >> choose \[Properties]
4. \>> go to \[Security] tab, the Object name is your EXE File Path
5. For **UE programs**, select the `.exe` file located under the **Binaries** folder. For example, C:\MyDemoApp\MyDemoApp\Binaries\Win64\MyDemoApp.exe
6. Click **Save**. The new package will appear in the package list. **!!! Particularly for Unreal Engine's exe, please conduct a few more steps following these Important Notes for Unreal Engine's exe** **!!! Important Note for Unreal Engine's exe** Particularly for Unreal Engine exe, you need to obtain launch parameters and input that properly in the LarkXR backend, otherwise it will cause certain issues for the stream. * Start the `.exe` file locally (without using LarkXR). * Open **Task Manager**, locate the process, right-click → *Go to Details*.
* Right-click the column header, select **Command Line**.
* Copy the text after `.exe`
* Paste the parameters into the **Args** field in LarkXR.
#### **Method 2: Remote Program or Centralized Management** 1. Select **Type Of ZIP File**, then click **Next**.
2. Upload the packaged application in `.zip` format (only `.zip` is supported).
3. After uploading, click **Next**. Let it loads... 4. Input your package name and version. 5. Select the system-detected executable file path containing “.exe”. * For **UE programs**, select the `.exe` under **Binaries**.
6. Click **Save**. The new package will appear in the package list. > Both methods are supported. Choose the one that best fits your scenario. **!!! Particularly for Unreal Engine's exe, please conduct a few more steps following these Important Notes for Unreal Engine's exe** **!!! Important Note for Unreal Engine's exe** Particularly for Unreal Engine exe, you need to obtain launch parameters and input that properly in the LarkXR backend, otherwise it will cause certain issues for the stream. * Start the `.exe` file locally (without using LarkXR). * Open **Task Manager**, locate the process, right-click → *Go to Details*.
* Right-click the column header, select **Command Line**.
* Copy the text after `.exe`
* Paste the parameters into the **Args** field in LarkXR.
## Adding an Application 1. In the package list, click **Add** next to the corresponding package.
2. Enter the application name. 3. Select rendering type **SR (3D Shared Mode)**. 4. Configure **Max Concurrent Clients** according to the application size and available GPU resources. * This value determines how many concurrent users can run the application on the current machine.
5. Click **Save Configuration**. 6. Once saved, the new application will appear in the application list. 7. Access and Sharing You can access different parts of the LarkXR system using: * **Backend (Management Console):** `http://localhost:8182` or `http://:8182` * **Frontend (Application List):** `http://localhost:8181` or `http://:8181`
From the frontend, you can either: * Click \[Enter] to access the stream * Copy the streaming URL to your clipboard and share it * Copy the QR code to your clipboard and share it
You can also go to the backend (8182), use the **Share** button next to an application to generate a link or QR code for sharing the LarkXR Streaming URL with your audience.
## Summary LarkXR is a powerful platform for streaming 3D applications. This guide covered the **basic installation, license activation, and application deployment** to help you get started quickly.With this setup, you can successfully use LarkXR within a **local network environment**.If you want your applications to be accessible over the Internet, an externally accessible IP address is required. This will be explained in a separate guide - NAT Proxy Forwarding.