kopia lustrzana https://github.com/lartsch/FediAct
Lartsch
GitHub
commit
06524ab364
44
README.md
44
README.md
|
|
@ -1,5 +1,5 @@
|
|||
# FediAct (v0.9.7)
|
||||
A Chrome/Firefox extension that simplifies following and post interactions on other Mastodon instances than your own.
|
||||
A Chrome/Firefox extension that simplifies follow and post interactions on Mastodon instances other than your own.
|
||||
|
||||
**Features**:
|
||||
- Supports Mastodon v3 + v4
|
||||
|
|
@ -17,7 +17,7 @@ A Chrome/Firefox extension that simplifies following and post interactions on ot
|
|||
**Important notes**:
|
||||
- All data is processed locally only
|
||||
- Performance depends on the performance (and rate limiting) of your home instance and to some degree of the external instance you are browsing (read more [below](#additional-notes))
|
||||
- Some toots cannot be resolved to your home (in cases where searching the post manually would also not work)
|
||||
- Some toots cannot be resolved to your home (in cases where searching for the post manually would not work either)
|
||||
|
||||
## Navigation
|
||||
* [Installation](#installation)
|
||||
|
|
@ -66,16 +66,16 @@ If you have set your home instance correctly, you can now interact on other Mast
|
|||
|
||||
**Other**
|
||||
|
||||
- Actions: Set if actions (following, boosting etc.) should be performed when clicking or double clicking (default: on)
|
||||
- Actions: Set if actions (following, boosting, etc.) should be performed when clicking or double clicking (default: on)
|
||||
- _**Usage tip:**_ Disable this if you only want redirects on double click or when replying without automatically performing the action
|
||||
- Show follows: Set if the following state of accounts should be reflected on profiles / account cards (default: on)
|
||||
- _**Please note:**_ When disabled, the state will still be changed on interaction and stored until the page is reloaded of left
|
||||
- _**Please note:**_ When disabled, the state will still be changed when interacting and stored until the page is reloaded or left
|
||||
- Show toot state: Set if the state of toots (favourited, boosted, bookmarked) should be reflected (default: on)
|
||||
- _**Please note:**_ When disabled, the state will still be changed on interaction and stored until the page is reloaded of left
|
||||
- Hide muted/blocked: If enabled, your blocked/muted users/instances will be synched every 60 seconds and all according toots, boosts and toots with mentions will be hidden (default: off)
|
||||
- _**Please note:**_ When disabled, the state will still be changed when interacting and stored until the page is reloaded or left
|
||||
- Hide muted/blocked: If enabled, your blocked/muted users/instances will be synched every 60 seconds and all matching toots, boosts and toots with mentions will be hidden (default: off)
|
||||
- _**Please note:**_ There are cases where hiding can fail and this is disabled by default because it can decrease performance
|
||||
- API delay: If enabled, there can only be one API request to your home instance per 500ms (default: on)
|
||||
- _**Please note:**_ Disabling this will likely lead to the extension stopping to work because your home instance uses rate limiting if too many requests come from your IP. 500ms have proven to prevent error 429 for the instances I have tested.
|
||||
- _**Please note:**_ Disabling this will likely result in the extension not working because your home instance uses rate limiting if too many requests come from your IP. 500ms has proven to prevent error 429 for the instances I have tested.
|
||||
|
||||
**Mode**
|
||||
- Run if logged in: Enable FediAct on external instances if you are logged in there as well (default: off)
|
||||
|
|
@ -84,7 +84,7 @@ If you have set your home instance correctly, you can now interact on other Mast
|
|||
## FAQ
|
||||
**Why does it need permission for all websites?**
|
||||
|
||||
The addon needs to determine if the site you are currently browsing is a Mastodon instance or not. For that matter, it requires access to all sites. Otherwise, each existing Mastodon instance would have to be explicitly added.
|
||||
The addon needs to determine whether or not the site you are currently browsing is a Mastodon instance. For that to work, it requires access to all sites. Otherwise, each existing Mastodon instance would have to be explicitly added.
|
||||
|
||||
**Can I use this on Android?**
|
||||
|
||||
|
|
@ -92,11 +92,11 @@ Yes! There are three options that I am aware of: Kiwi Browser (Chromium with add
|
|||
|
||||
**Can I use this on iOS?**
|
||||
|
||||
As of now, this addon does not support Safari and I am not aware of any other browsers on iOS, that support extensions. So no, not at this time. PLEASE NOTE: Safari support will not happen at this time since Apple wants 99$ per year for the [Developer Program membership](https://developer.apple.com/support/compare-memberships), which is a requirement.
|
||||
As of now, this addon does not support Safari and I am not aware of any other browsers on iOS, that support extensions. So, no, not at this time. PLEASE NOTE: Safari support will not happen at this time since Apple wants 99$ per year for the [Developer Program membership](https://developer.apple.com/support/compare-memberships), which is a requirement.
|
||||
|
||||
**Can you add feature XY?**
|
||||
|
||||
Feel free to create an issue here on Github and I will look into it.
|
||||
Feel free to create an issue here on GitHub and I will look into it.
|
||||
|
||||
## Screenshots / GIFs
|
||||
v0.8.0
|
||||
|
|
@ -110,13 +110,13 @@ v0.8.0
|
|||
</details>
|
||||
|
||||
## Manual installation
|
||||
1. Download the [latest Github release](https://github.com/Lartsch/FediAct/releases/latest) for your browser (chrome or firefox)
|
||||
1. Download the [latest GitHub release](https://github.com/Lartsch/FediAct/releases/latest) for your browser (Chrome or Firefox)
|
||||
### Chrome
|
||||
2. Unzip the downloaded file somewhere
|
||||
3. Go to your Chrome extension page (URL: chrome://extensions) and enable developer mode
|
||||
4. Click the "Load unpacked" button and then select the unzipped folder
|
||||
|
||||
Note: Some Chromium browsers allow to directly load a .zip file - you can use it if available for you
|
||||
Note: Some Chromium browsers allow you to directly load a .zip file - you can use it if available
|
||||
|
||||
### Firefox
|
||||
2. Open the debugging page (URL: about:debugging)
|
||||
|
|
@ -124,14 +124,14 @@ Note: Some Chromium browsers allow to directly load a .zip file - you can use it
|
|||
4. Click the "Load Temporary Add-on" button and then select the downloaded Firefox ZIP file
|
||||
|
||||
### Install in Firefox for Android
|
||||
Since a while, Firefox on Android only allows a [curated list](https://addons.mozilla.org/en-US/android/search/?promoted=recommended&sort=random&type=extension) of addons to install, preventing installation of anything else. The following explanation will guide you how to install it from the webstore anyways.
|
||||
For a while now, Firefox on Android has only allowed installing from a [curated list](https://addons.mozilla.org/en-US/android/search/?promoted=recommended&sort=random&type=extension) of addons, preventing installation of anything else. The following instructions will guide you through installing it from the webstore anyway.
|
||||
|
||||
**Requirements:**
|
||||
- Firefox [**Nightly**](https://play.google.com/store/apps/details?id=org.mozilla.fenix) for Android
|
||||
|
||||
**Steps:**
|
||||
1. In Firefox, go to Settings > About Firefox Nightly
|
||||
2. Click the Firefox logo 5 times to enable developer options
|
||||
2. Click the Firefox logo 5 times to enable Developer options
|
||||
3. Go back to Settings > Custom Add-on Collection
|
||||
4. Enter the following data:
|
||||
- ID: 17665294
|
||||
|
|
@ -139,27 +139,27 @@ Since a while, Firefox on Android only allows a [curated list](https://addons.mo
|
|||
5. Click OK, Firefox will close - reopen it
|
||||
6. FediAct will now be available in the Add-ons menu of Firefox Nightly
|
||||
|
||||
To update the addon instantly, simply remove and re-install it. Not sure when/if auto-update triggers in Firefox.
|
||||
To update the addon instantly, simply remove and re-install it. I don't know if or when auto-update triggers in Firefox.
|
||||
|
||||
I included all of the default add-ons in the custom collection, so you will not miss out on any of those. Of course, you can create [your own collection](https://support.mozilla.org/en-US/kb/how-use-collections-addonsmozillaorg) as well.
|
||||
|
||||
## Additional notes
|
||||
1. Support for other Fedi software is planned
|
||||
2. It can have several reasons why resolving/interacting might not work:
|
||||
- Not logged in to your home instance
|
||||
- Element identifiers have changed / instance uses an unsupported flavour
|
||||
2. There are several reasons why resolving/interacting might not work including:
|
||||
- Not being logged in to your home instance
|
||||
- Element identifiers have changed / the instance uses an unsupported flavour
|
||||
- The external instance you are browsing or the originating instance of a toot is not Mastodon
|
||||
- Your home instance has strong rate limiting and limited your IP
|
||||
- Your home instance / the external instance / the original instance of a toot have defederated / are moderated
|
||||
- The toot has not yet federated to your home instace (follow the account and toots should start federating)
|
||||
- The instance you are browsing does not use 302 redirects for external toots
|
||||
- The network conditions of your home instance or the external instance are bad (slow speed)
|
||||
- Maybe it also plays a role if the toot is set to unlisted on its original instance
|
||||
3. There can be delays since API calls have to be made and it is attempted to prevent error 429 (too many requests). Especially if a page has many toots or you are scrolling through a feed really fast.
|
||||
4. If the extension fails to resolve content, the affected buttons will behave like usually (popup modal) and a notice ("Unresolved") is added to the toot
|
||||
- That a toot is set to unlisted on its original instance may play a role
|
||||
3. There can be delays because API calls have to be made and it is tries to avoid error 429 (too many requests). Especially if a page has many toots or you are scrolling through a feed really fast.
|
||||
4. If the extension fails to resolve content, the affected buttons will behave as if the extension weren't active (popup modal) and a notice ("Unresolved") is added to the toot
|
||||
|
||||
## Todos / Planned features
|
||||
Check out the according [Github project](https://github.com/users/Lartsch/projects/2) to see planned features and todos. They are sorted from most important to least important.
|
||||
Check out the [GitHub project](https://github.com/users/Lartsch/projects/2) to see planned features and todos. They are sorted from most important to least important.
|
||||
|
||||
## Contributing
|
||||
Feel free to create [issues](https://github.com/Lartsch/FediAct/issues) for bugs and feature suggestions. Even better: Create pull requests for whatever improvements you can make! :)
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue