ChrisChrome/discord-voice-recorder
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Fixed Readme

Browse source
This commit is contained in:
Sravanth C 2020-09-10 00:48:27 +05:30 committed by GitHub
parent a1d2653b0f
commit ea03e7ae1c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -1,12 +1,12 @@
# Discord Voice Recorder # Discord Voice Recorder
A tiny [Discord.js](https://discord.js.org/#/) script that can record your voice calls. Jump to [Installation & Usage](https://github.com/sravanth-chebrolu/discord-voice-recorder/installation-and-usage) to learn how to run the script and save the audio to your local device. A tiny [Discord.js](https://discord.js.org/#/) script that can record your voice calls. Jump to [Installation & Usage](https://github.com/sravanth-chebrolu/discord-voice-recorder#installation-and-usage) to learn how to run the script and save the audio to your local device.
<img src="https://i.imgur.com/y6JCNNA.png" width="400" align="center"> <img src="https://i.imgur.com/y6JCNNA.png" width="400" align="center">
# Installation and Usage ## Installation and Usage
## Installing ### Installing
Download the ZIP file and extract the contents to a folder or just clone the repository to your local storage using this command: Download the ZIP file and extract the contents to a folder or just clone the repository to your local storage using this command:
@ -16,7 +16,7 @@ git clone https://github.com/sravanth-chebrolu/discord-voice-recorder/
After extracting/cloning, run `npm i` to install the dependencies. **Ensure that you create a folder by the name** `recordings` **at the root directory.** After extracting/cloning, run `npm i` to install the dependencies. **Ensure that you create a folder by the name** `recordings` **at the root directory.**
## Setting Up the Local Environment ### 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. After creating it invite the bot to your server(to avoid potential problems, it is recommended that the bot be given adminstrator privilege when creating the initve link). Follow the next steps to finish the setup: To run this script locally you will need to [create a discord bot](https://discordpy.readthedocs.io/en/latest/discord.html) first. After creating it invite the bot to your server(to avoid potential problems, it is recommended that the bot be given adminstrator privilege when creating the initve link). Follow the next steps to finish the setup:
@ -33,9 +33,9 @@ Paste the bot token and the prefix value so your config.json will look like this
} }
``` ```
And you're all set. Note that all your recordings will be saved to `~/recordings/` if `~` is the root directory where you've installed the files to. And you're all set. Note that all your recordings will be saved to `~/recordings/` if `~` is the root directory.
## Running the Script ### Running the Script
To run the script just run: To run the script just run:
@ -45,7 +45,7 @@ npm start
The bot should be online and you can run the bot commands in your discord server. There are only two commands currently, The bot should be online and you can run the bot commands in your discord server. There are only two commands currently,
### Start Recording #### Start Recording
``` ```
<PREFIX>enter <VOICE_CHANNEL_NAME> <AUDIO_FILE_NAME> <PREFIX>enter <VOICE_CHANNEL_NAME> <AUDIO_FILE_NAME>
@ -53,7 +53,7 @@ The bot should be online and you can run the bot commands in your discord server
This will summon the bot into the voice channel mentioned in the arguments and start recording the audio, the audio will be saved to `~/recordings/AUDIO_FILE_NAME.pcm`. This will summon the bot into the voice channel mentioned in the arguments and start recording the audio, the audio will be saved to `~/recordings/AUDIO_FILE_NAME.pcm`.
### Stop Recording #### Stop Recording
``` ```
<PREFIX>exit <VOICE_CHANNEL_NAME> <PREFIX>exit <VOICE_CHANNEL_NAME>