twitter-mastodon-relay/README.md

49 lines
1.6 KiB
Markdown

# twitter-mastodon-relay
Twitter -> Mastodon relay running on Node. No rate limits, entirely based on Nitter instances.
## installation
```sh
git clone https://git.gay/a/twitter-mastodon-relay.git
cd twitter-mastodon-relay
npm i
cp config.example.json
# edit your config according to your needs here, see below for more info
npm start
```
### configuration
The default config looks like this:
```json
{
"account": "jack",
"instance": "https://nitter.pussthecat.org",
"credentials": {
"url": "https://mastodon.fake.instance",
"accessToken": "xxx"
},
"spoiler": "Mirrored from {{username}} on Twitter.",
"visibility": "unlisted",
"updateInterval": 30000,
"prev": "",
"linkOriginal": true
}
```
- ``account`` is the Twitter account you wish to mirror.
- ``instance`` is the Nitter instance you'd like to use
- ``credentials`` are your Mastodon credentials.
- ``url`` is the URL of the Mastodon instance you are using.
- ``accessToken`` is the access token to the application you made for this.
- ``spoiler`` is the text used to spoiler/add content warnings to your posts.
- ``visibility`` is the visibility of the mirrors. ``public``, ``unlisted``, ``private`` and ``direct`` are the accepted values.
- ``prev`` is the previous post mirrored by the bot, don't mess with this value.
- ``linkOriginal`` is a boolean value to determine if the toot should mirror posts with or without the link.
## roadmap
- Twitter threads being mirrored properly
- Videos be mirrored properly
- Replace Nitter with own scraper
## instances
- [Relay of @yoloswagstudios, maintained by @tacohitbox@catcatnya.com](https://mas.to/@yoloswag)