Update README.md
[4Free-FSE.git] / README.md
blob0c125e93addeece31e7b6a6016b3484bebf2eb90
1 # 4Free - Free Stuff Enhancements[4Free-FSE]
2 ## Navigation
3 ### Download @ <a href="https://greasyfork.org/en/scripts/39561-4free-fse">GreasyFork</a> or Here
4 ### Filters <a href="https://raw.githubusercontent.com/ECHibiki/4Free-FSE/master/MD5%20Filters%20by%20QAJPYOtGo.txt">Here</a>
5 This folder contains QAJPYOtGo's MD5 filters for 4chanX, the .ts src folder, and the built user.js file in builds.<br/>
6 In the releases you can find individual scripts <a href="https://github.com/ECHibiki/4Free-FSE/releases/tag/V0.0.1">as V0 : Individual Packages</a> or you can look here to see the current work on the combined Typescipt version.
7 ## Future Developement
8         Bug fixes + Distribution
9 ## About 4Free-FSE
10 4chanX-Free Stuff Enhancements is a userscript that operates with 4chanX to give it additional features. These enhancements were written by me from early 2017 up to 2018 as a way to teach myself how to work with JavaScript while giving something back to the community I took part in.
11 Some of these features are simple, like the password viewer, others are more complex using multiple concurent AJAX calls such as the thread rebuilder or the image adder. <br/>
12 Below is a description of the features this package has to offer.
14 ### Danbooru Image Adder
15 #### Adds images to your posts
16 Adds an image to your post taken from the danbooru's image collection.<br/>
17 Supply it with tags via an autocomplete, set the rating(s/q/e) and it will give an image for you to post with. 
19 ### 4chan-Ignoring-Enhancements
20 #### Hides images.
21 Gives the ability to hide images with ___ctrl+shift+click___. Stores in browser memory for new sessions.<br/>
22 Also includes over 20,000 MD5 filters of things like frogs, goldface, guro done by from QAJPYOtGo<br/>
23 https://raw.githubusercontent.com/ECHibiki/4Free-FSE/master/MD5%20Filters%20by%20QAJPYOtGo.txt
24 #### Word Filters
25 Also includes the ability to do word replacements with a regex replacement system.<br>
27 ### Thread Rebuilder
28 #### Rebuild dead threads from scratch
29 Rebuild a thread from 4chan's archive.<br/>
30 Simple system that could use some additions(using 4chan's offsite archives for example)
32 ### Kita-Yen
33 #### Color text
34 Converts the colors of special symbols from plain black into other prettier colors(yen == purple, kita == dark grey).<br/>
35 #### Hotkeys for Convinience
36 <strong>Press ctrl+\ for ¥</strong>
37 Highlights the whole line in purple much like how greentext works<br/>
38 <strong>Press ctrl+k for キタ━━━(゚∀゚)━━━!!</strong>
39 Highlights just the word in dark gray<br/>
40 Plans are for these to also include custom inputs and colors.
42 ### Visible Password
43 #### Shows your 4chan post/delete password
44 * Displays your 4chan password in an inputbox.
45 * Top left is the post password, Bottom right is the delete password.
46 * Edit the input boxes to change them.
48 __Note:__ some 4chan boards don't allow custom post passwords. May require cookie manipulation, but this has not yet been tested...