Skip to content

Commit 237092b

Browse files
committed
feat(brand): rename the display name to herald
Sets the name in the README, the documentation site and the Decky menu, and adds the wordmark: the name in inscriptional Roman capitals, the register coats of arms and mottoes are cut in, so the typeface carries the same idea the name does. The glyphs ship as outlines, not as text, so nothing has to have the font installed. Two inks are selected through a picture element, because one colour cannot sit on both GitHub themes. Decky keys a plugin's settings and data directories off the package name, not off plugin.json's name field -- verified against the shipped artefact, whose top-level folder is decky-romm-sync while its plugin.json said "RomM Sync". Changing the display name is therefore free: existing installs keep their settings, their database and their shortcut ownership records. Renaming the package is a separate move that needs a migration first, tracked in #1547 and #1548. The README says so too, so the announcement reads as information rather than a reason to worry.
1 parent c78936b commit 237092b

15 files changed

Lines changed: 33 additions & 10 deletions

.markdownlint.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
"code",
1111
"details",
1212
"div",
13+
"h3",
1314
"img",
1415
"p",
1516
"picture",

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
<div align="center">
22

3-
<img src="assets/logo.png" alt="" width="200">
3+
<picture>
4+
<source media="(prefers-color-scheme: dark)" srcset="assets/lockup-dark.png">
5+
<img src="assets/lockup.png" alt="herald" width="300">
6+
</picture>
47

5-
# decky-romm-sync
6-
7-
## Your self-hosted RomM library, in your Steam library
8+
<h3>Your self-hosted RomM library, in your Steam library</h3>
89

910
[Getting Started](https://danielcopper.github.io/decky-romm-sync/user-guide/getting-started/) ·
1011
[Configuration](https://danielcopper.github.io/decky-romm-sync/user-guide/configuration/) ·
@@ -20,10 +21,16 @@
2021
<a href="https://github.com/danielcopper/decky-romm-sync/stargazers"><img alt="Stars" src="https://img.shields.io/github/stars/danielcopper/decky-romm-sync?style=for-the-badge&color=4795c9&labelColor=16202c"></a>
2122
<a href="https://github.com/danielcopper/decky-romm-sync/releases"><img alt="Downloads" src="https://img.shields.io/github/downloads/danielcopper/decky-romm-sync/total?style=for-the-badge&color=4795c9&labelColor=16202c"></a>
2223
<a href="https://github.com/rommapp/romm/releases"><img alt="Requires RomM 4.9.0 or newer" src="https://img.shields.io/badge/RomM-%E2%89%A5%204.9.0-4795c9?style=for-the-badge&labelColor=16202c"></a>
23-
<a href="https://github.com/danielcopper/decky-romm-sync/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/badge/license-GPL--3.0-4795c9?style=for-the-badge&labelColor=16202c"></a>
24+
25+
<sub>formerly <code>decky-romm-sync</code></sub>
2426

2527
</div>
2628

29+
> [!NOTE]
30+
> **This project is being renamed to `herald`.** The repository and documentation links move with it; GitHub redirects
31+
> the old repository URLs automatically. The plugin's own package name is unchanged for now, so updating keeps your
32+
> settings, your synced library and your saves exactly where they are.
33+
2734
A [Decky Loader](https://decky.xyz/) plugin that syncs your self-hosted [RomM](https://github.com/rommapp/romm) library
2835
into Steam as non-steam shortcuts. Games appear directly in your Steam library, launch through
2936
[RetroDECK](https://retrodeck.net/), and can keep their saves in sync across devices through your RomM server.
@@ -78,7 +85,7 @@ into Steam as non-steam shortcuts. Games appear directly in your Steam library,
7885
> **v1.0** release. Until then, use the manual install below.
7986
8087
Once published, install it straight from Decky's built-in store — open the Quick Access Menu → **Decky** → store icon,
81-
search for **RomM Sync**, and install. No Developer Mode required.
88+
search for **herald**, and install. No Developer Mode required.
8289

8390
</details>
8491

@@ -100,7 +107,7 @@ gear icon → toggle **Developer Mode**).
100107
101108
## Quick start
102109

103-
1. Open the Quick Access Menu and select **RomM Sync**
110+
1. Open the Quick Access Menu and select **herald**
104111
2. In **Settings**, enter your RomM server URL and credentials, then hit **Test Connection**
105112
3. In **Platforms**, enable the platforms you want to sync
106113
4. Hit **Sync Library** — your ROMs appear as non-steam shortcuts

assets/lockup-dark.png

35.4 KB
Loading

assets/lockup-dark.svg

Lines changed: 1 addition & 0 deletions
Loading

assets/lockup.png

35.4 KB
Loading

assets/lockup.svg

Lines changed: 1 addition & 0 deletions
Loading

docs/assets/lockup-dark.png

35.4 KB
Loading

docs/assets/lockup-dark.svg

Lines changed: 1 addition & 0 deletions
Loading

docs/assets/lockup.png

35.4 KB
Loading

docs/assets/lockup.svg

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)