Shelter: Difference between revisions
mNo edit summary |
Yellowsink (talk | contribs) m (Change Lune to an internal link (would go under the client development category)) |
||
| (7 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Lowercase title}} | |||
{{Infobox mod | |||
| name = shelter | |||
| logo = shelter-banner.png | |||
| logoCaption = shelter logo, by [[toonlink]] | |||
| yearsActive = November 2022 - present (1 year ago) | |||
| platforms = Desktop, Web | |||
| developers = [[Yellowsink]], wiz, [[toonlink]] | |||
| repo = [https://github.com/uwu/shelter uwu/shelter] | |||
| licenses = Creative Commons Zero (CC0-1.0-Universal) | |||
| languages = [https://en.wikipedia.org/wiki/TypeScript TypeScript] | |||
}} | |||
[https://github.com/uwu/shelter shelter] is a client modification for Discord made by [https://uwu.network uwu.network], | |||
designed in a [[Discord SWC Change|post-SWC]] modding scene. | |||
The goal is to make a bulletproof client mod that doesn't break at | The goal is to make a bulletproof client mod that doesn't break due to Discord | ||
updates<ref name=":0">[http://web.archive.org/web/20230121083343/https://cumcord.com/an-exercise-in-futility An exercise in futility]</ref>. | |||
== Features & Concepts == | |||
Many of the design choices and ideals were carried over from [[Cumcord]], | |||
including running entirely within the web context, use of IndexedDB, and details of the plugin loader implementation. | |||
The core idea is that plugins (uniquely) do not make use of Webpack nor Discord bundled code at all, and instead use Flux, React Fibers, | |||
and document modification to work<ref>[https://github.com/uwu/shelter/blob/ecc282a/packages/shelter-docs/docs/guides/ideals.md#placing-bets-on-stability "Ideals" documentation page - Placing bets on stability]</ref>. | |||
== Plugins == | == Plugins == | ||
You can search <code>shelter-plugins</code> | You can [https://github.com/search?q=shelter-plugins&type=repositories search <code>shelter-plugins</code> on GitHub] to find available plugin repositories. | ||
As of now, not many plugins exist. | |||
== Availability == | == Availability == | ||
Shelter is available on Discord Desktop, Web, [[scor]], and ArmCord. | Shelter is available on Discord Desktop, Web, [[scor]], and [[ArmCord]]. | ||
== History == | |||
After the [[Discord SWC Change]] broke all active client mods on the 26th September 2022, [[Cumcord]] was discontinued the day after<ref name=":0" />. | |||
Another day later, [[toonlink]] announced an unnamed new mod which would become shelter. | |||
Over the next two months, shelter was slowly built (mostly implemented by [[User:Yellowsink|Yellowsink]] based on link's vision), and on the 12th November 2022, shelter was publicly | |||
released<ref>[https://discord.com/channels/824921608560181258/824923929138954241/1041125639576637451 shelter release announcement]</ref>. | |||
On the 18th March 2023, [[Lune]], the build tool, was released to simplify and improve the plugin development experience. | |||
The next day, the first version of the API documentation was released. | |||
On the 23rd February 2024, the recreations of Discord's UI components included in shelter were [https://npm.im/@uwu/shelter-ui made available] for use outside the shelter mod. | |||
[[Category:Client Mods]] | [[Category:Client Mods]] | ||
Latest revision as of 19:46, 11 March 2024
| shelter | |
|---|---|
 shelter logo, by toonlink | |
| Active | November 2022 - present (1 year ago) |
| Platform(s) | Desktop, Web |
| Lead developer(s) | Yellowsink, wiz, toonlink |
| Repository | uwu/shelter |
| License(s) | Creative Commons Zero (CC0-1.0-Universal) |
| Language(s) | TypeScript |
shelter is a client modification for Discord made by uwu.network, designed in a post-SWC modding scene.
The goal is to make a bulletproof client mod that doesn't break due to Discord updates[1].
Features & Concepts
Many of the design choices and ideals were carried over from Cumcord, including running entirely within the web context, use of IndexedDB, and details of the plugin loader implementation.
The core idea is that plugins (uniquely) do not make use of Webpack nor Discord bundled code at all, and instead use Flux, React Fibers, and document modification to work[2].
Plugins
You can search shelter-plugins on GitHub to find available plugin repositories.
As of now, not many plugins exist.
Availability
Shelter is available on Discord Desktop, Web, scor, and ArmCord.
History
After the Discord SWC Change broke all active client mods on the 26th September 2022, Cumcord was discontinued the day after[1].
Another day later, toonlink announced an unnamed new mod which would become shelter.
Over the next two months, shelter was slowly built (mostly implemented by Yellowsink based on link's vision), and on the 12th November 2022, shelter was publicly released[3].
On the 18th March 2023, Lune, the build tool, was released to simplify and improve the plugin development experience. The next day, the first version of the API documentation was released.
On the 23rd February 2024, the recreations of Discord's UI components included in shelter were made available for use outside the shelter mod.