A couple of weeks ago, @shazbot made this post about a project that they were working on. Since then, @shazbot, @ori, @minnieo and I have been hard at work, and we are excited to finally announce the official release of kbin Enhancement Suite (KES)!
kbin has seen an explosion of user-made add-ons, but keeping track of them in one place, letting them share settings with one another, and toggling them on and off can be a challenge. KES is an expandable add-on manager that aims to rectify this by providing a unified interface and framework for script makers to collaborate, and letting you use them all in one place.
KES brings together userscripts from the community, with a built-in settings menu that lets you tailor your experience to your liking. It also offers a flexible framework that empowers script authors to effortlessly integrate scripts into KES and set up custom input fields with no additional code.
KES gives you a single window onto a collection of enhancements that is growing by the day. And those features can be added to by you!
What the feed looks like with everything enabled
The comments with everything turned on
Features
We’ve focused on making customizing your kbin experience as easy as possible, whether you are on mobile or desktop. After we sort out the bug reports from this release, we plan on adding many more features! Here’s what we have so far:
- Collapsible comments with nesting (by @artillect)
- Use slash commands to add emoticons in text areas (by @minnieo)
- Add syntax highlighting (with customizable themes) to code blocks (by @ori)
- Show instance names next to non-local users and communities (by @artillect)
- Add a link to message users on your instance next to their usernames (by @shazbot)
- Hide upvote/downvote buttons and reputation (by @artillect)
- Show more detailed timestamps on threads and comments (by @shazbot)
- Hide thumbnails on threads (by @shazbot)
- Add link to subscribed magazines to the navbar (by @shazbot)
- Replace or hide the kbin logo in the navbar (by @shazbot)
- Add “OP” label next to thread author’s username in comments (by @shazbot)
- Convert navigation links on profile pages into a dropdown (by @shazbot)
Each of these can be toggled in the settings menu, and some of them have additional configuration options, such as setting custom labels, colors, etc.
New features are added on a rolling basis and the menu pages will update on the fly to reflect this new content.
Installation
Click here to install KES, and follow your userscript manager’s prompt to complete the installation.
If you don’t have a userscript management extension, you can install one of these, and then install KES using the link above:
- TamperMonkey (desktop, or Firefox on Android)
- Userscripts (iOS 15+)
Once KES is successfully installed, access the settings menu by clicking on the wrench icon located at the top-right corner next to your username. From there, you can enable the features you like, and customize your browsing experience.
More information
For bug reports and feature requests, visit our GitHub repository’s issues page. If you have any questions or need assistance, don’t hesitate to ask here or make a post on /m/enhancement!
Developers
If you are a userscript author, we’d love it if you could try porting your userscripts into KES, or try writing completely new ones for it! @shazbot has made it easy to integrate your scripts: you just need to add your script’s information to manifest.json
, make a few small modifications to your script, add it all to the GitHub repository, and you’re good to go!
KES benefits:
- Turnkey integration: a simple, declarative framework for dynamically adding features to the UI without touching the underlying code
- Sharing of user-defined settings through script namespaces: access your script settings, and those from other scripts, through a well-defined object
- Automatically responds to infinite scroll and page reload events
- Attribution of script authors
- Easily toggle scripts on/off
Explore KES’s documentation here to get started. If you have any questions, feel free to reach out here, on /m/enhancement, or at our GitHub repository.
I love it! I have one question though, wouldn’t it be better to separate KES version from all of the userscript/settings versions? Updating from 1.1.4 to 1.1.6 only moved the version up in userscript info, since all the userscripts are updated separately anyway. Updating KES would make sense only if something in
kes.user.js
is changed, right now users just get KES update prompts that do nothing.This is done to force re-cache of the new version of a userscript when it gets added as a feature. MINOR version bumps indicate addition of a mod (userscript) or internal feature, while PATCH version bumps indicate a hotfix. By design in GM, when the version number of the main script is bumped, it will redownload the requisite remote resources. We leverage this functionality to serve new files.
This should partially be rectified by the addition of the changelog link (flask icon) in 1.2.0.
When new mods are added to KES, they are integration tested, so bumping the MINOR version does imply some feature change to the KES interaction itself, albeit not necessarily at the code level.
The userscripts are not updated separately, they are cached once per KES version download. Hope this makes sense.
Oh, I guess that makes sense, tampermonkey only allows you to automatically update externals monthly, weekly, or daily (and it’s also a global setting that users need to set) so that would be annoying.