@akiver/csgo-voice-extractor 1.0.0 → 2.1.0

package/README.md

@@ -1,44 +1,13 @@
-# CSGO voice extractor
+# Counter-Strike voice extractor
 
-CLI to export players' voices from CSGO demos into WAV files.
+CLI to export players' voices from CSGO/CS2 demos into WAV files.
 
-**Valve Matchmaking demos do not contain voice audio data, hence there is nothing to extract from MM demos.**
+> [!WARNING]  
+> **Valve Matchmaking demos do not contain voice audio data, hence there is nothing to extract from MM demos.**
 
 ## Installation
 
-### Windows
-
-1. Download the last release from [GitHub](https://github.com/akiver/csgo-voice-extractor/releases)
-2. Copy/paste the following files from the `CSGO` installation folder next to the executable:
-
-- `tier0.dll`
-- `vaudio_celt.dll`
-
-> **Note**  
-> By default, these files are located in `C:\Program Files (x86)\Steam\steamapps\common\Counter-Strike Global Offensive\bin`
-
-### macOS
-
-1. Download the last release from [GitHub](https://github.com/akiver/csgo-voice-extractor/releases)
-2. Copy/paste the following files from the `CSGO` installation folder next to the executable:
-
-- `libtier0.dylib`
-- `libvstdlib.dylib`
-- `vaudio_celt.dylib`
-
-> **Note**  
-> By default, these files are located in `~/Applications/Steam/steamapps/common/Counter-Strike Global Offensive/bin/osx64`
-
-### Linux
-
-1. Download the last release from [GitHub](https://github.com/akiver/csgo-voice-extractor/releases)
-2. Copy/paste the following files from the `CSGO` installation folder next to the executable:
-
-- `libtier0_client.so`
-- `vaudio_celt_client.so`
-
-> **Note**  
-> By default, these files are located in `~/.steam/steam/steamapps/common/Counter-Strike Global Offensive/bin`
+Download the last release for your OS from [GitHub](https://github.com/akiver/csgo-voice-extractor/releases/latest).
 
 ## Usage
 
@@ -49,7 +18,7 @@ csgove.exe demoPaths... [-output]
 ```
 
 By default `.dll` files are expected to be in the same directory as the executable.
-You can change it by setting the `LD_LIBRARY_PATH` environment variable, example:
+You can change it by setting the `LD_LIBRARY_PATH` environment variable. Example:
 
 ```bash
 LD_LIBRARY_PATH="C:\Users\username\Desktop" csgove.exe
@@ -57,7 +26,7 @@ LD_LIBRARY_PATH="C:\Users\username\Desktop" csgove.exe
 
 ### macOS
 
-> **Warning**  
+> [!CAUTION]  
 > The environment variable `DYLD_LIBRARY_PATH` must be set before invoking the program and point to the location of the `.dylib` files!
 
 ```bash
@@ -66,7 +35,7 @@ DYLD_LIBRARY_PATH=. csgove demoPaths... [-output]
 
 ### Linux
 
-> **Warning**  
+> [!CAUTION]  
 > The environment variable `LD_LIBRARY_PATH` must be set before invoking the program and point to the location of the `.so` files!
 
 ```bash
@@ -109,6 +78,7 @@ csgove -output "C:\Users\username\Desktop\output" myDemo.dem
 
 - [Go](https://go.dev/)
 - [GCC](https://gcc.gnu.org/)
+- [Chocolatey](https://chocolatey.org/) (Windows only)
 
 _Debugging is easier on macOS/Linux **64-bit**, see warnings below._
 
@@ -116,27 +86,49 @@ _Debugging is easier on macOS/Linux **64-bit**, see warnings below._
 
 _Because the CSGO audio library is a 32-bit DLL, you need a 32-bit `GCC` and set the Go env variable `GOARCH=386` to build the program._
 
+> [!IMPORTANT]  
+> Use a unix like shell such as [Git Bash](https://git-scm.com/), it will not work with `cmd.exe`!
+
+> [!WARNING]  
+> The `$GCC_PATH` variable in the following steps is the path where `gcc.exe` is located.  
+> By default, it's `C:\TDM-GCC-64\bin` when using [TDM-GCC](https://jmeubank.github.io/tdm-gcc/) (highly recommended).
+
 1. Install `GCC` for Windows, [TDM-GCC](https://jmeubank.github.io/tdm-gcc/) is recommended because it handles both 32-bit and 64-bit when running `go build`.
    If you use [MSYS2](https://www.msys2.org/), it's important to install the 32-bit version (`pacman -S mingw-w64-i686-gcc`).
-2. Copy/paste `tier0.dll` and `vaudio_celt.dll` from the CSGO installation folder in the project's root folder.
-3. `CGO_ENABLED=1 GOARCH=386 go run .`
-
-> **Warning**  
+2. Install `pkg-config` using [chocolatey](https://chocolatey.org/) by running `choco install pkgconfiglite`.  
+   It's **highly recommended** to use `choco` otherwise you would have to build `pkg-config` and copy/paste the `pkg-config.exe` binary in your `$GCC_PATH`.
+3. Download the source code of [Opus](https://opus-codec.org/downloads/)
+4. Extract the archive, rename the folder to `opus` and place it in the project's root folder
+5. Open the `opus/win32/VS2015/opus.sln` file with Visual Studio (upgrade the project if asked)
+6. Build the `Release` configuration for `Win32` (**not `x64`** - it's important to build the 32-bit version!)
+7. Copy/paste the `opus.dll` file in `$GCC_PATH` and `dist/bin/win32-x64`
+8. Copy/paste the C header files located inside the `include` folder file in `$GCC_PATH\include\opus` (create the folders if needed)
+9. Copy/paste the `opus.pc.example` to `opus.pc` file and edit the `prefix` variable to match your `GCC` installation path **if necessary**.
+10. `PKG_CONFIG_PATH=$(realpath .) LD_LIBRARY_PATH=dist/bin/win32-x64 CGO_ENABLED=1 GOARCH=386 go run -tags nolibopusfile .`
+
+> [!WARNING]  
 > Because the Go debugger doesn't support Windows 32-bit and the CSGO lib is a 32-bit DLL, you will not be able to run the Go debugger.  
 > If you want to be able to run the debugger for the **Go part only**, you could comment on lines that involve `C/CGO` calls.
 
 ### macOS
 
-1. Copy/paste `libtier0.dylib`, `libvstdlib.dylib` and `vaudio_celt.dylib` from the CSGO installation folder in the project's root folder.
-2. `DYLD_LIBRARY_PATH=. CGO_ENABLED=1 GOARCH=amd64 go run .`
+> [!IMPORTANT]  
+> On macOS `ARM64`, the `x64` version of Homebrew must be installed!  
+> You can install it by adding `arch -x86_64` before the official command to install Homebrew (`arch -x86_64 /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`)
+
+1. Install [Homebrew](https://brew.sh) **x64 version**
+2. `arch -x86_64 brew install opus`
+3. `cp /usr/local/Cellar/opus/1.4/lib/libopus.0.dylib dist/bin/darwin-x64` (`arch -x86_64 brew info opus` to get the path)
+4. `DYLD_LIBRARY_PATH=dist/bin/darwin-x64 CGO_ENABLED=1 GOARCH=amd64 go run -tags nolibopusfile .`
 
-> **Warning**  
+> [!WARNING]  
 > On macOS ARM64, the Go debugger breakpoints will not work because the executable must target amd64 but your OS is ARM64.
 
 ### Linux
 
-1. Copy/paste `libtier0_client.so` and `vaudio_celt_client.so` from the CSGO installation folder in the project's root folder.
-2. `LD_LIBRARY_PATH=. CGO_ENABLED=1 GOARCH=amd64 go run .`
+1. `sudo apt install pkg-config libopus-dev`
+2. `cp /usr/lib/x86_64-linux-gnu/libopus.so.0 dist/bin/linux-x64` (you may need to change the path depending on your distro)
+3. `LD_LIBRARY_PATH=dist/bin/linux-x64 CGO_ENABLED=1 GOARCH=amd64 go run -tags nolibopusfile .`
 
 ## Building
 
@@ -154,7 +146,8 @@ _Because the CSGO audio library is a 32-bit DLL, you need a 32-bit `GCC` and set
 
 ## Credits
 
-Thanks to [@saul](https://github.com/saul) and [@ericek111](https://github.com/ericek111) for their [investigation](https://github.com/saul/demofile/issues/83#issuecomment-1207437098).
+Thanks to [@saul](https://github.com/saul) and [@ericek111](https://github.com/ericek111) for their [CSGO investigation](https://github.com/saul/demofile/issues/83#issuecomment-1207437098).  
+Thanks to [@DandrewsDev](https://github.com/DandrewsDev) for his work on [CS2 voice data extraction](https://github.com/DandrewsDev/CS2VoiceData).
 
 ## License
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@akiver/csgo-voice-extractor",
-  "version": "1.0.0",
-  "description": "CLI to export players' voices from CSGO demos into WAV files.",
+  "version": "2.1.0",
+  "description": "CLI to export players' voices from CSGO/CS2 demos into WAV files.",
   "author": "AkiVer",
   "license": "MIT",
   "bugs": {
@@ -27,6 +27,7 @@
   "keywords": [
     "Counter-Strike",
     "CS",
+    "CS2",
     "CSGO",
     "audio"
   ]