Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
SaifAqqad committed Mar 9, 2024
1 parent 071a1e4 commit 79d86ae
Show file tree
Hide file tree
Showing 19 changed files with 959 additions and 203 deletions.
16 changes: 8 additions & 8 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,18 @@ To use `VMR.ahk` in your script, follow one of the following methods:

### Manual Installation

1. Download the latest pre-built version from the [`dist` folder](https://raw.githubusercontent.com/SaifAqqad/VMR.ahk/master/dist/VMR.ahk) / [latest release](https://github.com/SaifAqqad/VMR.ahk/releases) or follow the build instructions below
2. Include it using `#Include VMR.ahk` or copy it to a [library folder](https://www.autohotkey.com/docs/v2/Scripts.htm#lib) and use `#Include <VMR>`
1. Download the latest pre-built version from the [`dist` folder](https://raw.githubusercontent.com/SaifAqqad/VMR.ahk/master/dist/VMR.ahk ':target=_blank') / [latest release](https://github.com/SaifAqqad/VMR.ahk/releases ':target=_blank') or follow the build instructions below
2. Include it using `#Include VMR.ahk` or copy it to a [library folder](https://www.autohotkey.com/docs/v2/Scripts.htm#lib ':target=_blank') and use `#Include <VMR>`

!> The current version of VMR ***only*** supports AHK v2, the AHK v1 version is still available on the [v1 branch](https://github.com/SaifAqqad/VMR.ahk/tree/v1)
!> The current version of VMR ***only*** supports AHK v2, the AHK v1 version is still available on the [v1 branch](https://github.com/SaifAqqad/VMR.ahk/tree/v1 ':target=_blank'), see [v1 docs](https://vmr-v1.vercel.app/ ':target=_blank').

## Basic usage
- Create an instance of the [`VMR`](./classes/vmr.md) class and log in to the API:
```ahk
- Create an instance of the [`VMR`](./classes/vmr) class and log in to the API:
```autohotkey
voicemeeter := VMR().Login()
```
- The [`VMR`](./classes/vmr.md) instance will have two arrays (`Bus` and `Strip`), as well as other properties/methods that will allow you to control voicemeeter in AHK
```ahk
- The [`VMR`](./classes/vmr) instance will have two arrays (`Bus` and `Strip`), as well as other properties/methods that will allow you to control voicemeeter in AHK
```autohotkey
voicemeeter.Bus[1].mute := true
voicemeeter.Strip[4].gain++
```
Expand All @@ -38,4 +38,4 @@ ahkpm run build
Autohotkey.exe ".\Build.ahk" ".\VMR.ahk" "..\dist\VMR.ahk" "<version number>"
```

<sub>This documentation is for VMR.ahk, If you need help with the Voicemeeter API check out [their documentation](http://download.vb-audio.com/Download_CABLE/VoicemeeterRemoteAPI.pdf)</sub>
<sub>This documentation is for VMR.ahk, If you need help with the Voicemeeter API check out [their documentation](http://download.vb-audio.com/Download_CABLE/VoicemeeterRemoteAPI.pdf ':target=_blank')</sub>
6 changes: 3 additions & 3 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
* [Home](/ 'VMR.ahk Docs')
* Examples
<!-- TODO: -->
<!-- * Examples
- [Bus/Strip](/examples/bus-strip.md 'Bus/Strip control examples')
- [Recorder](/VMR-Class/recorder-object.md 'Recorder examples')
- [Commands](/VMR-Class/command-object.md 'Commands examples')
- [Macro Buttons](/VMR-Class/macrobutton-object.md 'Macro Buttons examples')
- [Macro Buttons](/VMR-Class/macrobutton-object.md 'Macro Buttons examples') -->
* Classes
- [`VMR`](/classes/vmr.md 'VMR Class')
- [`VMRBus`](/classes/vmrbus.md 'VMRBus Class')
Expand All @@ -17,6 +18,5 @@
- [`VMRVBAN`](/classes/vmrvban.md 'VMRVBAN Class')
- [`VMRControllerBase`](/classes/vmrcontrollerbase.md 'VMRControllerBase Class')
- [`VMRError`](/classes/vmrerror.md 'VMRError Class')
- [`VMRConsts`](/classes/vmrconsts.md 'VMRConsts Class')
- [`VMRUtils`](/classes/vmrutils.md 'VMRUtils Class')
- [`VBVMR`](/classes/vbvmr.md 'VBVMR Class')
37 changes: 0 additions & 37 deletions docs/classes/__class_template.md

This file was deleted.

Loading

0 comments on commit 79d86ae

Please sign in to comment.