Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AZMindroma authored Oct 30, 2024
1 parent 154847a commit 978ed9e
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
# wordy
This is the new and improved word cloud Discord bot!

As opposed to the previous Python version, Wordy starts processing the messages as soon as it joins a server and is much faster doing so!
As opposed to the previous Python version, Wordy starts processing the messages as soon as it joins a server and is much faster at doing so!
It also automatically continues to process new messages as they are sent.

*Related blog article: https://teo-orthlieb.github.io/blog/user-word-cloud/*

## How to run it
The Discord Application creation step is usually the same for all bot that you self-host.
## Self-hosting guide
The Discord Application creation step is usually the same for all bots that you self-host.

### Create a Discord Application
- Go to https://discordapp.com/developers/applications/ and create your app
- Go to https://discord.com/developers/applications/ and create your app
- Add a bot to it and copy its token. You will need it later!
- Enable `PRESENCE INTENT`, `SERVER MEMBERS INTENT` and `MESSAGE CONTENT INTENT` in the bot tab
- Invite the bot with `https://discord.com/oauth2/authorize?client_id=CLIENT_ID&permissions=101376&integration_type=0&scope=bot+applications.commands` and replace `CLIENT_ID` with the Client ID of your app
- Invite the bot with `https://discord.com/oauth2/authorize?client_id=CLIENT_ID&permissions=101376&integration_type=0&scope=bot+applications.commands` and replace `CLIENT_ID` with the Client ID of your app (which you may find under the OAuth2 tab)

**Note:** The OAuth2 link includes following permissions: View Channels, Send Messages, Read Message History (to load messages sent before the bot joined), Attach Files (to send the word cloud image)

### Run it
- Clone the project wherever you want
- add the `token.txt` file at the root of the project (the root of the project is not inside the src folder, instead the folder with the Cargo files and the assets and src folder) and paste the token you copied before into the file (without anything else)
- Install the necessary tools to compile Rust programs with https://rustup.rs/
- Add the `token.txt` file at the root of the project (the root of the project is not inside the src folder, instead the folder with the Cargo files which includes the assets and src folder) and paste the token you copied before into this file (without anything else)
- Install the necessary tools to compile Rust programs by visiting https://rustup.rs/ and copypasting the command into your terminal and following its steps. A standard installation works to build this project.
- With a terminal positioned at the root of the project, run `cargo build --release` to build the project.
*Note: This will take a while because it's the first build you do, subsequent builds will be much faster.*
- Run the project with `cargo run --release`
Expand Down

0 comments on commit 978ed9e

Please sign in to comment.