diff --git a/README.md b/README.md index 52ce788..613c871 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ -# pxTwitter // Twittpr +# FixTweet (formerly pxTwitter) + +## Embed Twitter videos, polls, translations, & more on Discord and Telegram! ![](https://skillicons.dev/icons?i=typescript,webpack,workers) -[![Webpack](https://github.com/dangeredwolf/pxtwitter/actions/workflows/webpack.yml/badge.svg)](https://github.com/dangeredwolf/pxtwitter/actions/workflows/webpack.yml) +[![Webpack](https://github.com/dangeredwolf/FixTweet/actions/workflows/webpack.yml/badge.svg)](https://github.com/dangeredwolf/FixTweet/actions/workflows/webpack.yml) -## A TwitFix-like service that _does way more_ with better privacy in mind. +## Inspired by [RobinUniverse's TwitFix](https://github.com/robinuniverse/TwitFix), but rewritten as a TypeScript Cloudflare Worker to scale, while also being packed with even more features. -### Embed videos, polls, Tweet translations, and more on Discord, Telegram, and others. +### Add `fx` before your Twitter link to make it `fxtwitter.com` (Alternative: `pxtwitter.com`) -#### On Discord, send a Twitter link and type `s/e/p` to make `twittpr.com`. - -#### Otherwise, just add `px` before `twitter` to make `pxtwitter.com` +### In a hurry? On Discord, send a Twitter link and type `s/e/p` to make `twittpr.com`. @@ -24,7 +24,7 @@ On Discord, we'll also automatically embed videos linked from other platforms, s ## Embed Polls -If you want to share the results of a Twitter poll, you can do so by just linking the Tweet using pxTwitter. +If you want to share the results of a Twitter poll, you can do so by just linking the Tweet using FixTweet. ![](https://cdn.discordapp.com/attachments/165560751363325952/1000487446393397328/pxTwitter.png) @@ -44,21 +44,21 @@ Just append a tweet with its 2-letter language code. So for English, add `/en` a ## Direct media links -Want to link directly to a Tweet's media without the embed? You can do easily do that using pxTwitter. +Want to link directly to a Tweet's media without the embed? You can do easily do that using FixTweet. -![Image demonstrating the feature](https://pxtwitter.com/dangeredwolf/status/1548119328498728960.jpg) +![Image demonstrating the feature](https://fxtwitter.com/dangeredwolf/status/1548119328498728960.jpg) There's a few supported ways to do this: -- Add `d.` or `dl.` before the domain (so, `d.twittpr.com` or `dl.pxtwitter.com`) +- Add `d.` or `dl.` before the domain (so, `d.twittpr.com` or `dl.fxtwitter.com`) - Add `.mp4` to the end of videos or `.jpg` to the end of images, after the tweet ID - Add `/dl` or `/dir` between the domain and the username Examples from above: - `https://d.twittpr.com/dangeredwolf/status/1548119328498728960` -- `https://pxtwitter.com/dangeredwolf/status/1548117889437208581.jpg` -- `https://pxtwitter.com/dl/dangeredwolf/status/1548117889437208581` +- `https://fxtwitter.com/dangeredwolf/status/1548117889437208581.jpg` +- `https://fxtwitter.com/dl/dangeredwolf/status/1548117889437208581` Tweets with multiple images are supported, so you can do something like this and it will pick the correct one: @@ -76,17 +76,17 @@ We use Twitter's color data for either the first image/video of the tweet, or th ## Built with privacy in mind -We don't save logs of what tweets you're sending, nor do we have a public record of what tweets are being embedded by pxTwitter. We use Cloudflare to cache pxTwitter responses to make repeat access faster. +We don't save logs of what tweets you're sending, nor do we have a public record of what tweets are being embedded by FixTweet. We use Cloudflare to cache FixTweet responses to make repeat access faster. -Furthermore, if the person who posted a pxTwitter link forgot to strip tracking, we strip it upon redirecting to the Tweet. +Furthermore, if the person who posted a FixTweet link forgot to strip tracking, we strip it upon redirecting to the Tweet. --- -## Why use pxTwitter? +## Why use FixTweet? -In many ways, pxTwitter has richer embeds and does more. Here's a table comparing some of pxTwitter's features compared to Twitter default embeds as well as other embedding services +In many ways, FixTweet has richer embeds and does more. Here's a table comparing some of FixTweet's features compared to Twitter default embeds as well as other embedding services -| | pxTwitter | Twitter default | vxTwitter (BetterTwitFix) | Twxtter (sixFix) | +| | FixTweet | Twitter default | vxTwitter (BetterTwitFix) | Twxtter (sixFix) | | --------------------------------------- | :---------------------------------: | :------------------------------: | :------------------------------------------: | :-----------------------------------: | | Embed Tweets / Images | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | Embed profile pictures on text Tweets | :heavy_check_mark: | :x: | :heavy_check_mark: | :heavy_check_mark: | @@ -106,7 +106,7 @@ In many ways, pxTwitter has richer embeds and does more. Here's a table comparin ¹ Discord will attempt to embed Twitter's video player, but it is unreliable -² Neither pxTwitter or vxTwitter have a public embed ledger, for privacy reasons. vxTwitter still stores all responses in a database / JSON file controlled by the owner. pxTwitter by contrast relies on Cloudflare caching of responses: there is no link store accessible to the owner. +² Neither FixTweet or vxTwitter have a public embed ledger, for privacy reasons. vxTwitter still stores all responses in a database / JSON file controlled by the owner. FixTweet by contrast relies on Cloudflare caching of responses: there is no link store accessible to the owner. ³ Discord uses a custom embed container for Twitter.com to enable multi-image, which is unfortunately not available to other websites. @@ -118,15 +118,15 @@ In many ways, pxTwitter has richer embeds and does more. Here's a table comparin --- -## Why pxTwitter is nicer to develop for and deploy +## Why FixTweet is nicer to develop for and deploy TwitFix and its derivatives have quite a few dependencies you need to rely on. You need to set up a server somewhere, install Python, all its dependencies, then either set up `youtube-dl` (more resource intensive) or [beg Twitter for API access](https://twitter.com/dangeredwolf/status/1438983606135832581), and optionally set up a database, otherwise it uses the file system to cache. -pxTwitter was written from the start as a lightweight, TypeScript-based Cloudflare Worker. Cloudflare Workers are completely free for up to 100,000 requests per day, per account. Cloudflare Workers are [fast to set up](https://developers.cloudflare.com/workers/get-started/guide/) and your script is distributed in their datacenters around the world for lower latency. +FixTweet was written from the start as a lightweight, TypeScript-based Cloudflare Worker. Cloudflare Workers are completely free for up to 100,000 requests per day, per account. Cloudflare Workers are [fast to set up](https://developers.cloudflare.com/workers/get-started/guide/) and your script is distributed in their datacenters around the world for lower latency. -pxTwitter does not need a database nor a Twitter API key: It takes a similar approach to `youtube-dl` where it pretends to be a logged-out Twitter web user, fetching a guest token and making API requests from there. As far as I can tell, this basically means we have "unlimited" read-only access to Twitter's API, including things they don't expose in their public API, useful for polls and other features. +FixTweet does not need a database nor a Twitter API key: It takes a similar approach to `youtube-dl` where it pretends to be a logged-out Twitter web user, fetching a guest token and making API requests from there. As far as I can tell, this basically means we have "unlimited" read-only access to Twitter's API, including things they don't expose in their public API, useful for polls and other features. -## Deploy pxTwitter yourself +## Deploy FixTweet yourself Clone the repo, install [Node.js](https://nodejs.org/) and run `npm install` in the repo directory. Copy `wrangler.example.toml` to `wrangler.toml` and add your [Cloudflare account ID](https://developers.cloudflare.com/fundamentals/get-started/basic-tasks/find-account-and-zone-ids/), and change the name of your worker if you need to. Also copy `.env.example` to `.env` and change HOST_URL, DIRECT_MEDIA_DOMAINS to your desired domain and whatever else you need to do. Authenticate with Cloudflare with `npx wrangler login`, then do `npx wrangler publish` (or `npm run publish`). @@ -144,4 +144,4 @@ Once you're set up with your worker on `*.workers.dev`, [add your worker to your ### Bugs or issues? -Feel free to [open an issue](https://github.com/pxTwitter/pxTwitter/issues), or [ping me on Twitter and I'll see what I can do](https://twitter.com/dangeredwolf). +Feel free to [open an issue](https://github.com/dangeredwolf/FixTweet/issues), or [ping me on Twitter and I'll see what I can do](https://twitter.com/dangeredwolf).