Skip to content

Commit 7596d2e

Browse files
committed
Added a patch for the timeout.unref error
This patch has to be applied to libraries, after 'npm install', by extracting the tar file.
1 parent 7982020 commit 7596d2e

File tree

3 files changed

+19
-9
lines changed

3 files changed

+19
-9
lines changed

README.md

+16-6
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,17 @@ LiveBot has been built so that the style and flow is similar to discord, and whi
2525
## Installation
2626
### Release (recommended)
2727

28-
To download a binary executable file, simply click on the latest [Release](../../releases) on the right side of the page, and download whichever zip or tar.gz file suits your needs. For example, if you use Windows, you should download the zip file that says "win32", if you use Linux, you will download the file that says "linux", and if you use macOS you will download the file that says "darwin". Once you download and decompress the file, just execute it as you would any other application.
28+
To download a binary executable file, simply click on the latest [Release](../../releases) on the right side of the page, and download whichever zip or tar.gz file suits your needs. For example, if you use Windows, you should download the zip file that says "win32", if you use Linux, you will download the file that says "linux", and if you use macOS you will download the file that says "darwin". Once you download and decompress the file, just execute it as you would any other application.
2929

3030

31-
### From Source (unstable)
31+
### From Source
3232

3333
LiveBot requires the [Node.js] JavaScript runtime to run.
3434

3535
You can download the source with [Git] (and get updates easily) or you can download as a zipped (compressed) file from GitHub. If you wish to download as a zip file, GitHub provides a big green "Code" button which you can press to download the file.
3636

37+
#### Step 1
3738
If you want to download with Git, a bash command to do so is found below:
38-
3939
```sh
4040
# with SSH (requires public key to be set)
4141
git clone "[email protected]:SebOuellette/LiveBot.git"
@@ -44,13 +44,23 @@ git clone "[email protected]:SebOuellette/LiveBot.git"
4444
git clone "https://github.com/SebOuellette/LiveBot.git"
4545
```
4646

47+
#### Step 2
4748
After cloning with Git or decompressing the zip file, you must open the directory the source is located in and install the dependencies with npm (or your preferred package manager) with the following command:
48-
4949
```sh
5050
npm install
5151
```
5252

53-
When your package manager is finished installing, you may start the program with `npm start`.
53+
#### Step 3
54+
As of 2025, LiveBot requires an patch for internal libraries. This patch is included in the repository, and can be applied using the following command:
55+
```sh
56+
tar -xvf patch.tar
57+
```
58+
59+
#### Step 4
60+
When your package manager is finished installing, you may start the program with:
61+
```sh
62+
npm start
63+
```
5464

5565
## Features
5666
### Token switcher (User menu)
@@ -71,7 +81,7 @@ The profile card is able to tell you the username, the avatar image, the discrim
7181

7282
### Generate Invite
7383

74-
LiveBot gives you the ability to generate an invite quickly from within the app, instead of having to go to your bot's application page in the Discord Developer portal. It can be found in the user settings page in the pull up menu. Just toggle all the permissions you'd like to give the invite (by default, everything recommended to use LiveBot's features is enabled).
84+
LiveBot gives you the ability to generate an invite quickly from within the app, instead of having to go to your bot's application page in the Discord Developer portal. It can be found in the user settings page in the pull up menu. Just toggle all the permissions you'd like to give the invite (by default, everything recommended to use LiveBot's features is enabled).
7585

7686
<img src='https://i.imgur.com/ggkyQtn.png' alt='Invite generator preview' style='border-radius: 10px;'>
7787

package.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@
2323
},
2424
"homepage": "https://github.com/SebOuellette/LiveBot#readme",
2525
"dependencies": {
26-
"discord.js": "^14.9.0",
27-
"electron": "^24.0.0"
26+
"discord.js": "^14.18.0",
27+
"electron": "^35.0.0"
2828
},
2929
"devDependencies": {
30-
"electron-packager": "^13.1.1"
30+
"@electron/packager": "^18.3.6"
3131
}
3232
}

patch.tar

100 KB
Binary file not shown.

0 commit comments

Comments
 (0)