ProToots/README.md

77 lines
3.6 KiB
Markdown
Raw Normal View History

2023-05-29 08:19:55 +00:00
# ProToots (v1.0.2)
2023-05-25 13:37:24 +00:00
2023-05-24 16:47:04 +00:00
A Firefox extension which displays an author's pronouns next to their name on Mastodon.
2023-05-28 10:18:37 +00:00
![A Mastodon screenshot showing off pronouns next to a person's name](documentation/example_screenshot.png)
---
2023-05-24 16:47:04 +00:00
2023-05-24 17:20:01 +00:00
## Download/Installation
2023-05-25 13:37:24 +00:00
2023-05-28 10:18:37 +00:00
The extension is available on the firefox store!
[<img src="documentation/get-the-addon-178x60px.png">](https://addons.mozilla.org/en-US/firefox/addon/protoots/)
Alternatively you can download an unsigned version from the [releases page](https://github.com/ItsVipra/Protoots/releases).
---
## Known issues
2023-05-25 13:37:24 +00:00
2023-05-29 08:19:55 +00:00
- Pronouns are not displayed on all notifications. See [#25](https://github.com/ItsVipra/ProToots/issues/25)
- Pronouns are not displayed in the direct messages tab. See [#26](https://github.com/ItsVipra/ProToots/issues/26)
2023-05-28 10:18:37 +00:00
- Pronouns on expanded posts are only shown if they have been cached before.
2023-05-29 08:19:55 +00:00
- Pronouns are not displayed on replies of an expanded post. See [#27](https://github.com/ItsVipra/ProToots/issues/)
2023-05-24 18:05:34 +00:00
2023-05-28 10:18:37 +00:00
---
2023-05-24 16:47:04 +00:00
## FAQ
2023-05-25 13:37:24 +00:00
2023-05-28 10:18:37 +00:00
### Why does ProToots need permission for all websites?
2023-05-24 16:47:04 +00:00
> The addon needs to determine whether or not the site you are currently browsing is a Mastodon server. For that to work, it requires access to all sites. Otherwise, each existing Mastodon server would have to be explicitly added.
2023-05-28 10:18:37 +00:00
### Why can't i see any ProPlates?
2023-05-29 08:19:55 +00:00
> It is likely your instance is not supported. This is because forks of Mastodon all work slightly differently and we cannot account for every version out there.
2023-05-28 10:18:37 +00:00
> If ProToots isn't working on your instance please tell your admins to contact us here on Github.
### ProPlates don't have a background/low contrast on my instance.
2023-05-29 08:19:55 +00:00
> Mastodon does not provide set variables for element colors, so we have to adjust the plate styling to each theme. If they're not displaying correctly please tell your admins to [follow these steps to style ProPlates](#how-do-i-style-proplates-to-correctly-display-on-my-themes).
2023-05-28 10:18:37 +00:00
### Somebody has added/changed pronouns, why is ProToots still showing no/their old pronouns?
2023-05-29 08:19:55 +00:00
> In order to strain your instance less pronouns are cached for 24h, so it might take up to a day to see this change reflected.
> Alternatively you can simply hit the "Reset cache" button in the addon settings.
2023-05-28 10:18:37 +00:00
### Why does the ProPlate just show a link?
2023-05-29 08:19:55 +00:00
> When an author only provides their pronouns as a pronouns.page link we display that instead. In the future we'll be able to extract pronouns from the given link. (See [#7](https://github.com/ItsVipra/ProToots/issues/))
2023-05-28 10:18:37 +00:00
---
## Instance admin info
### Protoots aren't working on my instance
2023-05-29 08:19:55 +00:00
> Currently ProToots only looks for specific classes and IDs. If your instance has changed the name of those, ProToots will not find them.
> Especially the **parent div with id 'Mastodon'** is important, since without that no other code will run.
> Please open an issue with your server name and info on which names you've changed, so we can add support for your instance.
> We're also working on a way to more easily support many different types of fedi software, such as Misskey or Akkoma. See [#12](https://github.com/ItsVipra/ProToots/issues/12)
2023-05-28 10:18:37 +00:00
### How do I style ProPlates to correctly display on my themes?
2023-05-29 08:19:55 +00:00
> You can set their background-color and color attribute for each theme.
> To do this simply add some CSS to your server. [Here's how.](https://fedi.tips/customising-your-mastodon-servers-appearance/)
2023-05-28 10:18:37 +00:00
> See [our default styles](/src/styles/proplate.css) for reference.
---
## Developer setup
2023-05-24 16:47:04 +00:00
2023-05-28 10:18:37 +00:00
- Clone the repository
- Install the required dependencies using `npm install`
- Start the development workflow with `npm start`
2023-05-28 10:18:37 +00:00
- Mess around with with [protoots.js](/src/content_scripts/protoots.js)
- Trans rights!