XT 2.21.0

- Polish some icon related code - Square icons are back - Reworked the readme - Updated build to use different variable names in the icons. This should be more readable in the output, and result in less changed lines when icons are added in the future.
TuxedoTako · Jan 11, 2025 · 8947aa3 · 8947aa3
1 parent 086af9e
commit 8947aa3
Show file tree

Hide file tree

Showing 21 changed files with 903 additions and 1,035 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,11 @@
 4chan XT uses a different user script namespace than 4chan X, so to migrate you need to export settings from 4chan X,
 and import them in XT.
 
+### 2.21.0 (2025-01-11)
+
+- Convert various Unicode characters to SVG icons. [#141](https://github.com/TuxedoTako/4chan-xt/pull/141)
+  by [@saxamaphone69](https://github.com/saxamaphone69)
+
 ### 2.20.0 (2025-01-04)
 
 - Made soundpost detection case-insensitive. [#135](https://github.com/TuxedoTako/4chan-xt/pull/135)

diff --git a/README.md b/README.md
@@ -1,9 +1,15 @@
 # 4chan XT
 
-Originally forked from [4chan X](https://github.com/ccd0/4chan-x) for [this PR](https://github.com/ccd0/4chan-x/pull/3341),
-this fork started getting some features on its own. See the releases.
+4chan XT is a script that adds various features to anonymous imageboards. It was originally developed for 4chan but has
+no affiliation with it.
 
-New features include:
+4chan XT was originally forked from [4chan X](https://github.com/ccd0/4chan-x) for
+[this PR](https://github.com/ccd0/4chan-x/pull/3341), It is a migration of 4chan X from coffeescript to
+TypeScript/JavaScript. It is named XT both as a continuation of eXTended, and a T for TypeScript. The goals of this
+project is to first get a working bundle from js/ts files, and then gradually convert js files to ts and add types as
+needed.
+
+New features since the fork include:
 
 - Fetching the thread from an external archive and inserting deleted posts
 - Basic audio posts support
@@ -16,9 +22,28 @@ New features include:
 - A button to un-randomize a filename in the quick reply
 - Showing the reason a post was filtered in the stub
 
-The 4chan XT project is a migration of 4chan X from coffeescript to TypeScript/JavaScript. It is named XT both as a
-continuation of eXTended, and a T for TypeScript. The goals of this project is to first get a working bundle from js/ts
-files, and then gradually convert js files to ts and add types as needed.
+4chan X was previously developed by [ccd0](https://github.com/ccd0/4chan-x),
+[aeosynth](https://github.com/aeosynth/4chan-x), [Mayhem](https://github.com/MayhemYDG/4chan-x),
+[ihavenoface](https://github.com/ihavenoface/4chan-x), [Zixaphir](https://github.com/zixaphir/appchan-x),
+[Seaweed](https://github.com/seaweedchan/4chan-x), and [Spittie](https://github.com/Spittie/4chan-x), with contributions
+from many others.
+
+## Please note
+**Uninstalling**: 4chan XT disables the native extension, so if you uninstall 4chan XT, you'll need to re-enable it.
+To do this, click the `[Settings]` link in the top right corner, uncheck "`Disable the native extension`" in the panel
+that appears, and click the "`Save Settings`" button. If you don't see a "`Save Settings`" button, it may be being
+hidden by your ad blocker.
+
+**Private browsing**: By default, 4chan XT remembers your last read post in a thread and which posts were made by you,
+even if you are in private browsing / incognito mode. If you want to turn this off, uncheck the
+`Remember Last Read Post` and `Remember Your Posts` options in the settings panel. You can clear all 4chan browsing
+history saved by 4chan XT by resetting your settings. This fork also includes an option to export settings without
+exporting your history.
+
+Use of the "Link Title" feature to fetch titles of Youtube links is subject to Youtube's
+[Terms of Service](https://www.youtube.com/t/terms) and [Privacy Policy](http://www.google.com/policies/privacy).
+For more details on what information is sent to Youtube and other sites, and how to turn it off if you don't want the
+feature, see upstream 4chan X's [privacy documentation](https://github.com/ccd0/4chan-x/wiki/Privacy).
 
 ## Install
 
@@ -38,7 +63,21 @@ The simplest build is as easy as `npm install` `npm run build`, but there are so
   the decaffeinate suggestions comments. Might speed up the build, but the result is larger.
 - `-test` Include tests in build.
 
-## TODO
+## Troubleshooting
+If you encounter a bug, try the steps [here](https://github.com/TuxedoTako/4chan-xt/blob/project-XT/CONTRIBUTING.md#reporting-bugs),
+then report it to the [issue tracker](https://github.com/TuxedoTako/4chan-xt/issues?q=is%3Aopen+sort%3Aupdated-desc).
+If the bug seems to be caused by a script update, you can install a old version from the
+[GitHub releases](https://github.com/TuxedoTako/4chan-xt/releases) or from
+[Greasy Fork](https://greasyfork.org/scripts/489508-4chan-xt/versions).
+
+## More information
+- [Changelog](https://github.com/TuxedoTako/4chan-xt/blob/project-XT/CHANGELOG.md)
+- [Frequently Asked Questions for this fork](https://github.com/TuxedoTako/4chan-xt/wiki/Frequently-Asked-Questions)
+- [Frequently Asked Questions for upstream, most should still apply](https://github.com/ccd0/4chan-x/wiki/Frequently-Asked-Questions)
+- [Report Bugs](https://github.com/TuxedoTako/4chan-xt/issues?q=is%3Aopen+sort%3Aupdated-desc)
+- [Contributing](https://github.com/TuxedoTako/4chan-xt/blob/project-XT/CONTRIBUTING.md)
+
+### TODO
 
 <details>
 <summary>Click to expand</summary>
@@ -59,7 +98,10 @@ The simplest build is as easy as `npm install` `npm run build`, but there are so
 
 </details>
 
-## Other notes
+### Other notes about this fork
+
+<details>
+<summary>Click to expand</summary>
 
 - A lot of files have circular dependencies, but rollup can handle that
   - but for some scripts that add to the same object I had to merge them, like Posting/QR and site/SW.yotsuba.js
@@ -71,99 +113,4 @@ The simplest build is as easy as `npm install` `npm run build`, but there are so
 - @violentmonkey/types was chosen over @types/greasemonkey because @types/greasemonkey only declares the GM object,
   and not GM\_ functions
 
----
-
-# Original readme:
-
-![screenshot](https://ccd0.github.io/4chan-x/img/screenshot.png)
-# 4chan X
-4chan X is a script that adds various features to anonymous imageboards. It was originally developed for 4chan but has no affiliation with it.
-
-It was previously developed by [aeosynth](https://github.com/aeosynth/4chan-x), [Mayhem](https://github.com/MayhemYDG/4chan-x), [ihavenoface](https://github.com/ihavenoface/4chan-x), [Zixaphir](https://github.com/zixaphir/appchan-x), [Seaweed](https://github.com/seaweedchan/4chan-x), and [Spittie](https://github.com/Spittie/4chan-x), with contributions from many others.
-
-If you're looking for a maintained fork of OneeChan (a style script used in addition to 4chan X), try
-https://github.com/KevinParnell/OneeChan.
-
-## Please note
-**Uninstalling**: 4chan X disables the native extension, so if you uninstall 4chan X, you'll need to re-enable it. To do this, click the `[Settings]` link in the top right corner, uncheck "`Disable the native extension`" in the panel that appears, and click the "`Save Settings`" button. If you don't see a "`Save Settings`" button, it may be being hidden by your ad blocker.
-
-**Private browsing**: By default, 4chan X remembers your last read post in a thread and which posts were made by you, even if you are in private browsing / incognito mode. If you want to turn this off, uncheck the `Remember Last Read Post` and `Remember Your Posts` options in the settings panel. You can clear all 4chan browsing history saved by 4chan X by resetting your settings.
-
-Use of the "Link Title" feature to fetch titles of Youtube links is subject to Youtube's [Terms of Service](https://www.youtube.com/t/terms) and [Privacy Policy](http://www.google.com/policies/privacy). For more details on what information is sent to Youtube and other sites, and how to turn it off if you don't want the feature, see 4chan X's [privacy documentation](https://github.com/ccd0/4chan-x/wiki/Privacy).
-
-## Install
-
-### Firefox
-Install [Violentmonkey](https://addons.mozilla.org/en-US/firefox/addon/violentmonkey/), [Tampermonkey](https://addons.mozilla.org/en-US/firefox/addon/tampermonkey/), or [Greasemonkey](https://addons.mozilla.org/en-US/firefox/addon/greasemonkey/) (issues since v4: [#2526](https://github.com/greasemonkey/greasemonkey/issues/2526), [#2576](https://github.com/greasemonkey/greasemonkey/issues/2574)), then **[click here to install 4chan X](https://www.4chan-x.net/builds/4chan-X.user.js)**.
-
-Ports of Greasemonkey are available for [SeaMonkey](https://sourceforge.net/projects/gmport/) and [Pale Moon](https://github.com/janekptacijarabaci/greasemonkey/releases/latest).
-
-### Chromium
-**Userscript**: Install [Violentmonkey](https://chrome.google.com/webstore/detail/violent-monkey/jinjaccalgkegednnccohejagnlnfdag) or [Tampermonkey](https://tampermonkey.net/), then **[click here to install 4chan X](https://www.4chan-x.net/builds/4chan-X.user.js)**.
-
-**Chrome extension**: 4chan X is also available as a standalone Chrome extension. The Chrome extension has the additional feature of being able to sync your settings and data with other devices via Chrome Sync. But there is an issue when the script updates: Whenever the Chrome extension is updated, until you hard refresh (F5) the tab, 4chan X is unable to save any data (such as posts marked as yours and settings changes). The userscript version above does not have this problem when 4chan X updates, only when Violentmonkey / Tampermonkey is updated. To install as a Chrome extension:
-
-- **Chromium**, **Vivaldi**: **[Download 4chan X](https://www.4chan-x.net/builds/4chan-X.crx)**, then open `chrome://extensions` and drag the downloaded file onto the page. Alternatively, you can install 4chan X from the **[Chrome store](https://chrome.google.com/webstore/detail/ohnjgmpcibpbafdlkimncjhflgedgpam)**.
-- **Opera**: **[Click to install 4chan X](https://www.4chan-x.net/builds/4chan-X.crx)**, then follow the prompts to activate it in your extension manager.
-- **Chrome**: Install 4chan X from the **[Chrome store](https://chrome.google.com/webstore/detail/ohnjgmpcibpbafdlkimncjhflgedgpam)**.
-
-Note: This version of 4chan X does not work with Opera 12. If you need Opera 12 support, try [loadletter's fork](https://github.com/loadletter/4chan-x) instead.
-
-### Safari
-Install the [Userscripts](https://itunes.apple.com/us/app/userscripts/id1463298887) extension. Enable it by pressing `⌘,`, navigating to the extensions pane and checking `Userscripts` checkbox. Now open the Userscripts editor by clicking on the `</>` button in the taskbar. Then click on the `+` button and select the `New Javascript` option. Replace the default text with the contents of the 4chan X **[script](https://www.4chan-x.net/builds/4chan-X.user.js)**. Finally save it by pressing `⌘s`.
-
-### WebKitGTK+ / QtWebKit / QtWebEngine
-Several minimal browsers have support for userscripts and can run 4chan X. Due to the lack of the cross-site GM_* API, and lack of support for userscripts in iframes, not all features will work. You may experience crashes when repeatedly solving the default image-based captchas. You can avoid this problem by enabling `Use Recaptcha v1` in your settings.
-
-- **dwb**: Install the userscripts extension, then save the [script](https://www.4chan-x.net/builds/4chan-X.user.js) to the `$XDG_CONFIG_HOME/dwb/greasemonkey` or `$HOME/.config/dwb/greasemonkey` directory (creating it if necessary):
-
-  ```
-  dwbem -N -i userscripts
-  wget -P ${XDG_CONFIG_HOME:-$HOME/.config}/dwb/greasemonkey https://www.4chan-x.net/builds/4chan-X.user.js
-  ```
-
-- **Midori**: Enable `User addons` in your preferences, under the Extensions tab. In the Privacy tab, check `Enable HTML5 local storage support`. Optionally, if you want 4chan X to be able to open new tabs when you start or reply to a thread, you will need to check `Allow scripts to open popups` under the Behavior tab. Then click the link to the [script](https://www.4chan-x.net/builds/4chan-X.user.js) to install it.
-
-- **Luakit**: Navigate to the [script](https://www.4chan-x.net/builds/4chan-X.user.js), then type the command `:usi` to install it.
-
-- **uzbl**: Install the script from https://github.com/singpolyma/singpolyma/blob/master/uzbl/data/scripts/userscript.sh, enable it in your config file, and then save [4chan X](https://www.4chan-x.net/builds/4chan-X.user.js) to `$XDG_DATA_HOME/uzbl/userscripts` (or `$HOME/.local/share/uzbl/userscripts`). The commands below assume you have run uzbl at least once to create its config file.
-
-  ```
-  wget -P "${XDG_DATA_HOME:-$HOME/.local/share}/uzbl/scripts" https://raw.githubusercontent.com/singpolyma/singpolyma/master/uzbl/data/scripts/userscript.sh
-  chmod +x "${XDG_DATA_HOME:-$HOME/.local/share}/uzbl/scripts/userscript.sh"
-  echo '@on_event LOAD_COMMIT spawn @scripts_dir/userscript.sh document-start' >> "${XDG_CONFIG_HOME:-$HOME/.config}/uzbl/config"
-  echo '@on_event LOAD_FINISH spawn @scripts_dir/userscript.sh document-end'   >> "${XDG_CONFIG_HOME:-$HOME/.config}/uzbl/config"
-  wget -P "${XDG_DATA_HOME:-$HOME/.local/share}/uzbl/userscripts" https://www.4chan-x.net/builds/4chan-X.user.js
-  ```
-
-- **qutebrowser**: Save the [script](https://www.4chan-x.net/builds/4chan-X.user.js) to the `$XDG_DATA_HOME/qutebrowser/greasemonkey` or `$HOME/.local/share/qutebrowser/greasemonkey` directory:
-
-  ```
-  wget -P ${XDG_DATA_HOME:-$HOME/.local/share}/qutebrowser/greasemonkey https://www.4chan-x.net/builds/4chan-X.user.js
-  ```
-
-### MS Edge
-Install [Tampermonkey](https://www.microsoft.com/en-us/store/p/tampermonkey/9nblggh5162s), then **[click here to install 4chan X](https://www.4chan-x.net/builds/4chan-X.user.js)**.
-
-### Other browsers
-4chan X can be used in some browsers that do not support userscripts using [a local proxy](https://github.com/ccd0/4chan-x-proxy). Not all features will work.
-
-## Beta version
-New features and non-urgent bugfixes are released on the beta channel for further testing before they are moved the stable version. Please [report](https://github.com/ccd0/4chan-x/issues?q=is%3Aopen+sort%3Aupdated-desc) any issues you find, and be sure to mention which version you're using. You should back up your settings regularly to prevent them from being lost due to bugs.
-
-To install the **beta** version and get updates whenever there's a new **beta** version:
-- [Install userscript](https://www.4chan-x.net/builds/4chan-X-beta.user.js) (use with Greasemonkey / Violentmonkey / Tampermonkey / JS Blocker / etc.)
-- [Download Chrome extension](https://www.4chan-x.net/builds/4chan-X-beta.crx) (download and drag to `chrome://extensions`)
-
-To install the current **beta** version but get updates from the **stable** channel (for example, if just you want a particular recent feature):
-- [Install userscript](https://github.com/ccd0/4chan-x/raw/beta/builds/4chan-X.user.js)
-- [Download Chrome extension](https://github.com/ccd0/4chan-x/raw/beta/builds/4chan-X.crx)
-
-## Troubleshooting
-If you encounter a bug, try the steps [here](https://github.com/ccd0/4chan-x/blob/master/CONTRIBUTING.md#reporting-bugs), then report it to the [issue tracker](https://github.com/ccd0/4chan-x/issues?q=is%3Aopen+sort%3Aupdated-desc). If the bug seems to be caused by a script update, you can install a old version from the [changelog](https://github.com/ccd0/4chan-x/blob/master/CHANGELOG.md).
-
-## More information
-- [Changelog](https://github.com/ccd0/4chan-x/blob/master/CHANGELOG.md)
-- [Frequently Asked Questions](https://github.com/ccd0/4chan-x/wiki/Frequently-Asked-Questions)
-- [Report Bugs](https://github.com/ccd0/4chan-x/issues)
-- [Contributing](https://github.com/ccd0/4chan-x/blob/master/CONTRIBUTING.md)
+</details>
diff --git a/builds/4chan-XT.meta.js b/builds/4chan-XT.meta.js
@@ -1,6 +1,6 @@
 // ==UserScript==
 // @name         4chan XT
-// @version      2.20.0
+// @version      2.21.0
 // @minGMVer     1.14
 // @minFFVer     74
 // @namespace    4chan-XT

diff --git a/builds/4chan-XT.min.meta.js b/builds/4chan-XT.min.meta.js
@@ -1,6 +1,6 @@
 // ==UserScript==
 // @name         4chan XT
-// @version      2.20.0
+// @version      2.21.0
 // @minGMVer     1.14
 // @minFFVer     74
 // @namespace    4chan-XT