Skip to content

Commit 3b459f5

Browse files
authored
Updated README.md
1 parent 89ec436 commit 3b459f5

1 file changed

Lines changed: 27 additions & 11 deletions

File tree

README.md

Lines changed: 27 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,37 @@
11
# SystemMicControlLite
2-
Plugin for the UE4/5 project.
3-
This is a free version of the plugin [SystemMicControl](https://www.unrealengine.com/marketplace/en-US/product/system-mic-control) with the lite functionality.
4-
This plugin can get the default microphone device name and change volume in the system.
2+
This is a free version of the plugin [SystemMicControl](https://www.fab.com/listings/5262e4aa-d47e-4deb-b0c4-fd8e0e583ba8) with the lite functionality.
3+
This plugin can get the default microphone device name and change the microphone volume in the system.
54

65
**C++ / Blueprints functions:**
76
- GetMicDefaultDeviceName( ) / GetSystemMicDefaultDeviceName( )
87
- SetMicVolume( ) / SetSystemMicVolume( )
98
- GetMicVolume( ) / GetSystemMicVolume( )
109
- GetMicActiveDevices( ) / GetSystemMicActiveDevices( )
1110

12-
# Install
13-
You can install it from the unreal marketplace [SystemMicControlLite](https://www.unrealengine.com/marketplace/en-US/product/system-mic-control-lite)
14-
You can install manually by extracting SystemMicControlLite-X.X.X-marketplace-win64-ueX.XX.zip from [Releases](https://github.com/mrbindraw/SystemMicControlLite/releases)
15-
to your project plugins folder.
11+
# Install into Project
12+
You can install manually by extracting archive `SystemMicControlLite-X.X.X-UE-X.X.zip` from
13+
[Releases](https://github.com/mrbindraw/SystemMicControlLite/releases) to your project plugins folder
14+
or build example project `ExamplePrj-UE-X.X-SystemMicControlLite-X.X.X.zip`
15+
Documentation: [README_SystemMicControlLite](https://docs.google.com/document/d/1dUhtFlGrWnYbmSCeOkPvmICLy6Yz3ZRfQhf0t2UDO80/edit?usp=drive_link)
16+
Example project: [DemoSysMicControlLite](https://drive.google.com/drive/folders/1Ww4Nbb8jy67cO08OQvnSCoec_BDWIiKp?usp=sharing)
1617

17-
# Documentation
18-
[README_SystemMicControlLite](https://docs.google.com/document/d/1dUhtFlGrWnYbmSCeOkPvmICLy6Yz3ZRfQhf0t2UDO80/edit?usp=drive_link)
18+
# Install into Unreal Engine
19+
You can install it from the marketplace [SystemMicControlLite](https://www.fab.com/listings/2c75dba0-d0ea-4062-946f-1901c4fe76f2)
1920

20-
# Example project
21-
[DemoSysMicControlLite](https://drive.google.com/drive/folders/1Ww4Nbb8jy67cO08OQvnSCoec_BDWIiKp?usp=sharing)
21+
Manual:
22+
1. Download and extracting archive `SystemMicControlLite-X.X.X-UE-X.X.zip` from [Releases](https://github.com/mrbindraw/SystemMicControlLite/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\SystemMicControlLite\SystemMicControlLite.uplugin -Package=D:\Plugins\UE_5.4\SystemMicControlLite -Rocket
29+
```
30+
Mac:
31+
```
32+
sh "/Users/Shared/Epic Games/UE_5.4/Engine/Build/BatchFiles/RunUAT.sh" BuildPlugin -Plugin="$PWD/SystemMicControlLite/SystemMicControlLite.uplugin" -Package="$PWD/5.4/SystemMicControlLite" -Rocket
33+
```
34+
4. If you see the message `BUILD SUCCESSFUL` in the terminal after the build is complete,
35+
copy the `SystemMicControlLite` 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

Comments
 (0)