Clean README
This commit is contained in:
Sravanth C
parent
48e29b4887
commit
bba684c4ee
69
README.md
69
README.md
|
|
@ -1,65 +1,49 @@
|
|||
# Discord Voice Recorder
|
||||
|
||||
A [Discord.js](https://discord.js.org/#/) script that can record discord voice calls. Summon a bot running this script to a voice channel to record a multi-user call, and save the recording locally!
|
||||
A [Discord.js](https://discord.js.org/#/) script which can record voice calls. Summon the bot to a voice channel, and voilà! the audio is piped right into your local machine.
|
||||
|
||||
Jump to [Installation & Usage](https://github.com/sravanth-chebrolu/discord-voice-recorder#installation-and-usage) to get started.
|
||||
|
||||
_Recording voice calls without prior consent violates privacy. Do not use this bot without approval. I'm not responsible for your insanity._
|
||||
|
||||
<img src="https://i.imgur.com/y6JCNNA.png" width="400" align="center">
|
||||
|
||||
### Index
|
||||
|
||||
- [Installation and Usage](#installation-and-usage)
|
||||
- [Download the Source and Install FFmpeg](#download-the-source-and-install-ffmpeg)
|
||||
- [Setting Up the Local Environment](#setting-up-the-local-environment)
|
||||
- [Running the Script](#running-the-script)
|
||||
- [Start Recording](#start-recording)
|
||||
- [Stop Recording](#stop-recording)
|
||||
- [Managing the Output](#managing-the-output)
|
||||
- [Merge Recording](#merge-recording)
|
||||
- [Convert the Merged File to MP3](#convert-the-merged-file-to-mp3)
|
||||
- [Managing the Output](#managing-the-output)
|
||||
- [Merge Recording](#merge-recording)
|
||||
- [Convert the Merged File to MP3](#convert-the-merged-file-to-mp3)
|
||||
- [Thanks](#thanks)
|
||||
|
||||
## Installation and Usage
|
||||
|
||||
### Download the Source and Install FFmpeg
|
||||
|
||||
Clone the repository :
|
||||
```
|
||||
git clone https://github.com/sravanth-chebrolu/discord-voice-recorder/
|
||||
```
|
||||
|
||||
Run `npm i` to install the dependent `node_modules`.
|
||||
|
||||
Next head over to the [FFmpeg.org](https://ffmpeg.org/download.html), and download the executables for your OS; If you're on Windows, double check if ffmpeg bin is on your path.
|
||||
Run `npm i` to download necessary `node_modules`. Then, head over to the [FFmpeg.org](https://ffmpeg.org/download.html), and download executables for your OS; If you're on Windows, double-check if the FFmpeg bin is on your path.
|
||||
|
||||
### Setting Up the Local Environment
|
||||
|
||||
To run this script locally you will need to [create a discord bot](https://discordpy.readthedocs.io/en/latest/discord.html) first. Invite your bot to your server(to avoid potential problems, it is recommended that the bot be given adminstrator privileges when creating the initve link). Follow the next steps to finish the setup:
|
||||
To run this script locally, [create a discord bot](https://discordpy.readthedocs.io/en/latest/discord.html) first. Invite the bot to your server, then:
|
||||
|
||||
1. Create a `config.json` file and a `recordings` folder at the root directory.
|
||||
2. Copy the the bot token from the [developer window](https://discord.com/developers/applications).
|
||||
3. Choose a prefix you want the bot to answer to.
|
||||
1. Create a `config.json` file and a `recordings` folder at the root folder.
|
||||
2. Paste the bot token (from [developer window](https://discord.com/developers/applications)) and any bot prefix into `config.json`, like so:
|
||||
|
||||
Paste the bot token and the prefix value to your config.json, like this:
|
||||
|
||||
```
|
||||
```yaml
|
||||
{
|
||||
"BOT_TOKEN": "<your-bot-token>",
|
||||
"PREFIX": "<your-prefix>"
|
||||
"BOT_TOKEN": "<YOUR_BOT_TOKEN>",
|
||||
"PREFIX": "<BOT_PREFIX>"
|
||||
}
|
||||
```
|
||||
|
||||
And you're all set. Note that all your recordings will be saved to the `recordings` directory.
|
||||
|
||||
### Running the Script
|
||||
|
||||
To run the script just run:
|
||||
|
||||
```
|
||||
npm start
|
||||
```
|
||||
|
||||
The bot should be online and you can run the bot commands in your discord server. There are only two commands currently,
|
||||
Run `npm start`, the bot should be online.
|
||||
|
||||
#### Start Recording
|
||||
|
||||
|
|
@ -67,7 +51,7 @@ The bot should be online and you can run the bot commands in your discord server
|
|||
<PREFIX>enter <VOICE_CHANNEL_NAME>
|
||||
```
|
||||
|
||||
**Note:** You should hear a 'drop' sound when you run the command indicating that the connection has been established. If you don't hear the sound, there's a problem with your ffmpeg installation.
|
||||
**Note:** You should hear a 'drop' sound after running this. If you don't, there's a problem with your FFmpeg installation.
|
||||
|
||||
#### Stop Recording
|
||||
|
||||
|
|
@ -75,31 +59,32 @@ The bot should be online and you can run the bot commands in your discord server
|
|||
<PREFIX>exit
|
||||
```
|
||||
|
||||
### Managing the Output
|
||||
## Managing the Output
|
||||
|
||||
Keep in mind that the audio will be recorded in the [PCM format](https://en.wikipedia.org/wiki/Pulse-code_modulation).
|
||||
The audio will be recorded in [PCM format](https://en.wikipedia.org/wiki/Pulse-code_modulation) and saved to the `/recordings` directory.
|
||||
|
||||
> To work with PCM audio, you could use software such as [Audacity](https://www.audacityteam.org/). To import the audio into Audacity, open File > Import > Raw Data... and then select your audio file. You should select Signed 16-bit PCM as the encoding, a Little-endian byte order, 2 Channels (Stereo) and a sample rate of 48000Hz.
|
||||
_To work with PCM audio, you could use software such as [Audacity](https://www.audacityteam.org/). To import the audio into Audacity, open File > Import Raw Data... and then select your audio file. You should select Signed 16-bit PCM as the encoding, a Little-endian byte order, 2 Channels (Stereo) and a sample rate of 48000Hz._
|
||||
|
||||
#### Merge Recording
|
||||
### Merge Recording
|
||||
|
||||
The output for each piece of audio stream is written to a unique file. To merge all output files, run:
|
||||
|
||||
The output is saved as a seperate file for each audio stream, and is named with the timestamp at which it was created. To merge all output files, run:
|
||||
```
|
||||
node ./bin/merge.js
|
||||
```
|
||||
|
||||
This will pipe data from the individual PCM files to a `merge.pcm` file in the `recordings` directory.
|
||||
This creates a `merge.pcm` in the `/recordings` directory.
|
||||
|
||||
**IMPORTANT:** Do not forget to empty your `recordings` folder after each recording session. Running `./bin/merge.js` without deleting a previously created `merge.pcm` will make bad things happen. This will be fixed later.
|
||||
**Note:** Do not forget to empty your `recordings` folder after each session. Running `./bin/merge.js` otherwise, will dump large merge files.
|
||||
|
||||
#### Convert the Merged File to MP3
|
||||
### Convert the Merged File to MP3
|
||||
|
||||
Since FFmpeg is a dependency, we can use it to convert the raw `.pcm` file to a more user friendly `.mp3` format, mentioned in issue [#3](https://github.com/sravanth-chebrolu/discord-voice-recorder/issues/3) this can be done using:
|
||||
As mentioned in issue [#3](https://github.com/sravanth-chebrolu/discord-voice-recorder/issues/3), to convert pcm to mp3, run:
|
||||
|
||||
```
|
||||
ffmpeg -f s16le -ar 44.1k -ac 2 -i merge.pcm output.mp3
|
||||
```
|
||||
|
||||
# Thanks
|
||||
## Thanks
|
||||
|
||||
Also, huge thanks to [@eslachance](https://github.com/eslachance) for the gist, which is what this repo is based on. https://gist.github.com/eslachance/fb70fc036183b7974d3b9191601846ba.
|
||||
Special thanks to [@eslachance](https://github.com/eslachance) for the [gist](https://gist.github.com/eslachance/fb70fc036183b7974d3b9191601846ba). It is what inspired me to make this repo.
|
||||
|
|
|
|||
Loading…
Reference in a new issue