FAQ
Last updated January 31, 2022
Table of Contents
- General
- Userstyles
- Why are
@updateURL
fields overriden? - Why are ratings different in Stylus’ search?
- How do view/install/update statistics work?
- How do I remove the
Get Stylus
button? - Why is mirroring source code updates not working?
- Why is there no support for traditional userstyles?
- “Bad style format” error
- How does mirroring source code work?
- Why are
General
Non-specific questions.
What is monetization strategy?
There is none. USw is funded from our own pockets.
All donations to Vednoc’s LiberaPay and/or Ko-fi go towards paying for the server costs as well as domain costs. In terms of numbers, the server costs $5 per month (as of July 2021), and domain costs $22 per year.
Why isn’t [insert here] implemented?
Well, it could be for various reasons. Contact us directly, or open a new issue over at the issue tracker and lets discuss it.
How can I contact the admins?
You could join us over at the Discord server, however you can also reach over the email at feedback@userstyles.world.
Userstyles
Questions regarding userstyles.
Why are @updateURL
fields overriden?
It’s done in order to avoid the possibility of tracking, as well as broken URLs.
Why are ratings different in Stylus’ search?
We have to accommodate for how Stylus displays them due to compatibility with USo: their ratings are on a scale of 1 to 3 (bad, okay, and good), meanwhile our ratings are on a scale of 1 to 5. That results in having to fit them within those bounds by multiplying the average rating by 3 then dividing by 5, or multiplying by 0.6, so that Stylus can display it using appropriate icons.
How do view/install/update statistics work?
As of July 2021, statistics work like so:
- The view counter increases when the user visits userstyle details page
(
/style/:id/:name
). - The install counter increases when the user visits userstyle install page
(
/api/style/:id.user.css
). - Update counter is calculated based on install statistics and when it was created/updated in database.
That’s the reason why some styles have more installs than views. You don’t necessary need to visit a style page to have it installed, e.g. third-party applications can directly install any style.
How do I remove the Get Stylus
button?
Stylus extension removes it automatically from v1.5.18
, or you can enable an
option provided by UserStyles.world Tweaks userstyle.
Why is mirroring source code updates not working?
First of all, make sure the checkbox “Mirror source code updates” is enabled. If it isn’t enabled, enable it then save changes.
If you’re mirroring source code from a different URL than your userstyle was originally imported from, make sure that the new URL location is correct. It’s correct if Stylus’ install/reinstall page shows up when you visit it.
Last but certainly not least, make sure that you increase @version
field in
the UserStyle metadata header. Userstyle will be mirrored if the new version
doesn’t match the one stored in our database.
Why is there no support for traditional userstyles?
Traditional userstyles don’t fit in the current workflow because they can’t be self-hosted like UserCSS userstyles. That means installing and/or updating any userstyle would be a manual process, which defeats the purpose of USw.
Converting your traditional userstyle is as simple as exporting it in Mozilla format and using the mandatory UserStyle metadata header that’s provided for you on the “Add userstyle” page. Documentation is on Stylus’ Writing UserCSS page.
“Bad style format” error
Currently, there is an issue with Stylus integration that allows users to add
broken userstyles because @-moz-document
fields are not included in the
process of adding styles written in “traditional” format. The issue causes
incorrectly formatted styles to apply globally (in other words, on all sites).
In order to prevent addition of more broken userstyles (roughly 25% of them uses
incorrect format), we have decided to not add them unless they pass a specific
criteria: all newly created userstyles need to have @-moz-document
fields.
To fix your userstyle, do the following:
- Open it in the editor
- Click on “Export” button to get code in Mozilla format
- Copy the source code to your clipboard (we’ll create a new style)
- Click on “Back to manage” button in order to enable “Usercss” format
- Toggle on “as Usercss” checkbox (☑), then click on “Write new style” button
- Paste your code below Stylus’ default Usercss template
- Remove the default
@-moz-document domain("example.com") { ... }
block - Edit UserStyle header with your info, links, etc.
- Finally, click on “Publish style” button
The resulting style should look along the lines of:
/* ==UserStyle==
@name Test style name
@namespace userstyles.world
@version 1.0.0
==/UserStyle== */
@-moz-document domain("userstyles.world") {
* {
color: crimson;
}
}
@-moz-document url-prefix("https://userstyles.world/docs/") {
h1, h2, h3 {
color: tan;
}
}
Please test your style to see whether it works after you publish it to USw. All broken styles will be removed. If you have issues, feel free to contact us via any of the links in the page footer or via our feedback email address.
P.S. If your style does apply globally, for the time being you’ll have to wrap it in the following:
@-moz-document regexp(".*") {
/* Your code goes here. */
}
/* You can also use the following. */
@-moz-document url-prefix("http") {
/* Your code goes here. */
}
How does mirroring source code work?
Every 30 minutes (00:30, 01:00, and so on) we check for style updates. Styles
are checked in batches of 25 (as of August 27, 2021) and not all at once, so it
can take up to a few minutes for your userstyle to be processed. The style will
be updated if the @version
field doesn’t match the one in our database.
If your userstyle isn’t being updated, read through troubleshooting steps first.