Skip to content

Latest commit

 

History

History
125 lines (111 loc) · 8.71 KB

README.md

File metadata and controls

125 lines (111 loc) · 8.71 KB

SpookyX

Extend functionality on FoolFuuka imageboards. Only actually tested on the moe archives so the rest are theoretical.

(This builds off of the original FoolX script which can be downloaded at: https://dl.dropbox.com/s/5fxjiuig4vnkgte/FoolX.user.js)

Or if you don't want automatic updates use this version.

Firefox:

Install Greasemonkey, then click the link above to install SpookyX. If you're using a fork of Firefox (e.g. Pale Moon), you may need to use Greasemonkey 1.15 instead of the most recent version. No idea if SpookyX works on an old version of Greasemonkey though.

Chrome:

Install Tampermonkey, then click the link above to install SpookyX.

Added Features:

Embedding linked images into the post to imitate imageboard use in the Spooky real

  • Works for imgur, puu.sh etc. More sites can be added by the user by editing the script, see below
  • Supports .webm, .mp4 (and .gifv)
  • An image link that is enclosed in spoiler tags will be embedded in spoilered mode
  • Middle click and ctrl+leftclick open images in a new tab rather than toggle size
  • More than a single image can be embedded by editing the script, see below

Pressing Q (Outside of text entry fields) will toggle quick reply mode

  • This moves the reply box to the top right of the screen and it stays where it when you scroll
  • Pressing ctrl+Q will toggle showing the subject, name, email, password fields when in quick reply mode

Clicking post links and post reply links will expand them inline

  • Inline posts will be removed from their normal place and restored when no longer inline
  • Middle click and ctrl+leftclick opens these links in a new tab instead
  • In the current version opening a mix of links and backlinks will result in buggy behaviour

Highlighting text and clicking a post number will insert both into the reply field

  • The text is not post specific, nor is it constrained to posts

Post content will be filtered against 'shitpost flags'

  • There are three tiers of shitpost:
    • T0 isn't bound by a character limit and outright removes posts. Capitalisation sensitive
    • T1 which is considered worthy of outright removal but is constrained only to posts shorter than the character limit. Not capitalisation sensitive
    • T2 which is considered potentially worth seeing and is thus collapsed instead, allowing you to show/hide toggle it. Not capitalisation sensitive
  • Also filter by tripcode or name
  • The 'shitpost flags' can be edited manually to customise your filter

Your posts and links pointing to them will be designated by appending '(You)'

  • Receive desktop notifications when someone replies to you
  • Clicking the notification will take you to the relevant tab

Dynamic favicon that indicates whether a thread has new posts and whether any are replies to yours

  • See options below for instructions on customising the favicons used for each of these states
  • Activating this feature will also turn on the more advanced seen post counter which will keep track of the last post you saw in a thread and persist between sessions
  • The cut off point between seen and unseen posts is designated with a horizontal red line

Hovering over images or videos

  • Show full version of media or one shrunk to fit in view if it's too large
  • You can turn off images or turn off videos independently. See the user options below

Gallery Mode that lets you browse through all thread images and videos.

  • Press 'G' to bring it up, press it again to hide it once more.
  • Left and right arrow keys are used to cycle through the images.

Fixed bugs present in the original FoolX:

  • Using keyboard shortcuts to wrap highlighted text in tags no longer wraps the first instance if there are multiple instances of the highlighted text in the reply box.
  • Inline OP images work

User Options:

At the start of the script is a section titled "/* User Options */" which contains several variables that you can change.

  • imgSites: This is the list of websites that the image embed feature will embed from
  • imgNumMaster: This is how many images each post can have embedded
    • Simply replace with whatever number you desire
  • autoplayVids: Make embedded videos play automatically (they start muted, expanding unmutes)
    • "true" or "false" as appropriate
  • hideQROptions: Make the reply options hidden by default in the quick reply
    • Simply use "true" or "false" depending on you preference
  • favicon: Choose which favicon is used to indicate there are unread posts.
    • The list of options is as follows:
      • unlit: A url to the image you wish to use as the favicon that displays when there are no new posts
      • lit: A url to the image you wish to use as the favicon that displays when there are new posts that aren't replies to yours
        • There are 5 preset options. Rather than giving a url here you can use the numbers 0-4 to choose which one
      • alert: A url to the image you wish to use as the favicon that displays when there are new posts of which some are replies to yours
      • alertOverlay: A url to the image you wish to use as an overlay on a custom lit favicon
        • Use a png for transparency
    • Unfortunately due to security policy it cannot automatically overlay the images and set that as the favicon. Instead:
      • you will need to set your custom lit or custom alertOverlay (or both)
      • reload a moe page with the script running and a reply box present (such as in a thread)
      • hit 'F' to bring up by the reply box a image with the output alert image
      • right click and save this image
      • upload it somewhere
      • set the alert option in the script to equal that url
  • features: This is a list of the feature names
    • Set them to "true" or "false", making sure the comma remains at the end
    • The list of features is as follows:
      • postCounter: Add a post counter to the reply box
      • inlineImages: Load full-size images in the thread, enable click to expand
      • hidePosts: Allow user to hide posts manually
      • newPosts: Reflect new posts in the tab name
      • embedImages: Embed image links in thread
      • embedGalleries: Embed imgur galleries into a single post for ease of image dumps
      • inlineReplies: Click replies to expand them inline
      • postQuote: Clicking the post number will insert highlighted text into the reply box
      • filter: Hide undesirable posts from view
      • labelYourPosts: Add '(You)' to your posts and links that point to them
      • favicon: Switch to a dynamic favicon that indicates unread posts and unread replies
      • imageHover: Hovering over images with the mouse brings a full or window scaled version in view
      • videoHover: Hovering over videos with the mouse brings a full or window scaled version in view
      • gallery: Pressing G will bring up a view that displays all the images in a thread. Left and right arrow keys cycle through them
  • filterCharThreshold: the number of characters that a post must be over to be exempt from shitpost filtering
  • filteredStringsT0: List of Tier 0 strings to filter for. Tier 0 get's removed
  • filteredStringsT1: List of Tier 1 strings to filter for. Tier 1 get's removed
    • Works the same as filteredStringsT0
    • This is not capitalisation specific
  • filteredStringsT2: List of Tier 2 strings to filter for. Tier 2 get's collapsed
    • Works the same as filteredStringsT0
    • This is not capitalisation specific
  • filteredTrips: List of tripcodes to filter for. These get collapsed.
    • Works the same as filteredStringsT0
    • This is capitalisation specific
  • filteredNames: List of names to filter for. These get collapsed.
    • Works the same as filteredStringsT0
    • This is capitalisation specific