orbit-client-docs/docs/branding.md

54 lines
1.4 KiB
Markdown

Section: Configuration
Order: 110
# Branding & themes
Everything that ties Orbit to a particular network or brand lives in
[`config.json`](https://orbit.tchatou.fr/docs/config/) under `branding` and `defaults` — no code changes, no rebuild.
## Rebrand
```json
{
"branding": {
"name": "ExampleChat",
"icon": "https://example.org/logo.svg",
"url": "https://example.org",
"tagline": "Chat with",
"taglineEm": "everyone.",
"subtitle": "Public rooms, private messages, and moderation that works."
}
}
```
This changes the connect screen, the console title, the network icon, and the CTCP VERSION/SOURCE
replies the client sends.
## Themes
Orbit ships four themes:
- **light** — clean, default.
- **dark** — easy on the eyes.
- **yomirc** — a retro mIRC / Windows-95 skin (silver chrome, fixed-width log lines).
- **yomirc-dark** — the retro skin in a dark palette.
Set the default for new users:
```json
{ "defaults": { "theme": "dark" } }
```
Users can switch any time in **Settings → Appearance**. See the [Themes wiki page](https://orbit.tchatou.fr/wiki/themes/).
## Feature flags
Hide whole features per deployment:
```json
{ "features": { "push": true, "imageUpload": true, "register": false } }
```
- `push` — the Web Push notifications row.
- `imageUpload` — the composer image button + paste/drag upload.
- `register` — the "create an account" tab.