Skip to content

Latest commit

 

History

History
46 lines (24 loc) · 3.18 KB

README.md

File metadata and controls

46 lines (24 loc) · 3.18 KB

Join the chat at https://gitter.im/soscripted/sox

SOX v2.8.0

Stack Overflow Extras (SOX) is a project that stemmed from the Stack Overflow Optional Features (SOOF) project.

The SOX userscript adds a bunch of optional features to all sites in the Stack Exchange network. These can be toggled on or off from an easy to use control panel (see screenshot below).

Note: This project has no relation to Stack Overflow or Stack Exchange; it is simply a userscript that enhances the sites!

Installation & Requirements

  1. Install a userscript manager; these are free extensions available for all popular browsers that allow you to manage and install userscripts, along with exposing certain code functions that SOX requires.

    We recommend Tampermonkey for Chrome and Firefox.

    Whilst SOX only explicitly supports Chrome and Firefox, it should work on any popular browser that can run userscripts.

    Note: Greasemonkey 4 and upwards is not supported with SOX.

    There seems to be an issue with Tampermonkey on Firefox where userscripts don't seem to run. If this happens, please restart your browser and/or computer before raising an issue on GitHub, as a restart seems to fix this!

  2. Install the script. Clicking on 'install' below will make Tampermonkey prompt you automatically to install it.

  3. Go to any site in the Stack Exchange Network (e.g. Super User or Stack Overflow) (reload if already opened) and confirm the dialog asking you to get an access token. This will open a new page where you can authorize SOX, and can be closed once your access token is saved. A toggle button (gears icon) will be added to your topbar. Click and review and save the settings

newdialog

What features are included?

A full list of all the features is available on the SOX wiki page here.

Bugs and Feature Requests

Please post bugs and feature requests as issues on Github, where we can track them easily and push updates quickly. Please do not post them as answers on Stack Apps -- they are much harder to manage!

Contribute

Pull requests to add new features or improve the existing ones, etc. are welcome! Please head to the Contributing wiki page to get started.

Changes

Please see the change log at Stack Apps.