Skip to content

Commit 421fbc7

Browse files
zt64zt64
committed
chore: update README generation
1 parent 1b56b20 commit 421fbc7

File tree

2 files changed

+75
-126
lines changed

2 files changed

+75
-126
lines changed

‎README.md

Lines changed: 44 additions & 111 deletions
Original file line numberDiff line numberDiff line change
@@ -1,111 +1,44 @@
1-
## Plugins for [Aliucord](https://github.com/Aliucord)
2-
3-
Click on a plugin name to download, and then move the downloaded file to the `Aliucord/plugins` folder
4-
5-
- [AccountSwitcher](https://github.com/zt64/aliucord-plugins/raw/builds/AccountSwitcher.zip )
6-
Adds the ability to quickly switch accounts
7-
8-
- [AlwaysAnimate](https://github.com/zt64/aliucord-plugins/raw/builds/AlwaysAnimate.zip )
9-
Allows making server icons and user avatars always animate
10-
11-
- [AnonymousFiles](https://github.com/zt64/aliucord-plugins/raw/builds/AnonymousFiles.zip )
12-
Randomize uploaded file names
13-
14-
- [AppendGifAsUrl](https://github.com/zt64/aliucord-plugins/raw/builds/AppendGifAsUrl.zip )
15-
Makes selecting a GIF add as a URL to the message, instead of sending and clearing your message.
16-
17-
- [AvatarMention](https://github.com/zt64/aliucord-plugins/raw/builds/AvatarMention.zip )
18-
Makes tapping a message avatar mention that user
19-
20-
- [BanCount](https://github.com/zt64/aliucord-plugins/raw/builds/BanCount.zip )
21-
Shows the total number of banned users on the bans page in the server settings
22-
23-
- [ChannelInvites](https://github.com/zt64/aliucord-plugins/raw/builds/ChannelInvites.zip )
24-
Shows the total number of banned users on the bans page in the server settings
25-
26-
- [CharCounter](https://github.com/zt64/aliucord-plugins/raw/builds/CharCounter.zip )
27-
Adds a character counter to the message box
28-
29-
- [CompactMode](https://github.com/zt64/aliucord-plugins/raw/builds/CompactMode.zip )
30-
Modifies chat to have a more compact appearance, with several options to change
31-
32-
- [CursorInput](https://github.com/zt64/aliucord-plugins/raw/builds/CursorInput.zip )
33-
Makes it so that emojis, mentions and others are added at the cursor position instead of the end of the message
34-
35-
- [CustomNoticeDuration](https://github.com/zt64/aliucord-plugins/raw/builds/CustomNoticeDuration.zip )
36-
Allows setting the dismiss time of notices (in-app notifications)
37-
38-
- [CustomSounds](https://github.com/zt64/aliucord-plugins/raw/builds/CustomSounds.zip )
39-
Adds settings to customize what sound is played for various events.
40-
41-
- [CustomStatusPresets](https://github.com/zt64/aliucord-plugins/raw/builds/CustomStatusPresets.zip )
42-
Adds presets to the custom status menu. Long press on the save button to save a preset
43-
44-
- [DeveloperUtils](https://github.com/zt64/aliucord-plugins/raw/builds/DeveloperUtils.zip )
45-
Adds several utilities to make development easier
46-
47-
- [DisablePreviewsOnData](https://github.com/zt64/aliucord-plugins/raw/builds/DisablePreviewsOnData.zip )
48-
Disables inline images and videos in chat in the Text & Images settings when on mobile data to limit data usage
49-
50-
- [DMCategories](https://github.com/zt64/aliucord-plugins/raw/builds/DMCategories.zip )
51-
Adds the ability to create categories for DMs, which will come first in the list
52-
53-
- [FavoriteChannels](https://github.com/zt64/aliucord-plugins/raw/builds/FavoriteChannels.zip )
54-
Add your favorite channels to the top of the channel list for easy access.
55-
56-
- [FolderOpacity](https://github.com/zt64/aliucord-plugins/raw/builds/FolderOpacity.zip )
57-
Adds an option to the guild folder settings to set the opacity
58-
59-
- [InputFocusFix](https://github.com/zt64/aliucord-plugins/raw/builds/InputFocusFix.zip )
60-
Fix automatic focus on input field
61-
62-
- [InviteDetails](https://github.com/zt64/aliucord-plugins/raw/builds/InviteDetails.zip )
63-
Adds useful information to the invite embed
64-
65-
- [MessageReactionsFix](https://github.com/zt64/aliucord-plugins/raw/builds/MessageReactionsFix.zip )
66-
Adds favorite emojis to the start of the emoji list
67-
68-
- [MessageScheduler](https://github.com/zt64/aliucord-plugins/raw/builds/MessageScheduler.zip )
69-
70-
71-
- [MessageWidthFix](https://github.com/zt64/aliucord-plugins/raw/builds/MessageWidthFix.zip )
72-
Fixes the width on embeds and stickers to make long press work
73-
74-
- [NoBurnIn](https://github.com/zt64/aliucord-plugins/raw/builds/NoBurnIn.zip )
75-
Adds many options to hide items from the top bar in an attempt to prevent screen burn-in
76-
77-
- [NoLinkify](https://github.com/zt64/aliucord-plugins/raw/builds/NoLinkify.zip )
78-
Disables highlighting for phone numbers and addresses in messages
79-
80-
- [PermissionsSync](https://github.com/zt64/aliucord-plugins/raw/builds/PermissionsSync.zip )
81-
Adds the sync permissions option from the Desktop client
82-
83-
- [QuickStar](https://github.com/zt64/aliucord-plugins/raw/builds/QuickStar.zip )
84-
Adds a star button to the message context menu that reacts to the message with the star emoji
85-
86-
- [RemoteUpload](https://github.com/zt64/aliucord-plugins/raw/builds/RemoteUpload.zip )
87-
Automatically upload files to a remote host if they exceed the size limit
88-
89-
- [RestartButton](https://github.com/zt64/aliucord-plugins/raw/builds/RestartButton.zip )
90-
Adds a button to restart Aliucord to the settings page
91-
92-
- [RoleColorEverywhere](https://github.com/zt64/aliucord-plugins/raw/builds/RoleColorEverywhere.zip )
93-
Displays the highest role color in more places like mentions and typing text
94-
95-
- [SearchTweaks](https://github.com/zt64/aliucord-plugins/raw/builds/SearchTweaks.zip )
96-
Adds features to make searching more bearable
97-
98-
- [SystemInfo](https://github.com/zt64/aliucord-plugins/raw/builds/SystemInfo.zip )
99-
Adds a systeminfo slash command that provides basic system information
100-
101-
- [SystemTheme](https://github.com/zt64/aliucord-plugins/raw/builds/SystemTheme.zip )
102-
Sync your Discord theme with your system theme
103-
104-
- [Token](https://github.com/zt64/aliucord-plugins/raw/builds/Token.zip )
105-
Adds a token slash command to tell you your account token
106-
107-
- [Weather](https://github.com/zt64/aliucord-plugins/raw/builds/Weather.zip )
108-
Adds a weather slash command to get information for the current location or one that's provided
109-
110-
- [WiderScrollbar](https://github.com/zt64/aliucord-plugins/raw/builds/WiderScrollbar.zip )
111-
Allows changing the scrollbar width to make it easier to drag
1+
# Aliucord Plugins
2+
3+
[![Plugins](https://img.shields.io/badge/Plugins-30-blue?style=for-the-badge)](https://github.com/zt64/aliucord-plugins)
4+
5+
A collection of plugins for [Aliucord](https://github.com/Aliucord), a Discord mobile client mod.
6+
7+
## 📥 Installation
8+
9+
Click on a plugin name to download, then move the downloaded file to the `Aliucord/plugins` folder on your device.
10+
11+
## 🧩 Available Plugins
12+
13+
| Plugin | Description |
14+
|:-------|:------------|
15+
| [**AccountSwitcher**](https://github.com/zt64/aliucord-plugins/raw/builds/AccountSwitcher.zip) | Adds the ability to quickly switch accounts |
16+
| [**AlwaysAnimate**](https://github.com/zt64/aliucord-plugins/raw/builds/AlwaysAnimate.zip) | Allows making server icons and user avatars always animate |
17+
| [**AnonymousFiles**](https://github.com/zt64/aliucord-plugins/raw/builds/AnonymousFiles.zip) | Randomize uploaded file names |
18+
| [**AppendGifAsUrl**](https://github.com/zt64/aliucord-plugins/raw/builds/AppendGifAsUrl.zip) | Makes selecting a GIF add as a URL to the message, instead of sending and clearing your message. |
19+
| [**AvatarMention**](https://github.com/zt64/aliucord-plugins/raw/builds/AvatarMention.zip) | Makes tapping a message avatar mention that user |
20+
| [**BanCount**](https://github.com/zt64/aliucord-plugins/raw/builds/BanCount.zip) | Shows the total number of banned users on the bans page in the server settings |
21+
| [**ChannelInvites**](https://github.com/zt64/aliucord-plugins/raw/builds/ChannelInvites.zip) | Shows the total number of banned users on the bans page in the server settings |
22+
| [**CharCounter**](https://github.com/zt64/aliucord-plugins/raw/builds/CharCounter.zip) | Adds a character counter to the message box |
23+
| [**CompactMode**](https://github.com/zt64/aliucord-plugins/raw/builds/CompactMode.zip) | Modifies chat to have a more compact appearance, with several options to change |
24+
| [**CursorInput**](https://github.com/zt64/aliucord-plugins/raw/builds/CursorInput.zip) | Makes it so that emojis, mentions and others are added at the cursor position instead of the end of the message |
25+
| [**CustomNoticeDuration**](https://github.com/zt64/aliucord-plugins/raw/builds/CustomNoticeDuration.zip) | Allows setting the dismiss time of notices (in-app notifications) |
26+
| [**CustomStatusPresets**](https://github.com/zt64/aliucord-plugins/raw/builds/CustomStatusPresets.zip) | Adds presets to the custom status menu. Long press on the save button to save a preset |
27+
| [**DMCategories**](https://github.com/zt64/aliucord-plugins/raw/builds/DMCategories.zip) | Adds the ability to create categories for DMs, which will come first in the list |
28+
| [**DisablePreviewsOnData**](https://github.com/zt64/aliucord-plugins/raw/builds/DisablePreviewsOnData.zip) | Disables inline images and videos in chat in the Text & Images settings when on mobile data to limit data usage |
29+
| [**FavoriteChannels**](https://github.com/zt64/aliucord-plugins/raw/builds/FavoriteChannels.zip) | Add your favorite channels to the top of the channel list for easy access. |
30+
| [**FolderOpacity**](https://github.com/zt64/aliucord-plugins/raw/builds/FolderOpacity.zip) | Adds an option to the guild folder settings to set the opacity |
31+
| [**Frecents**](https://github.com/zt64/aliucord-plugins/raw/builds/Frecents.zip) | Adds support for favorite GIFs, emojis, stickers, and recent items |
32+
| [**InviteDetails**](https://github.com/zt64/aliucord-plugins/raw/builds/InviteDetails.zip) | Adds useful information to the invite embed |
33+
| [**MessageWidthFix**](https://github.com/zt64/aliucord-plugins/raw/builds/MessageWidthFix.zip) | Fixes the width on embeds and stickers to make long press work |
34+
| [**NoBurnIn**](https://github.com/zt64/aliucord-plugins/raw/builds/NoBurnIn.zip) | Adds many options to hide items from the top bar in an attempt to prevent screen burn-in |
35+
| [**NoLinkify**](https://github.com/zt64/aliucord-plugins/raw/builds/NoLinkify.zip) | Disables highlighting for phone numbers and addresses in messages |
36+
| [**PermissionsSync**](https://github.com/zt64/aliucord-plugins/raw/builds/PermissionsSync.zip) | Adds the sync permissions option from the Desktop client |
37+
| [**QuickStar**](https://github.com/zt64/aliucord-plugins/raw/builds/QuickStar.zip) | Adds a star button to the message context menu that reacts to the message with the star emoji |
38+
| [**RestartButton**](https://github.com/zt64/aliucord-plugins/raw/builds/RestartButton.zip) | Adds a button to restart Aliucord to the settings page |
39+
| [**RoleColorEverywhere**](https://github.com/zt64/aliucord-plugins/raw/builds/RoleColorEverywhere.zip) | Displays the highest role color in more places like mentions and typing text |
40+
| [**SystemInfo**](https://github.com/zt64/aliucord-plugins/raw/builds/SystemInfo.zip) | Adds a systeminfo slash command that provides basic system information |
41+
| [**SystemTheme**](https://github.com/zt64/aliucord-plugins/raw/builds/SystemTheme.zip) | Sync your Discord theme with your system theme |
42+
| [**Token**](https://github.com/zt64/aliucord-plugins/raw/builds/Token.zip) | Adds a token slash command to tell you your account token |
43+
| [**Weather**](https://github.com/zt64/aliucord-plugins/raw/builds/Weather.zip) | Adds a weather slash command to get information for the current location or one that's provided |
44+
| [**WiderScrollbar**](https://github.com/zt64/aliucord-plugins/raw/builds/WiderScrollbar.zip) | Allows changing the scrollbar width to make it easier to drag |

‎plugin/build.gradle.kts

Lines changed: 31 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -80,29 +80,45 @@ tasks.register("generateReadMe") {
8080
group = "aliucord"
8181
description = "Generates the README.md file with download links for all plugins"
8282

83+
outputs.file(rootProject.file("README.md"))
84+
8385
doLast {
8486
val readMe = rootProject.file("README.md")
87+
val plugins = subprojects
88+
.filterNot {
89+
it.extensions.getByType<AliucordExtension>().excludeFromUpdaterJson.get()
90+
}
91+
.sortedBy { it.name }
92+
8593
val content = buildString {
86-
appendLine("## Plugins for [Aliucord](https://github.com/Aliucord)")
94+
// Header with badges
95+
appendLine("# Aliucord Plugins")
8796
appendLine()
8897
appendLine(
89-
"Click on a plugin name to download, and then move the downloaded file to the `Aliucord/plugins` folder"
98+
"[![Plugins](https://img.shields.io/badge/Plugins-${plugins.size}-blue?style=for-the-badge)](https://github.com/zt64/aliucord-plugins)"
9099
)
91100
appendLine()
101+
appendLine("A collection of plugins for [Aliucord](https://github.com/Aliucord), a Discord mobile client mod.")
102+
appendLine()
92103

93-
subprojects
94-
.filterNot {
95-
it.extensions.getByType<AliucordExtension>().excludeFromUpdaterJson.get()
96-
}.joinToString("\n") { subproject ->
97-
buildString {
98-
with(subproject) {
99-
appendLine(
100-
"- [$name](https://github.com/zt64/aliucord-plugins/raw/builds/$name.zip )"
101-
)
102-
appendLine(description)
103-
}
104-
}
105-
}.let(::append)
104+
// Installation section with emoji
105+
appendLine("## 📥 Installation")
106+
appendLine()
107+
appendLine("Click on a plugin name to download, then move the downloaded file to the `Aliucord/plugins` folder on your device.")
108+
appendLine()
109+
110+
// Plugin list in table format
111+
appendLine("## 🧩 Available Plugins")
112+
appendLine()
113+
appendLine("| Plugin | Description |")
114+
appendLine("|:-------|:------------|")
115+
116+
plugins.forEach { subproject ->
117+
val description = subproject.description ?: "No description provided."
118+
appendLine(
119+
"| [**${subproject.name}**](https://github.com/zt64/aliucord-plugins/raw/builds/${subproject.name}.zip) | $description |"
120+
)
121+
}
106122
}
107123

108124
readMe.writeText(content)

0 commit comments

Comments
 (0)