|
1 |
| -# CheckAppInstance |
2 |
| -Plugin for UE4/5 project. |
3 |
| -This plugin makes it possible only one instance of your game can be run at the same time. |
4 |
| -This can be controlled with the launch argument |
5 |
| --checkinst=<0/1|false/true> it's useful for testing multiplayer game on a single pc. |
6 |
| -Example: game.exe -checkinst=0 |
| 1 | +# CheckAppInstance |
| 2 | +This plugin allows you to run only one instance of your game at the same time. |
| 3 | +You can enable/disable check instance from the launch argument to the game binary file |
| 4 | +`-checkinst=<0/1|false/true>`, this is useful for testing multiplayer game on a single pc. |
| 5 | +Example: `game -checkinst=0` |
7 | 6 |
|
8 | 7 | **C++/Blueprints functions:**
|
9 | 8 | - CheckAnotherAppInstance(bool IsEnabled = true)
|
10 | 9 |
|
11 | 10 | ProjectSettings -> Maps&Modes -> Game Instance Class: BP_GameInstance
|
12 | 11 | <img src="Example.png"/>
|
13 | 12 |
|
14 |
| -# Install |
15 |
| -You can install manually by extracting archive (CheckAppInstance-X.X.X...zip) from |
| 13 | +# Install into Project |
| 14 | +You can install manually by extracting archive `CheckAppInstance-X.X.X-UE-X.X.zip` from |
16 | 15 | [Releases](https://github.com/mrbindraw/CheckAppInstance/releases) to your project plugins folder
|
17 |
| -or build example project (ExamplePrj-UEX.X-CheckAppInstance-X.X.X.zip). |
| 16 | +or build example project `ExamplePrj-UE-X.X-CheckAppInstance-X.X.X.zip`. |
| 17 | + |
| 18 | +# Install into Unreal Engine |
18 | 19 | You can install it from the marketplace [CheckAppInstance](https://www.fab.com/listings/c17f1eb9-dfd8-4f41-ba30-e6c6c43d7c98)
|
| 20 | + |
| 21 | +Manual: |
| 22 | +1. Download and extracting archive `CheckAppInstance-X.X.X-UE-X.X.zip` from [Releases](https://github.com/mrbindraw/ProjectVersionFromGit/releases) to any disk path, for example: `D:\Plugins` |
| 23 | +2. Than open any terminal (cmd, powershell) in `D:\Plugins` folder |
| 24 | +3. Launch `RunUAT` in the terminal with arguments, for example: |
| 25 | + |
| 26 | +Windows: |
| 27 | +``` |
| 28 | +D:\EpicGames\UE_5.4\Engine\Build\BatchFiles\RunUAT.bat BuildPlugin -Plugin=D:\Plugins\CheckAppInstance\CheckAppInstance.uplugin -Package=D:\Plugins\UE_5.4\CheckAppInstance -Rocket |
| 29 | +``` |
| 30 | +Mac: |
| 31 | +``` |
| 32 | +sh "/Users/Shared/Epic Games/UE_5.4/Engine/Build/BatchFiles/RunUAT.sh" BuildPlugin -Plugin="$PWD/CheckAppInstance/CheckAppInstance.uplugin" -Package="$PWD/5.4/CheckAppInstance" -Rocket |
| 33 | +``` |
| 34 | +4. If you see the message `BUILD SUCCESSFUL` in the terminal after the build is complete, |
| 35 | +copy the `CheckAppInstance` folder from `D:\Plugins\UE_5.4` to `D:\EpicGames\UE_5.4\Engine\Plugins\Marketplace` |
| 36 | +> [!IMPORTANT] |
| 37 | +> **The engine path and folder names may differ on your system.** |
0 commit comments