Plugin

PlatformIndicators

Adds platform indicators (Desktop, Mobile, Web...) to users

Appearance
index.tsx
Download

Source

src/plugins/platformIndicators/index.tsx
1/*
2 * FiveCord — a Discord client mod
3 * Copyright (c) 2025 FiveCord
4 * SPDX-License-Identifier: GPL-3.0-or-later
5 */
6
7import "./style.css";
8
9import { addProfileBadge, BadgePosition, BadgeUserArgs, ProfileBadge, removeProfileBadge } from "@api/Badges";
10import { addMemberListDecorator, removeMemberListDecorator } from "@api/MemberListDecorators";
11import { addMessageDecoration, removeMessageDecoration } from "@api/MessageDecorations";
12import { definePluginSettings } from "@api/Settings";
13import { Devs } from "@utils/constants";
14import definePlugin, { OptionType } from "@utils/types";
15import { DiscordPlatform, OnlineStatus, User } from "@vencord/discord-types";
16import { filters, findStoreLazy, mapMangledModuleLazy } from "@webpack";
17import { AuthenticationStore, PresenceStore, Tooltip, UserStore, useStateFromStores } from "@webpack/common";
18
19export interface Session {
20 sessionId: string;
21 status: string;
22 active: boolean;
23 clientInfo: {
24 version: number;
25 os: string;
26 client: string;
27 };
28}
29
30const SessionsStore = findStoreLazy("SessionsStore") as {
31 getSessions(): Record<string, Session>;
32};
33const { useStatusFillColor } = mapMangledModuleLazy([".5625*", "translate"], {
34 useStatusFillColor: filters.byCode(".hex")
35});
36
37const platformMap = {
38 embedded: "Console",
39 vr: "VR"
40};
41
42const badge: ProfileBadge = {
43 id: "vc_platform_indicator_wrapper",
44 getBadges,
45 position: BadgePosition.START,
46};
47
48const indicatorLocations = {
49 list: {
50 description: "In the member list",
51 onEnable: () => addMemberListDecorator("platform-indicator", ({ user }) =>
52 user && !user.bot ? <PlatformIndicator user={user} small={true} /> : null
53 ),
54 onDisable: () => removeMemberListDecorator("platform-indicator")
55 },
56 badges: {
57 description: "In user profiles, as badges",
58 onEnable: () => addProfileBadge(badge),
59 onDisable: () => removeProfileBadge(badge)
60 },
61 messages: {
62 description: "Inside messages",
63 onEnable: () => addMessageDecoration("platform-indicator", props => {
64 const user = props.message?.author;
65 return user && !user.bot ? <PlatformIndicator user={props.message?.author} /> : null;
66 }),
67 onDisable: () => removeMessageDecoration("platform-indicator")
68 }
69};
70
71const Icons = {
72 desktop: Icon("M4 2.5c-1.103 0-2 .897-2 2v11c0 1.104.897 2 2 2h7v2H7v2h10v-2h-4v-2h7c1.103 0 2-.896 2-2v-11c0-1.103-.897-2-2-2H4Zm16 2v9H4v-9h16Z"),
73 web: Icon("M12 2C6.48 2 2 6.48 2 12s4.48 10 10 10 10-4.48 10-10S17.52 2 12 2Zm-1 17.93c-3.95-.49-7-3.85-7-7.93 0-.62.08-1.21.21-1.79L9 15v1c0 1.1.9 2 2 2v1.93Zm6.9-2.54c-.26-.81-1-1.39-1.9-1.39h-1v-3c0-.55-.45-1-1-1H8v-2h2c.55 0 1-.45 1-1V7h2c1.1 0 2-.9 2-2v-.41c2.93 1.19 5 4.06 5 7.41 0 2.08-.8 3.97-2.1 5.39Z"),
74 mobile: Icon("M 187 0 L 813 0 C 916.277 0 1000 83.723 1000 187 L 1000 1313 C 1000 1416.277 916.277 1500 813 1500 L 187 1500 C 83.723 1500 0 1416.277 0 1313 L 0 187 C 0 83.723 83.723 0 187 0 Z M 125 1000 L 875 1000 L 875 250 L 125 250 Z M 500 1125 C 430.964 1125 375 1180.964 375 1250 C 375 1319.036 430.964 1375 500 1375 C 569.036 1375 625 1319.036 625 1250 C 625 1180.964 569.036 1125 500 1125 Z", { viewBox: "0 0 1000 1500", height: 17, width: 17 }),
75 embedded: Icon("M14.8 2.7 9 3.1V47h3.3c1.7 0 6.2.3 10 .7l6.7.6V2l-4.2.2c-2.4.1-6.9.3-10 .5zm1.8 6.4c1 1.7-1.3 3.6-2.7 2.2C12.7 10.1 13.5 8 15 8c.5 0 1.2.5 1.6 1.1zM16 33c0 6-.4 10-1 10s-1-4-1-10 .4-10 1-10 1 4 1 10zm15-8v23.3l3.8-.7c2-.3 4.7-.6 6-.6H43V3h-2.2c-1.3 0-4-.3-6-.6L31 1.7V25z", { viewBox: "0 0 50 50" }),
76 vr: Icon("M8.46 8.64a1 1 0 0 1 1 1c0 .44-.3.8-.72.92l-.11.07c-.08.06-.2.19-.2.41a.99.99 0 0 1-.98.86h-.06a1 1 0 0 1-.94-1.05l.02-.32c.05-1.06.92-1.9 1.99-1.9ZM15.55 5a5.5 5.5 0 0 1 5.15 3.67h.3a2 2 0 0 1 2 2v3.18a2 2 0 0 1-2 1.99h-.2A4.54 4.54 0 0 1 16.55 19a4.45 4.45 0 0 1-3.6-1.83 1.2 1.2 0 0 0-1.9 0 4.44 4.44 0 0 1-3.9 1.82 4.54 4.54 0 0 1-3.94-3.15H3a2 2 0 0 1-2-2v-3.18c0-1.1.9-1.99 2-1.99h.3A5.5 5.5 0 0 1 8.46 5h7.09Zm-7.1 2C6.6 7 5.06 8.5 4.97 10.41l-.02.66v3.18c0 1.43 1.05 2.66 2.34 2.74.85.06 1.63-.32 2.14-1.01a3.2 3.2 0 0 1 2.57-1.3c1 0 1.97.48 2.57 1.3.5.69 1.3 1.08 2.14 1.01 1.3-.08 2.34-1.31 2.34-2.74l-.02-3.84a3.54 3.54 0 0 0-3.49-3.43H8.45Z", { viewBox: "0 4 24 16", height: 20, width: 20 }),
77} satisfies Record<DiscordPlatform, any>;
78
79const settings = definePluginSettings({
80 ...Object.fromEntries(
81 Object.entries(indicatorLocations).map(([key, value]) => {
82 return [key, {
83 type: OptionType.BOOLEAN,
84 description: `Show indicators ${value.description.toLowerCase()}`,
85 // onChange doesn't give any way to know which setting was changed, so restart required
86 restartNeeded: true,
87 default: true
88 }];
89 })
90 ),
91 colorMobileIndicator: {
92 type: OptionType.BOOLEAN,
93 description: "Whether to make the mobile indicator match the color of the user status.",
94 default: true,
95 restartNeeded: true
96 }
97});
98
99function Icon(path: string, opts?: { viewBox?: string; width?: number; height?: number; }) {
100 return ({ color, tooltip, small }: { color: string; tooltip: string; small: boolean; }) => (
101 <Tooltip text={tooltip}>
102 {tooltipProps => (
103 <svg
104 {...tooltipProps}
105 height={(opts?.height ?? 20) - (small ? 3 : 0)}
106 width={(opts?.width ?? 20) - (small ? 3 : 0)}
107 viewBox={opts?.viewBox ?? "0 0 24 24"}
108 fill={color}
109 >
110 <path d={path} />
111 </svg>
112 )}
113 </Tooltip>
114 );
115}
116
117function getPlatformTooltip(platform: DiscordPlatform): string {
118 return platformMap[platform] ?? platform.charAt(0).toUpperCase() + platform.slice(1);
119}
120
121const PlatformIcon = ({ platform, status, small }: { platform: DiscordPlatform, status: OnlineStatus; small: boolean; }) => {
122 const tooltip = getPlatformTooltip(platform as DiscordPlatform);
123
124 const Icon = Icons[platform] ?? Icons.desktop;
125
126 return <Icon color={useStatusFillColor(status)} tooltip={tooltip} small={small} />;
127};
128
129function ensureOwnStatus(user: User) {
130 if (user.id === AuthenticationStore.getId()) {
131 const sessions = SessionsStore.getSessions();
132 if (typeof sessions !== "object") return null;
133 const sortedSessions = Object.values(sessions).sort(({ status: a }, { status: b }) => {
134 if (a === b) return 0;
135 if (a === "online") return 1;
136 if (b === "online") return -1;
137 if (a === "idle") return 1;
138 if (b === "idle") return -1;
139 return 0;
140 });
141
142 const ownStatus = Object.values(sortedSessions).reduce((acc, curr) => {
143 if (curr.clientInfo.client !== "unknown")
144 acc[curr.clientInfo.client] = curr.status;
145 return acc;
146 }, {});
147
148 const { clientStatuses } = PresenceStore.getState();
149 clientStatuses[AuthenticationStore.getId()] = ownStatus;
150 }
151}
152
153function getBadges({ userId }: BadgeUserArgs): ProfileBadge[] {
154 const user = UserStore.getUser(userId);
155
156 if (!user || user.bot) return [];
157
158 ensureOwnStatus(user);
159
160 const status = PresenceStore.getClientStatus(user.id);
161 if (!status) return [];
162
163 return Object.entries(status).map(([platform, status]) => ({
164 key: `vc-platform-indicator-${platform}`,
165 id: `vc-platform-indicator-${platform}`,
166 component: () => (
167 <span className="vc-platform-indicator">
168 <PlatformIcon
169 key={platform}
170 platform={platform as DiscordPlatform}
171 status={status}
172 small={false}
173 />
174 </span>
175 ),
176 }));
177}
178
179const PlatformIndicator = ({ user, small = false }: { user: User; small?: boolean; }) => {
180 ensureOwnStatus(user);
181
182 const status = useStateFromStores([PresenceStore], () => PresenceStore.getClientStatus(user.id));
183 if (!status) return null;
184
185 const icons = Object.entries(status).map(([platform, status]) => (
186 <PlatformIcon
187 key={platform}
188 platform={platform as DiscordPlatform}
189 status={status}
190 small={small}
191 />
192 ));
193
194 if (!icons.length) return null;
195
196 return (
197 <span
198 className="vc-platform-indicator"
199 style={{ gap: "2px" }}
200 >
201 {icons}
202 </span>
203 );
204};
205
206export default definePlugin({
207 name: "PlatformIndicators",
208 description: "Adds platform indicators (Desktop, Mobile, Web...) to users",
209 tags: ["Appearance"],
210 authors: [Devs.kemo, Devs.TheSun, Devs.Nuckyz, Devs.Ven],
211 dependencies: ["MessageDecorationsAPI", "MemberListDecoratorsAPI"],
212 settings,
213
214 start() {
215 Object.entries(indicatorLocations).forEach(([key, value]) => {
216 if (settings.store[key]) value.onEnable();
217 });
218 },
219
220 stop() {
221 Object.entries(indicatorLocations).forEach(([_, value]) => {
222 value.onDisable();
223 });
224 },
225
226 patches: [
227 {
228 find: ".Masks.STATUS_ONLINE_MOBILE",
229 predicate: () => settings.store.colorMobileIndicator,
230 replacement: [
231 {
232 // Return the STATUS_ONLINE_MOBILE mask if the user is on mobile, no matter the status
233 match: /\.STATUS_TYPING;switch(?=.+?(if\(\i\)return \i\.\i\.Masks\.STATUS_ONLINE_MOBILE))/,
234 replace: ".STATUS_TYPING;$1;switch"
235 },
236 {
237 // Return the STATUS_ONLINE_MOBILE mask if the user is on mobile, no matter the status
238 match: /switch\(\i\)\{case \i\.\i\.ONLINE:(if\(\i\)return\{[^}]+\})/,
239 replace: "$1;$&"
240 }
241 ]
242 },
243 {
244 find: ".AVATAR_STATUS_MOBILE_16;",
245 predicate: () => settings.store.colorMobileIndicator,
246 replacement: [
247 {
248 // Return the AVATAR_STATUS_MOBILE size mask if the user is on mobile, no matter the status
249 match: /\i===\i\.\i\.ONLINE&&(?=.{0,70}\.AVATAR_STATUS_MOBILE_16;)/,
250 replace: ""
251 },
252 {
253 // Fix sizes for mobile indicators which aren't online
254 match: /(?<=\(\i\.status,)(\i)(?=,\{.{0,15}isMobile:(\i))/,
255 replace: &#039;$2?"online":$1&#039;
256 },
257 {
258 // Make isMobile true no matter the status
259 match: /(?<=\i&&!\i)&&\i===\i\.\i\.ONLINE/,
260 replace: ""
261 }
262 ]
263 },
264 {
265 find: "}isMobileOnline(",
266 predicate: () => settings.store.colorMobileIndicator,
267 replacement: {
268 // Make isMobileOnline return true no matter what is the user status
269 match: /(?<=\i\[\i\.\i\.MOBILE\])===\i\.\i\.ONLINE/,
270 replace: "!= null"
271 }
272 }
273 ]
274});
275