Skip to content

Commit

Permalink
Update examples + README for v2
Browse files Browse the repository at this point in the history
  • Loading branch information
SaifAqqad committed Nov 25, 2023
1 parent 6fa770a commit 0c49d0e
Show file tree
Hide file tree
Showing 9 changed files with 1,530 additions and 224 deletions.
41 changes: 25 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,31 +6,40 @@ VMR.ahk
</p>

## Getting Started

To use `VMR.ahk` in your script, follow one of the following methods:

### A - ahkpm installation

1. Install and set up [ahkpm](https://github.com/joshuacc/ahkpm), then run `ahkpm install gh:SaifAqqad/VMR.ahk`
2. Run `ahkpm include -f my-script.ahk gh:SaifAqqad/VMR.ahk` to add an include directive in your script
###### Replace *my-script.ahk* with your script's path
2. Run `ahkpm include gh:SaifAqqad/VMR.ahk -f my-script.ahk` to add an include directive in your script
###### Replace *my-script.ahk* with your script's path

### B - Manual Installation
1. Download the latest pre-built version from the [`dist` folder](https://raw.githubusercontent.com/SaifAqqad/VMR.ahk/master/dist/VMR.ahk) 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/Functions.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) 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>`

**Note: The current version of VMR only works with AHK v2, The AHK v1 version is available on the [v1 branch](https://github.com/SaifAqqad/VMR.ahk/tree/v1)**

## Usage

3. Create an instance of the VMR class and log in to the API:
```ahk
voicemeeter:= new VMR().login()
```
4. The `VMR` object will have two arrays (`bus` and`strip`), as well as other objects, that will allow you to control voicemeeter in AHK.
```ahk
voicemeeter.bus[1].mute:= true
voicemeeter.strip[4].gain++
```
- Create an instance of the VMR class and log in to the API:
```ahk
voicemeeter := VMR().login()
```
- The `VMR` object will have two arrays (`Bus` and `Strip`), as well as other objects, that will allow you to control voicemeeter in AHK.
```ahk
voicemeeter.Bus[1].mute := true
voicemeeter.Strip[4].gain++
```

##### For more info, check out the [documentation](https://saifaqqad.github.io/VMR.ahk/)

## Build instructions
To build `VMR.ahk` yourself, run the build script:

To build `VMR.ahk`, either run the vscode task `Build VMR` or run the build script manually:

```powershell
.\Build.ahk <version number>
Autohotkey.exe ".\Build.ahk" ".\VMR.ahk" "..\dist\VMR.ahk" "<version number>"
```
##### For more info, check out the [documentation](https://saifaqqad.github.io/VMR.ahk/)
2 changes: 1 addition & 1 deletion ahkpm.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "1.2.0",
"version": "2.0.0-alpha",
"description": "AutoHotkey wrapper class for Voicemeeter's Remote API",
"repository": "https://github.com/SaifAqqad/VMR.ahk",
"website": "https://saifaqqad.github.io/VMR.ahk",
Expand Down
Loading

0 comments on commit 0c49d0e

Please sign in to comment.