Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bramus/mastodon-redirector

View Mastodon profiles on your Mastodon instance
https://github.com/bramus/mastodon-redirector

chrome-extension mastodon

Last synced: about 1 month ago
JSON representation

View Mastodon profiles on your Mastodon instance

Host: GitHub
URL: https://github.com/bramus/mastodon-redirector
Owner: bramus
License: mit
Created: 2022-11-23T15:25:25.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2023-09-09T19:46:04.000Z (over 1 year ago)
Last Synced: 2024-05-01T23:16:08.059Z (8 months ago)
Topics: chrome-extension, mastodon
Language: JavaScript
Homepage: https://chrome.google.com/webstore/detail/mastodon-view-profile/limifnkopacddgpihodacjeckfkpbfoe
Size: 56.6 KB
Stars: 93
Watchers: 6
Forks: 4
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Mastodon Redirector

| [![Available on the Chrome Web Store](./assets/chrome-webstore.svg)](https://chrome.google.com/webstore/detail/mastodon-redirector/limifnkopacddgpihodacjeckfkpbfoe) | [![Available on the Firefox Add-ons Website](./assets/firefox-addons.svg)](https://addons.mozilla.org/en-US/firefox/addon/mastodon-profile-redirect/) | [![Available as Bookmarklets](./assets/bookmarklet.svg)](#other-browsers) |
|-|-|-|

One thing that’s a bit of a hassle with Mastodon is that you can’t immediately follow people on other instances: you have to copy the username and search for it on the instance that hosts your account. Same story with favoriting and boosting their posts, when viewed on their instance’s URL.

To make this easier, this extension exists.

## Demo

https://github.com/bramus/mastodon-redirector/assets/213073/b0554662-a7c2-4261-aae0-957f38f47ffb

_This demo shows Chrome with the extension running. My Mastodon host is `front-end.social`. After configuring the extension, I can quickly jump from other Mastodon instances to my own instance where I can follow/favorite/boost._

## Installation

### Quick Links

Use one of the buttons below to be taken to the extension stores

### Chromium-based browsers

_This applies to browsers that are based on Chromium. This includes Google Chrome, Microsoft Edge, …_

The easiest way is to install it from [the Chrome Web Store](https://chrome.google.com/webstore/detail/mastodon-view-profile-on-my-mastodon-instance/limifnkopacddgpihodacjeckfkpbfoe)

Alternatively you can clone this repository and [load the extension unpacked](https://developer.chrome.com/docs/extensions/mv3/getstarted/development-basics/#load-unpacked). Before you can do this, you will need to [build the project](#development) though.

Don’t forget to [configure the extension](#configuration).

### Firefox

You can install the extension from [the Firefox Add-Ons Website](https://addons.mozilla.org/en-US/firefox/addon/mastodon-profile-redirect/). Because this extension uses Manifest v3, support is limited to Firefox 109 and up.

To run the extension in older versions of Firefox:

- Go to `about:config` and set `extensions.manifestV3.enabled` to `true`
- Hit the “download file” link on the [Add-Ons listing](https://addons.mozilla.org/en-US/firefox/addon/mastodon-profile-redirect/), upon which Firefox will prompt you to install it

Don’t forget to [configure the extension](#configuration).

### Other Browsers

If you can’t or won’t run the extension, you can use [the bookmarklets](./bookmarklet/) which also do the job.

## Configuration

- Chrome:
- Right click the extension icon and choose “Options”
- Enter the details and hit “Save Settings”
- Firefox:
- Right click the extension icon and choose “Manage Extension”
- Click the three dot menu next to the extension name and click “preferences”
- Enter the details and hit “Save Settings”

TIP: To get easy access, pin the extension icon

## Usage

When viewing a Mastodon page on a different instance than yours, hit the extension icon to get redirected to the profile/post on your instance. You can also use the `Alt`+`Shift`+`M` / `Option`+`Shift`+`M` shortcut to invoke the redirect.

Furthermore, this extension modifies the modals Mastodon shows on other instances. When wanting to follow/favorite/boost, a button with a direct link to your Mastodon instance will be injected into the markup.

## Development

### Building

Due to minor differences in support for extensions that use Manifest v3 in Chromium and Firefox, the code of this repository cannot directly be loaded. The code needs to be built.

```bash
make build-all
```

The built, yet still unpacked, extensions can be found in `./build/firefox` and `./build/chromium`.

Building depends on [`jq`](https://stedolan.github.io/jq/) which you must install first.

While actively developing, make use of the `watch` task. It will auto-rebuild whenever you save something in `src/`.

```bash
make watch
```

### Loading

For Chromium based browsers, [load the extension unpacked](https://developer.chrome.com/docs/extensions/mv3/getstarted/development-basics/#load-unpacked) from the `./build/chromium` folder. Alternatively you can use the `run-chrome` Make script:

```bash
make run-chrome
```

For Firefox, you’ll need [`web-ext`](https://extensionworkshop.com/documentation/develop/getting-started-with-web-ext/) to load the extension during development. A `web-ext-config.js` is included in the repository, so you can easily run `web-ext run`. Alternatively you can use the `run-firefox` Make script:

```bash
make run-firefox
```

## Support and bugs

This project is offered as is. However, I am open to receiving bug reports and accepting PRs to improve this extension.

## License

This project is released under the MIT public license. See the enclosed `LICENSE` for details.

## Acknowledgements

Icon by [Flatart](https://www.iconfinder.com/icons/4373112/logo_logos_mastodon_icon)