-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
1 addition
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,17 @@ | ||
# skribbl-relay | ||
|
||
# Skribbl-Relay | ||
This project is a relay server that takes chat messages & events from skribbl.io and forwards them to a Discord webhook. The Discord webhook URL is configured in the `.env` file. | ||
|
||
## Installation | ||
|
||
1. Clone the repository: `git clone https://github.com/w0ahL/Skribbl-Relay.git` | ||
2. Install the dependencies: `npm i` | ||
3. Configure the Discord webhook URL in the `.env` file. | ||
4. Start the relay: `node .` | ||
|
||
## Usage | ||
|
||
The relay will forward any chat messages and or events it receives from skribbl.io and sends it to the configured Discord webhook. | ||
|
||
## Contributing | ||
|
||
If you find any issues or have suggestions for improvements, please open an issue or submit a pull request. | ||
|
||
## License | ||
|
||
This project is licensed under the [GPL-3.0 License](LICENSE). |