From 64a4e9891e66c7f6058aec5ae5d9a6125700f807 Mon Sep 17 00:00:00 2001 From: Saif Alaqqad Date: Sun, 18 Jun 2023 22:49:48 +0300 Subject: [PATCH] Update README for v1.2.8 --- README.md | 38 ++++++++++++++++++++++++++------- screenshots/configwindow_8.png | Bin 0 -> 10136 bytes 2 files changed, 30 insertions(+), 8 deletions(-) create mode 100644 screenshots/configwindow_8.png diff --git a/README.md b/README.md index caeba38..e1da555 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,7 @@ * Customizable sound and on-screen feedback * Always-on-top overlay to show the microphone's state * Run custom scripts/programs when muting/unmuting the microphone + * ASUS Aura Sync integration * Voicemeeter integration ## Installation @@ -125,6 +126,12 @@ Show the microphone's state in an always-on-top overlay. ### Linked applications Link a profile to an app/game, when the app becomes visible (not minimized or hidden), MicMute will automatically switch to that profile, when the app is minimized/hidden/closed, MicMute will switch back to the default profile. +**Foreground only** option (Enabled by default) can be disabled so background apps (minimized or hidden) can also trigger the profile switch. `v1.2.8+` + +### Volume Lock +Locks the microphone's volume to a specific value and prevents other apps from changing it. +`v1.2.8+` + ### Microphone actions Run programs and powershell scripts when muting/unmuting the microphone(s).
@@ -179,7 +186,20 @@ You can use the same variables as the program action (and you can insert the '** ```
-This action works by encoding the script using base64 (UTF-16LE) and then passing it to powershell using the `-EncodedCommand` parameter, this avoids the need to create a temp file to run the script and even avoids any issues related to escaping special characters. +This action works by encoding the script using base64 (UTF-16LE) and then passing it to powershell using the `-EncodedCommand` parameter, this avoids the need to create a temp file to run the script and even avoids any issues related to escaping special characters. + +#### 3. Aura Sync action: `v1.2.8+` +Syncs the microphone's state with ASUS Aura Sync compatible devices. + +* You need to have **Armoury Crate** (or the standalone Aura Sync app) installed for this action to work, though it doesn't need to be running. +*
+ Screenshot + + ![Aura Sync action](./screenshots/configwindow_8.png) +
+ +Due to how slow the Aura Sync API is, this action requires a seperate MicMute process that controls the RGB by listening for messages from the main MicMute process, this ensures that the action does not affect the responsiveness of the hotkeys. +
### Global options @@ -199,7 +219,7 @@ Prevent other apps from changing the microphone's state (i.e mute/unmute the mic #### 5. Voicemeeter integration You can control Voicemeeter's inputs and outputs using MicMute, after turning on the option, refresh the microphones list and you should see voicemeeter's inputs (strips) and outputs (buses) in the microphone dropdown. -
+*
Screenshot ![Image](./screenshots/configwindow_5.png) @@ -242,12 +262,12 @@ Hold Shift when clicking **Edit configuration** in the tray menu, and Hold Shift when clicking **Help** in the tray menu, and the logs window will open. ## CLI arguments -| Argument | Description | -| --------------------------- | ----------------------------------------------------------------------------------- | -| `/profile=` | Startup with a specific profile. | -| `/noUI` | Disable the configuration UI completely. This decreases memory usage by almost 60%. | -| `/debug` | Add shortcuts to `ListVars`, `ListHotkeys` and `View Log` in the tray menu. | -| `/logFile=` | Outputs the log to a file (it's written to stdout by default ) | +| Argument | Description | +| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | +| `/profile=` | Startup with a specific profile. | +| `/noUI` | Disable the configuration UI completely. This decreases memory usage by almost 60%. | +| `/debug` | Add shortcuts to `ListVars`, `ListHotkeys` and `View Log` in the tray menu. Enables logging for Aura Sync action (`v1.2.8+`) | +| `/logFile=` | Outputs the log to a file (it's written to stdout by default ) | Example: `MicMute.exe "/profile=profile 1" /noUI /debug /logFile=MicMute.log` ## Compile instructions @@ -307,8 +327,10 @@ ahk2exe.exe /in ".\src\MicMute.ahk" /out ".\src\MicMute.exe"; | [VMR.ahk](https://github.com/SaifAqqad/VMR.ahk) | [License](https://github.com/SaifAqqad/VMR.ahk/blob/master/LICENSE) | | [mmikeww/AHKv2-Gdip](https://github.com/mmikeww/AHKv2-Gdip) | [License](https://www.autohotkey.com/boards/viewtopic.php?t=6517) | | [Bulma CSS framework](https://bulma.io/) | [MIT](https://github.com/jgthms/bulma/blob/master/LICENSE) | +| [CodeMirror 5](https://codemirror.net/5) | [MIT](https://codemirror.net/5/LICENSE) | | [G33kDude/cJson.ahk](https://github.com/G33kDude/cJson.ahk) | [MIT](https://github.com/G33kDude/cJson.ahk/blob/main/LICENSE) | | [G33kDude/Neutron.ahk](https://github.com/G33kDude/Neutron.ahk) | [MIT](https://github.com/G33kDude/Neutron.ahk/blob/master/LICENSE) | +| [jscolor Color Picker](https://jscolor.com) | [GPL v3](https://jscolor.com/download/#open-source-license) | ## Credits This project would not exist without these people: diff --git a/screenshots/configwindow_8.png b/screenshots/configwindow_8.png new file mode 100644 index 0000000000000000000000000000000000000000..6035682fa21da4f4465ce16f9d092531b48bc7b6 GIT binary patch literal 10136 zcmeHtXIPU>w{8#xl^3xgO4U~d1pz4uO+-ON>Cz$6r6!>mii8pY0R<5i0qMPy&_fMH z5R_gMNTfrgN)09Tlg8~3-d?z_rEoZ-8Ze$f~a3d{s0D3@hg;hE3@=)&~08kmnMYBJ_s-Ne&U+U$-mpr?$pE4ShK3#iI05FqBP`(C7VEWt@-}+ivjwE(r>GGM%PsX_nWJb zOosXX>iF8sfbv?|)5^+9#wC`;X=lXr(}pS?yQdF#dZm%b!>u{J?l_T|Mb91ilTdb! zzYgcxLfMhV#>Us1#&9?U7fVJzv#98n=erLd%yf0%?{Cg9a}Ct!dvy#FrER~qJQ$Vb zInxpk{dPT%4FK>tBk&8cx17DRv!md*IjuUG_6cRCe>`O}D`eRc`g?I(be~ru#ooJuNEc znjw=bpR&`!+_bkhd8ISU%7U05;Op@8tdaGmgh0g17g5=lr@xq8M0l=K-i$z}=%#9? z0D##O7*{0L6slOQ3Ii2Qf>q-BIcmB^kk3VewjP#tq`ZUhD^%%zcUtNBu@$2qBkv@Y zE}Hxi6i{VdWvYBw!)P@V%SqR zl(lIy&LApECQHrna_}*)!`n zt4}ZC=^Hle0Kitwt0!X|GAhU2qf}vMn@A~;ls@BXEDRIX&!O1V0-coQy?F5ue7zbA zx)Qi)X4WEfOxJjL@lJq@xTLYpWY#x87F2$Z;Ik}qnd5m*U_Y|7)_1XHs8Z*f2qds`73mD`D4ibU>asPUOh6O# zU1_xOE&7ii&mPj-O)lTFWnwL`zIg=^887IVuJxA5mDBXg)RqV={$WEvMg%EX@3g@A z+K$|#@Fejj#wki1>`?jJjQ^&0egyx=45{5WmyJ#U9xdv{mQe31MQ~&mri&fE_Y6Up zZXLb)Jh*ttef;Bc3J}t4|0oc`N9=VDoH_>ToUEE^@?V?spCRwVo?6IBn_pRR3Mn^l ziH4}zm&>wXxjvKoQ-O`oJih?q? z9Xb2{4@8{##apvp~CXN9r0sjtmjD=LQT-Ev9Z6I(QftL>RbKeN&c; zHuwKARsia^uZE97U0K_n`#5$dQf;G=+Z_{yGL;?qV)XpQeVWD&SniJddB2cX=*sLa zj>=s4FRc-@fSCl4(ra4+E406-k)}8`U3m7tH2I;ZT4euWU*oh<5R50Tf*LvGEQPy zFgI9iT!>4*NuX3~XsGJ>b_6l1niVxKKy@VvrB#cDZ>vVSV&7lB1LgVBvroY)?blCh zU%%2*EWiPTdhM8_XgRX6f=R_SY~b2`lPPsgNUiBgV_kzc{x!F{Z+l#WGkAvFGL>p_sZyZk zmVfOjp@#wl6U)?__lqp-hi&fcrS!zB=sM2pTnPS;9JZCF}>! zW6gE+>G^7kp#!1SkJgTxdvBFjee}>OR^HOZfov5O?4llQU{006vR_@9pdkC%k#_VMG#*>X0;Q9~wM+L_}RKYnE&*KiKR&f-ri z3^e)l>C-+NwRlRtV#8lcUk^&{+zLi$=d&bo7%EqF1*Fa_A#1WRVc2Egp^97zeg^0x=1Jr)Ic?u!r#?TQH_!r#f8<Pg<5kx9V%ueM6a zxxCx4sf4|=wD~z&WviM)G*Zc{J=S>Q7+7Vp!f$VRxN!*M+|Q5HQHgv!FFjg+`yC_w zu6MlrTo0V4f=c>ioMmqF>cPzZW}W4)%k)J)E?*|MIpj&^=?!9|WvasFaQjzyf~Z4C6j($x{hTCd#x8GW>_F`5X);pn`| zR9dO;Zm!OrMOOeLqb)hM4aX)NayZvGU@I9clQb3I@hnZ7oVib>L-0i zq6gIuxRf>17(fZ*89~9qo%Hh6_RT4@$Y6451Kee8x|j*>jp^l8IJA{tO5CN>*{+7! zA1u!m=Z>3G$pg|Z%OsHj5bWpk{-f;!Ut*ZLF~R)0*i^O;(tlR>vEABLp-Y64I>;`S zcVxEIcT|BUJ9u~M<<#BpA^V~CC)W6mpo5n2*G9Gi1Q{QDYA!Zi(;Qv@s4>Ct)({nk z&%v#ZN+gk{5}DwlKF`O8W~qvrOgZ4gl3Tb^r9lWd-}aAE7EQ}#Im$oCpxXA=@1)7O z4@7z7PaSeM((N5-CK0idJz0M(j=_d;;?q!P@q?gYis27(L`1n>cWHk2r z8@nf~1g9(y>Pb<~9mLC?sw&n$3+^eY5>*~Q)PL-%wHx8_qf=M%uLAAnMx()Ggg~*< zQI{Ux{YjZg)gOhPqg}RE`Mj6GXy?JhY>!s@DPD?`-(?UPb7Zw+MBlcxl4X9;D9i?V zSWbOhlL+Xoxhoe$dAt>}t5 zl+t8ZFcM_~q4FEItdmb{~q7!Q5$u?*q8x<${Y4!V_7hq@$LjX_r+cd22bo zKI4URpXU}lhi0W2=zg$*o1=ZO;qjK!n1Rf)kWBZ$)SGd`b;dol-s8yCe#t1_!0Dx) z`rl{9d3vm_e_^!dkf%%3io61obEwui$n^NqD~=AebUmsfI5B6Farj46mGTM7h%fFg zt?TjIL$>(Vy6N=M)nNOWn<4(_OMSZdv%BBnvA1o>_~2+D*{`ePKpswe*0`gt@;z6V zI3snM7x;3ojZKJ*hg}wQ3?t<#*rMSQw1skFel%Pf-yfGEo&1SppO%yzfQc0#7;}Qk zWCsuQum_d~+0lDHrPBuztq%M+l^qQ`||W2kbZVC)H_9fPCMPW)_9ZVQCO!_D)=i4ZyRE%5;viuRWn-FO50f@ z*c~$`Y|P-6-wf6=lCPvtYi=X=PdP~uvj!cbmZLp^a%wk4AA`yh1ShgN(joo)1x=f} z__m4js9;&e5OkGub5^Tqr~B+gDjknE{FN7&@ac0_H0-ERZTFNaBx7?_EwebYT*gyd zJ-P+16^_<2-LS}}Iu8v0QetK&9UMlqnRntgSO76#?O}S|bnt=oCJu)T+;@#CJxsOv zDr0Uyq-atCYgTs9UmhKWuE z&@H=s1T~Wog_I#5w(7j#F@3f(Qy?jGz}(4hNGc$&wHkh2Zl?15 z%L`5r#l6pfmaWy)*D~!p}UyAls<0r|BG};+6SPiolKg}NpX>2}b^7r#|RQVOh<#g0C6aPOjXf_%4#$7;TEJ7Y44((VuGbukH^fD7(c$+|vG!_z5L!ffao*#KOu+^NZ$ zwBugo)fzd8bPTN36b!1FYZz?+<@AGV7)p7OZ zdn_H=`gh&m2_+@l<|@zAf=^4D?|%rHs+W|}86_>UZ%CHP*0KAp)RQ=0fPJszTu5*S z!_^^S=+HLY!!SE%0e7k-Q3}(JnQ0Esz?c;WX_P7illqO1rpeQbKGRa-tMYGi%_rYB z9VO)%l``rd?q3V<9>lGeE4+91)+lhFp6A=6!PQ3np<+{FQP|*kX&GBPtg8CFXsl6@ z(qwT#|4%J(>Mw|%d`Y`PpMB$>^X0%{HHG1nEXdUg->U*6>(3LivK!aXP0crH$}rUS zK14tl{@G60g@4UIr0_{K9`tA0F=e-)I2?(ISSnXM065!(U%R}>7DpO*nkF{!~bI488Cc%TYDE6h6>Wb1@G6H0cM>imdMK@L1kcyIhzSX0A*w=2(G-r%UKhB>>w6U^U zjZh$VnAzC;+4Po8=ow^6Zz%YB+ff9ud&G#4bV_YO{*A9QR9~yf;oWN~wa=OkzWU{C zjyEn;CO49C$tj!T=16!}l@&(Avu!z59!?4G*&8^H0GDH_pGq90af^j7$+LT4psJi! zjL2cAN9OM96o|e!UTSP!ZPV0g{XuN%Zu3s!1Rh3+k7ym&X)sRsY={mwLe`oWX1pWjdt(w>^BT^*4Y#U%nI2%f;QRd`b2vV^AXct?Ww)4_DjOpsOb zLEoqV!{-zGQJnk0sAtKcms-Al+Q{r-97*9`Y^(kfVrd|wFhOAd_G(yVqkYdsJzZ5T zEj5ecfNHovpDo*ShqV@K=wM2^_^`NU>sTDjn)V|vo-OH>?<(z3dT%(geCHq}E|GMv zkejn)%yaLNUc(AMnYncW=%%l0O~bmu#VL8N^Zw|uw_nO3Z*NZ@^+8qB>K;-{2Jk=y z-C=G=X`?=^2n1rl(Y-~fc#L8@Fq9rwCSOji@IePp6{ubz7%Wjiu1nYbAvn1;`c-FX z0r_r-|Cs|FAk6x3Tf}scbi=&*ck;q!%*Y8xJpl!$9HT)ccbjkb`Uki_aMw$V1A(=e zZ>je}Kgha|-6H>)YWmsC3!c6fAIGLBVMOPAjfswn6Z;1!*Y|ONA|J6{1hwo~l%+w--u^i=Ua8e6c0e9w)a_LKQcfcO6@6 zsLRHQSzN8DMPFauw-~N$)Sz$P+1}pXtEi2DRcuH<_x}shw(=tU14_+rr6i0pBh(MQe_XZ6$ht(?beD=_US=>vYq=(6+< zzcn~9*Y};V{6W{yw8B9D$d-^&Hr-rsY+^-Dchuui(0kY+mV4UqCGMuXw%1*NP{|QR zq~Q$VE>M%yn}DiQTKl5tgns82>P+B>;|_Wla25ys*lV2O_7^6Adi?Pkf)^)r-KE>h z=^1la@9e}7Xg?L@c6UQz@|>}5M>5dtdYAKU&rc#nR_%~IJoXP#V>;)11X13h2KK^p zZ226~u@@)1b@`T++67YdGgp(jX4 z6_1XsjtKV8K0_foJnK@%Zu3`1w|I;k+>%$R8<^$z@TdGWS6>t>d2 zIUKbh&0}xZUy#)tgqjW6Kc7Jey$qdl%GbUZn*iU-dXxZKJ>qN>XARgc-&V!F>&iWH z2Fr^(3!YZ+RDs$jQl7oL5!-*dhtG}U;pycZeH$iN+K6~p-I(TgLs~lMB>Cdw!J)lM z&b7ehP^k}Xk)Y(tAD|3ld56x6@YMXu>s{i#@7%UT)z zOVQc;Q79*|vy%-k14i>*l;%!OoebrMRlQ0~*L}`^+DU1x24=n7`I-{XWrhA(@#Jn^ z)zSqaU4FZkZq7c1qfR4F4|r$yagE%NN<7z)>t&7y)U+CgR#~`Sp_qI!VTcWCk&1R9 z%B!+_U18~Umi^3^u{v-Ok}K)C@v&=qnaB4%?)~050_J;&bci(=6KjarLeaYffH)Dv zyTh-Np2@0R1Zxeja~`ANx1?v14GO*W7a!t0?vQKSeRJ%#%2Qw~vmE9beFjb6=n9U?di>?(1l^BvUgp z3Z#GSeYe<+8_SNn{DnOHd5*)20X}yE>G=!Yait|CB|5fI{WxZB9DaFg!tq~{h(kz! zY1zHGa$vcfaOOv^M0YjxaMnuj#o+gl7uk-!WY$Sn@8uzIoEt-Ts*b_(WH~|8E6IhW zwu(sGL~IE7NP%C!|K0@Y1X z;ZrP+ss=v>{*&!a|7|&pD0Mkt+-#w};Vu|YNx8h11OR-Sd;lL+vPQmM>4>({BZPcw z<=dJ6UWwQq<)UVp>4uyTRKo#jS8abdJJ_i-flNq(UC3F?QYtauT z{&B*|I`gR^1+gna!H?end-u!IMeuYrJbR!0zwf|Rimgm&Q`c^gRw(W3ORD)%TJ0t7}7b#u$GT$^V5Dt z_uy%+-kTIGy0nuE4XNy^-|D zt)HZAy(+D#>gZG5DwH1AhSNr_^X7_C##U`x@(%t2H0EIFGPyp*GlfR>*~pn!t6~go zb3W9{&sqcwo=`r=g^mivN z0r*R#P~8r~C(!7gR~>$B^zu*Ih{735P#OJ4^LTrOduWMXMa&4D?pRY9rM5`ue)B*8 z_u)zF_JPi(n4Yt+AfSG(czZ+~4$;8Lwf>b5aEWEv^iG-25;nU^k0h%4^|!P7)m)#&SBrxw2~>kI?)U-8cO!?P*a9_COURRq+icrNP|RvYYHhk?5o&o8X%W^o}Vr0zO}t85;ROb{(ghpB^K3?oK2 zc~dh5$L(gW-!yGR{X&nI%sxR;0*N^Zxbnx4eFa)tb-N*bHE@DogiB1z4ietyDEj0( z#lH`1adz)*fX@3r3bu;;M8}Y)YX|Sf^{{`_KJQ1nRoEh!uF{u}0R(r(97#ygnn^q7 z4l9Sy8Ap(g^7_U#SWrK0@Q>rS3B?QZ-+s5Eb^`HXOT`s1Ti}I>4|_3afmP^_$lA-n z6#F9c^$}#sV5{-dw?<592w8#YQGfj=8S62<6L(3FNB9_6!YSlg{!i0kN~}oznf)TA zrBf$~4!QC*%_oxBE3cQ>;=FLT0E*pj&?n|PvP55ycgAKx%obVS0 z-Db2t^+DaR^!>x)Q(kl3t1p(ut>B7Q3c!qTzt9HHjwE+-B|b)UDQzlj!tVa2UkXo6 zS4X;yfz3wBRM=c{U6uyjlDO6U-fru9iDJzFuBfPixZ#c8AUXeh zuBwjcIp|6E=eYFr+vN)P?`H`AgGKQFDJ=5q%7uwDolp48eVH*sHppf(WZaTxHQR$5 z!48dD0!M?+3_EH|k5%m3y+WR*WY7Ir+`ioM{Ekas1YBC}St)0n$y&1q!zB}R@OC7% zpo$@rF<=aE9qaXn1p?ArTaG=O*T4S9aR16zy3 zE!PgJ>-f7!rv-NXgP~rd-?sX&%pW>&_P>m!{{2(^zlFqeA5+tWoSYn56Kj3FBKlof ziCTtx|72=i{THz9c9u^a&tXyFy)#-`aSeIk`b4E3Ht?XO z%DmjBL+{nDA4^G_`QU!pWCe@fVRW&CL)?3t+nj}zeQuRwFn-9^5W1+$J=XAB