Refactoring to use frantic from paranoia.wf's format. Greentext is back

2024-09-14 16:46:20 -04:00
parent bf9dacbf5b
commit 4dbc30a7cd
12 changed files with 41 additions and 993 deletions
--- a/README.md
+++ b/README.md
@@ -1,28 +1,45 @@
-# Glowers Club Element Patches
+# Element Web Patches

-This contains everything used to patch Glowers Club's Element instance. This patch does the following:
+| Patch                               | Description                                                                                                      |
+|-------------------------------------|------------------------------------------------------------------------------------------------------------------|
+| add_custom_reactions.sh             | Adds custom text reactions to the emoji picker. Edit reactions.yaml to set which reactions are added.            |
+| add_greentext.sh                    | Adds greentext, both as a /greentext command and by starting a message with ">".                                 |
+| delete_login_footer.sh              | Will delete the footer at the bottom of the login/register screen, removing useless links and making it cleaner. |
+| rename_remove_and_ban.sh            | Allows you to rename 'Remove' and 'Ban' to something else, you can change it by editing the script.              |
+| replace_config_file.sh              | Swaps the default config.json with your own.                                                                     |
+| replace_login_background.sh         | Allows you to replace the background on the login/register screen                                                |
+| replace_notification_sound.sh       | Allows you to replace the notification sound                                                                     |
+| remove-share-to-nonfree-services.sh | Removes the option to share to non-free services (Facebook, Twitter, etc) in any share dialogs.                  |

- ~~Changes messages you send starting with ">" to be chan-style greentext instead of Reddit-style block quotes~~ No longer works on latest Element Web. I blame Travis. PRs welcome.
- Adds custom login background (replace lake.jpg with any background you want)
- Adds custom text reactions in the emoji menu (at the bottom of the "Symbols" section). Change reactions.yaml to have any you want.
- Modifies the CSS for the emoji picker so the text reactions don't overflow to other emoji
- Replaces the default config.json with the one here
- In response to [Element devs renaming Kick to Remove](https://github.com/vector-im/element-web/issues/9547):
-	- Remove has been renamed to Holocaust
-	- Ban has been renamed to Gas
- Custom notification sound (replace message.mp3 and message.ogg with whatever sound you want)
-
-## Dependencies
-1. Everything already needed to build Element Web
-2. jq
-3. yq
-4. patch
+## Requirements
+ [NodeJS](https://nodejs.org/)
+ [Yarn](https://yarnpkg.com/)
+ [curl](https://curl.se/)
+ [patch](https://savannah.gnu.org/projects/patch/)
+ [jq](https://jqlang.github.io/jq/)
+ [yq](https://github.com/mikefarah/yq)

 ## Instructions
-1. `git clone https://github.com/vector-im/element-web.git`
-2. `cd element-web`
-3. `git clone https://code.glowers.club/q/element-web-patches.git`
-4. `yarn`
-5. `cd element-web-patches`
-6. `bash ./code_patches.sh`
-7. `cd .. && yarn dist`
+1. Clone the Element Web patches
+```
+git clone https://git.paranoia.wf/frantic/element-web-patches --depth 1 && cd element-web-patches
+```
+2. Clone the Element Web source code
+```
+./download_element.sh
+```
+3. Run scripts from the patches directory. patch_all.sh will run all of them. Read the script to see how to run individual patches.
+```
+cd patches/
+./patch_all.sh
+```
+4. Build Element Web
+```
+cd ../element-web
+yarn dist
+```
+
+## License
+```
+GNU General Public License version 3.0 or later
+```