mirror of
https://github.com/LeviSnoot/MediaFixer.git
synced 2024-12-02 18:00:02 +01:00
Update README.md
Added prerequisites and config info.
This commit is contained in:
parent
8420a72f20
commit
8649ecd9b6
1 changed files with 27 additions and 1 deletions
28
README.md
28
README.md
|
@ -1,6 +1,11 @@
|
|||
# MediaFixer
|
||||
|
||||
Auto changes twitter.com links on Discord to fxtwitter.com (or any other of your choice), embedding media correctly
|
||||
Auto changes links that commonly embed incorrectly (or not at all) on Discord to various embed services, embedding media correctly
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Node.js v16.17>
|
||||
- A discord bot with bot user, Message Content Intent enabled, permissions integer 92160 (Text Permissions: Send Messages, Manage Messages, Embed Links and Read Message History) and bot scope (basically just invite the bot to your server using this link https://discord.com/api/oauth2/authorize?client_id=YOUR_APPLICATION_ID&permissions=92160&scope=bot).
|
||||
|
||||
## Deployment
|
||||
|
||||
|
@ -20,3 +25,24 @@ Edit `config.json` to include your bot token.
|
|||
Deploy by running the following command:
|
||||
|
||||
node .
|
||||
|
||||
## Configuration
|
||||
|
||||
Edit `config.json`
|
||||
|
||||
nano config.json
|
||||
|
||||
The value for `token` must be the bot token found here: https://discord.com/developers/applications/YOUR_APPLICATION_ID/bot
|
||||
|
||||
Example:
|
||||
|
||||
"token": "Ysy._94ZUE7oATq9DCyaYr47.iQRJGwysWgP7SwpONUen9YbJZpXV_eG_43MjaYESEoI9UpAr",
|
||||
|
||||
You can change which service to use for parsing Twitter and Instagram links. By default fxtwitter and ddinstagram are used, but you can change this to any of your choosing.
|
||||
|
||||
Example:
|
||||
|
||||
"tweetParser": "https://twittpr.com/",
|
||||
"instaParser": "https://ddinstagram.com/"
|
||||
|
||||
It's important the full base url is in the string, like the example above, otherwise you may run into issues.
|
||||
|
|
Loading…
Reference in a new issue