> [!IMPORTANT] > Merging this PR will create a new release. ## Features * Added a GIF search functionality ([#970](<https://github.com/SableClient/Sable/pull/970>) by @7w1, @nikiwastaken) * Change unverified device flow. ([#1017](<https://github.com/SableClient/Sable/pull/1017>) by @nikiwastaken, @nushea) * Change animal identity to allow arbitrary animals ([#984](<https://github.com/SableClient/Sable/pull/984>) by @nushea) * Add a new Mobile Context ([#946](<https://github.com/SableClient/Sable/pull/946>) by @7w1, @nushea) * Add bookmark functionality using account data ([#1000](<https://github.com/SableClient/Sable/pull/1000>) by @nikiwastaken, @nushea) * Add Copy Message button to copy unformatted version. ([#1001](<https://github.com/SableClient/Sable/pull/1001>) by @nushea) * Change profile handle part to a button that copies it ([#981](<https://github.com/SableClient/Sable/pull/981>) by @nushea) * Add reactions to arbitrary events ([#946](<https://github.com/SableClient/Sable/pull/946>) by @7w1, @nushea) * Added a gallery support as per msc4274 ([#1019](<https://github.com/SableClient/Sable/pull/1019>) by @nikiwastaken, @nushea) * Add a context menu for copying and downloading images. ([#994](<https://github.com/SableClient/Sable/pull/994>) by @nikiwastaken, @nushea) * Add search message keybind and combine sidebar items. ([#943](<https://github.com/SableClient/Sable/pull/943>) by @nushea) * Add option for showing icons only when available and changed default to it ([#978](<https://github.com/SableClient/Sable/pull/978>) by @nushea) * Add CTRL+E shortcut to editor to bring sticker menu up ([#982](<https://github.com/SableClient/Sable/pull/982>) by @nushea) * Redesign the user menu tab ([#990](<https://github.com/SableClient/Sable/pull/990>) by @nikiwastaken, @nushea) * Modify large parts of the mobile view of Sable! ([#1017](<https://github.com/SableClient/Sable/pull/1017>) by @nikiwastaken, @nushea) * Improved sliding sync (only requests specific room state data), cleaned up and fixed most flickering issues, and added buttons in developer tools to request full state. ([#1020](<https://github.com/SableClient/Sable/pull/1020>) by @7w1) ### Revamped the calling experience in Sable! ([#841](<https://github.com/SableClient/Sable/pull/841>) by @7w1) - Pulled the latest Element Call updates. - Style improvements to the call widget so it uses the Sable theme and fonts. - Added support for custom ringtones and ringbacks. - Added call permissions. - Fixed various bugs around call ending, declining, and joining. ## Fixes * Allow favoriting all animated attachment types ([#1029](<https://github.com/SableClient/Sable/pull/1029>) by @nikiwastaken) * Updated emojis to use stable 1.19 identifiers ([#1034](<https://github.com/SableClient/Sable/pull/1034>) by @7w1) * Swap to using the stable identifier `m.recent_emoji` for recent emojis and add migration logic. ([#1009](<https://github.com/SableClient/Sable/pull/1009>) by @7w1) * Add a direct link to room/space settings when the current sticker list is empty ([#1016](<https://github.com/SableClient/Sable/pull/1016>) by @7w1, @ellieplayswow) * Fix leaving modal looking outsized ([#991](<https://github.com/SableClient/Sable/pull/991>) by @nushea) * Fix cat status not being present on its own. ([#971](<https://github.com/SableClient/Sable/pull/971>) by @nikiwastaken) * Fix encrypted thread messages not appearing until reopened. ([#975](<https://github.com/SableClient/Sable/pull/975>) by @7w1) * Fix codebase issues with gadient themes ([#1007](<https://github.com/SableClient/Sable/pull/1007>) by @nushea) * Fix account switcher's add account button redirecting to the wrong path when hashRouter is enabled ([#993](<https://github.com/SableClient/Sable/pull/993>) by @EphemeralFog) * Fix the image viewer header not being fully visible on smaller phone screens. ([#1035](<https://github.com/SableClient/Sable/pull/1035>) by @7w1) * Fix mentions not sending in non-textual replies ([#1004](<https://github.com/SableClient/Sable/pull/1004>) by @nushea) * Fixed oidc device delete key being incorrect. ([#1030](<https://github.com/SableClient/Sable/pull/1030>) by @7w1) * Fix crash when opening pins with stickers. ([#972](<https://github.com/SableClient/Sable/pull/972>) by @7w1) * Fix pixelated image scaling not pixelating when zoomed in. ([#1033](<https://github.com/SableClient/Sable/pull/1033>) by @7w1) * Fix registration not working when accessed from add account button ([#992](<https://github.com/SableClient/Sable/pull/992>) by @EphemeralFog) * Reverse the order of message header elements in the right aligned bubbles layout. ([#967](<https://github.com/SableClient/Sable/pull/967>) by @EphemeralFog) * Fixed outdated Firefox versions and some Safari versions not being able to send messages. ([#1010](<https://github.com/SableClient/Sable/pull/1010>) by @7w1) * Fix timeline sorting order regression when "show hidden events" is enabled. ([#974](<https://github.com/SableClient/Sable/pull/974>) by @7w1) * Fix ghost quickmenu ([#946](<https://github.com/SableClient/Sable/pull/946>) by @7w1, @nushea) * Fix Collapsed mode showing the wrong icon ([#978](<https://github.com/SableClient/Sable/pull/978>) by @nushea) * Fix poll crashing sable if interacted with different clients ([#969](<https://github.com/SableClient/Sable/pull/969>) by @nushea) * Fix video player sometimes not working ([#1031](<https://github.com/SableClient/Sable/pull/1031>) by @nushea) * Add support for searching users via nicknames in the autocomplete menu. ([#1028](<https://github.com/SableClient/Sable/pull/1028>) by @7w1) * Update `@sableclient/twemoji-font` to fix missing Twemoji emoji coverage. ([#964](<https://github.com/SableClient/Sable/pull/964>) by @7w1)
Sable
A Matrix client built to enhance the user experience with quality-of-life features, cosmetics, utilities, and sheer usability. See the changelog.
Soon to be replaced desktop apps can be downloaded here. They auto-update by pulling the website.
Join our matrix space here to discuss features, issues, or meowing.
Forked from Cinny.
Getting started
The web app is available at app.sable.moe and gets updated on frequently, as soon as a feature is deemed stable.
You can also download our desktop app for windows and linux from releases.
Self-hosting
You have a few options for self hosting, you can:
- Run the prebuilt docker container.
- Deploy on a site like GitLab Pages. Jae has a guide here.
- Build it yourself.
Docker
Prebuilt images are published to ghcr.io/sableclient/sable.
latesttracks the currentdevbranch image.X.Y.Ztags are versioned releases.X.Ytags float within a release line.- Pushes to
devalso publish a short commit SHA tag.
Run the latest image with:
docker run --rm -p 8080:8080 ghcr.io/sableclient/sable:latest
Then open http://localhost:8080.
If you want to override the bundled config.json, mount your own
file at /app/config.json:
services:
sable:
image: ghcr.io/sableclient/sable:latest
ports:
- '8080:8080'
volumes:
- ./config.json:/app/config.json:ro
Build it yourself
To build and serve Sable yourself with nginx, clone this repo and build it:
pnpm i # Installs all dependencies
pnpm run build # Compiles the app into the dist/ directory
After that, you can copy the dist/ directory to your server and serve it.
- In the
config.json, you can modify the default homeservers, feature rooms/spaces, toggle the account switcher, and toggle experimental simplified slilding sync support.
Optional default client settings
While the default settings are recommended for most users, you can optionally add a top-level "settingsDefaults" object whose keys match client settings (only fields you want to override) to override them. The default settings for any new logins will match these. Existing keys in local storage or users who chose to sync settings with their account data will still have their settings set.
For example:
{
"settingsDefaults": {
"hour24Clock": true,
"pageZoom": 110,
"messageLayout": 2,
"rightSwipeAction": "members",
"captionPosition": "below",
"renderUserCards": "both",
"jumboEmojiSize": "large"
}
}
Invalid or unknown keys are ignored.
- To deploy on subdirectory, you need to rebuild the app youself after updating the
basepath inbuild.config.ts.- For example, if you want to deploy on
https://sable.moe/app, then setbase: '/app'.
- For example, if you want to deploy on
Local development
Tip
We recommend using a version manager as versions change quickly. fnm is a great cross-platform option (Windows, macOS, and Linux). NVM on Windows and nvm on Linux/macOS are also good choices. Use the version defined in
.node-version.
Execute the following commands to start a development server:
fnm use --corepack-enabled # Activates the Node version and enables corepack
# If you not using fnm, install corepack manually: npm install --global corepack@latest
corepack install # Installs the pnpm version specified in package.json
pnpm i # Installs all dependencies
pnpm run dev # Serve a development version
To build the app:
pnpm run build # Compiles the app into the dist/ directory
Deployment and infrastructure
Deployment workflows and infrastructure details live in
infra/README.md.