mirror of
https://github.com/openfrontio/OpenFrontIO.git
synced 2026-07-23 12:30:51 +00:00
## What Adds **crowns** as a new cosmetic category, wired end-to-end like flags/skins, plus a Crowns tab in the lobby cosmetics modal (#4617). Catalog shape in cosmetics.json: ```json "crowns": { "gold_crown": { "name": "gold_crown", "url": "...", "affiliateCode": null, "product": null, "priceHard": 5, "artist": "...", "rarity": "common" } } ``` ## Changes - **Core**: `CrownSchema` + optional `crowns` record in `CosmeticsSchema`; `crownName` in `PlayerCosmeticRefs`; resolved `crown: { name, url }` in `PlayerCosmetics` - **Server**: `isCrownAllowed` in the privilege checker — requires a `crown:*` or `crown:<name>` flare, resolves the ref to the catalog URL - **Client**: crown selection persisted under the `crown` localStorage key (stale/unowned selections self-clear), `crownRelationship` + resolve/refs wiring, `"crown"` purchase type, Crowns tab in the store, and a Crowns tab in the cosmetics modal (owned crowns + Default tile; selecting persists and keeps the modal open) - **i18n**: `store.crowns`, `store.no_crowns` - Tests for schema parsing, privilege checks, and cosmetic resolution ## Not in this PR - In-game rendering of `player.cosmetics.crown` (name pass / leaderboards / player panel) - API-side support (`/shop/purchase` accepting `cosmeticType: "crown"`, granting `crown:<name>` flares, serving `crowns` in cosmetics.json) 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
343 lines
10 KiB
TypeScript
343 lines
10 KiB
TypeScript
import type { TemplateResult } from "lit";
|
|
import { html } from "lit";
|
|
import { customElement, state } from "lit/decorators.js";
|
|
import { UserMeResponse } from "../core/ApiSchemas";
|
|
import { Cosmetics, Crown, Skin } from "../core/CosmeticSchemas";
|
|
import {
|
|
CROWN_KEY,
|
|
PATTERN_KEY,
|
|
USER_SETTINGS_CHANGED_EVENT,
|
|
UserSettings,
|
|
} from "../core/game/UserSettings";
|
|
import { PlayerPattern } from "../core/Schemas";
|
|
import { BaseModal } from "./components/BaseModal";
|
|
import "./components/CosmeticButton";
|
|
import "./components/EffectsGrid";
|
|
import "./components/NotLoggedInWarning";
|
|
import { modalHeader } from "./components/ui/ModalHeader";
|
|
import {
|
|
fetchCosmetics,
|
|
getPlayerCosmetics,
|
|
resolveCosmetics,
|
|
ResolvedCosmetic,
|
|
resolvedToPlayerPattern,
|
|
} from "./Cosmetics";
|
|
import { translateText } from "./Utils";
|
|
|
|
/**
|
|
* One modal for every non-flag cosmetic: a Skins tab (patterns + image skins),
|
|
* a Crowns tab, and an Effects tab (all effect types via the tabbed
|
|
* effects-grid). Opened from the lobby's "Cosmetics" button.
|
|
*/
|
|
@customElement("cosmetics-modal")
|
|
export class CosmeticsModal extends BaseModal {
|
|
protected routerName = "cosmetics";
|
|
|
|
@state() private selectedPattern: PlayerPattern | null = null;
|
|
@state() private selectedColor: string | null = null;
|
|
@state() private selectedSkinName: string | null = null;
|
|
@state() private search = "";
|
|
|
|
private cosmetics: Cosmetics | null = null;
|
|
private userSettings: UserSettings = new UserSettings();
|
|
private userMeResponse: UserMeResponse | false = false;
|
|
|
|
protected modalConfig() {
|
|
return {
|
|
tabs: [
|
|
{ key: "skins", label: translateText("store.patterns") },
|
|
{ key: "crowns", label: translateText("store.crowns") },
|
|
{ key: "effects", label: translateText("store.effects") },
|
|
],
|
|
};
|
|
}
|
|
|
|
private _onCosmeticSelected = async () => {
|
|
await this.updateFromSettings();
|
|
this.refresh();
|
|
};
|
|
|
|
connectedCallback() {
|
|
super.connectedCallback();
|
|
document.addEventListener(
|
|
"userMeResponse",
|
|
(event: CustomEvent<UserMeResponse | false>) => {
|
|
this.onUserMe(event.detail);
|
|
},
|
|
);
|
|
window.addEventListener(
|
|
`${USER_SETTINGS_CHANGED_EVENT}:${PATTERN_KEY}`,
|
|
this._onCosmeticSelected,
|
|
);
|
|
window.addEventListener(
|
|
`${USER_SETTINGS_CHANGED_EVENT}:${CROWN_KEY}`,
|
|
this._onCosmeticSelected,
|
|
);
|
|
}
|
|
|
|
disconnectedCallback() {
|
|
super.disconnectedCallback();
|
|
window.removeEventListener(
|
|
`${USER_SETTINGS_CHANGED_EVENT}:${PATTERN_KEY}`,
|
|
this._onCosmeticSelected,
|
|
);
|
|
window.removeEventListener(
|
|
`${USER_SETTINGS_CHANGED_EVENT}:${CROWN_KEY}`,
|
|
this._onCosmeticSelected,
|
|
);
|
|
}
|
|
|
|
private async updateFromSettings() {
|
|
const cosmetics = await getPlayerCosmetics();
|
|
this.selectedPattern = cosmetics.pattern ?? null;
|
|
this.selectedColor = cosmetics.color?.color ?? null;
|
|
this.selectedSkinName = cosmetics.skin?.name ?? null;
|
|
}
|
|
|
|
async onUserMe(userMeResponse: UserMeResponse | false) {
|
|
this.userMeResponse = userMeResponse;
|
|
this.cosmetics = await fetchCosmetics();
|
|
await this.updateFromSettings();
|
|
this.refresh();
|
|
}
|
|
|
|
private includedInSearch(name: string): boolean {
|
|
const displayName = name.replace(/_/g, " ");
|
|
return displayName.toLowerCase().includes(this.search.toLowerCase());
|
|
}
|
|
|
|
private handleSearch(event: Event) {
|
|
this.search = (event.target as HTMLInputElement).value;
|
|
}
|
|
|
|
/** Combined patterns + skins grid. To the user they're the same: "skins". */
|
|
private renderSkinGrid(): TemplateResult {
|
|
const items = resolveCosmetics(
|
|
this.cosmetics,
|
|
this.userMeResponse,
|
|
null,
|
|
).filter(
|
|
(r) =>
|
|
(r.type === "pattern" || r.type === "skin") &&
|
|
r.relationship === "owned" &&
|
|
(r.cosmetic === null
|
|
? !this.search
|
|
: this.includedInSearch(r.cosmetic.name)),
|
|
);
|
|
|
|
return html`
|
|
<div
|
|
class="flex flex-wrap gap-4 p-8 justify-center items-stretch content-start"
|
|
>
|
|
${items.map((r) => {
|
|
const isSelected =
|
|
r.type === "pattern"
|
|
? (r.cosmetic === null && this.selectedPattern === null) ||
|
|
(r.cosmetic !== null &&
|
|
this.selectedPattern?.name === r.cosmetic.name &&
|
|
(this.selectedPattern?.colorPalette?.name ?? null) ===
|
|
(r.colorPalette?.name ?? null))
|
|
: (() => {
|
|
const skinName = (r.cosmetic as Skin | null)?.name ?? null;
|
|
return (
|
|
(skinName === null && this.selectedSkinName === null) ||
|
|
(skinName !== null && this.selectedSkinName === skinName)
|
|
);
|
|
})();
|
|
return html`
|
|
<cosmetic-button
|
|
.resolved=${r}
|
|
.selected=${isSelected}
|
|
.onSelect=${(rc: ResolvedCosmetic) => this.selectCosmetic(rc)}
|
|
></cosmetic-button>
|
|
`;
|
|
})}
|
|
</div>
|
|
`;
|
|
}
|
|
|
|
/** Owned crowns + a Default (none) tile; selecting persists to UserSettings. */
|
|
private renderCrownGrid(): TemplateResult {
|
|
const items = resolveCosmetics(
|
|
this.cosmetics,
|
|
this.userMeResponse,
|
|
null,
|
|
).filter(
|
|
(r) =>
|
|
r.type === "crown" &&
|
|
r.relationship === "owned" &&
|
|
r.cosmetic !== null &&
|
|
this.includedInSearch(r.cosmetic.name),
|
|
);
|
|
|
|
// The Default tile has no name to match — hide it while searching.
|
|
const noneTile: ResolvedCosmetic = {
|
|
type: "crown",
|
|
cosmetic: null,
|
|
colorPalette: null,
|
|
relationship: "owned",
|
|
key: "crown:none",
|
|
};
|
|
const tiles = this.search ? items : [noneTile, ...items];
|
|
|
|
const selectedCrown = this.userSettings.getSelectedCrownName();
|
|
return html`
|
|
<div
|
|
class="flex flex-wrap gap-4 p-8 justify-center items-stretch content-start"
|
|
>
|
|
${tiles.map((r) => {
|
|
const name = (r.cosmetic as Crown | null)?.name ?? null;
|
|
const isSelected =
|
|
(name === null && selectedCrown === null) ||
|
|
(name !== null && selectedCrown === name);
|
|
return html`
|
|
<cosmetic-button
|
|
.resolved=${r}
|
|
.selected=${isSelected}
|
|
.onSelect=${() => this.selectCrown(name)}
|
|
></cosmetic-button>
|
|
`;
|
|
})}
|
|
</div>
|
|
`;
|
|
}
|
|
|
|
protected renderHeaderSlot() {
|
|
return html`
|
|
<div
|
|
class="relative flex flex-col border-b border-white/10 pb-4 shrink-0"
|
|
>
|
|
${modalHeader({
|
|
title: translateText("cosmetics.title"),
|
|
onBack: () => this.close(),
|
|
ariaLabel: translateText("common.back"),
|
|
rightContent: html`<not-logged-in-warning></not-logged-in-warning>`,
|
|
})}
|
|
|
|
<div class="md:flex items-center gap-2 justify-center mt-4">
|
|
<input
|
|
class="h-12 w-full max-w-md border border-white/10 bg-black/60
|
|
rounded-xl shadow-inner text-xl text-center focus:outline-none
|
|
focus:ring-2 focus:ring-blue-500/50 focus:border-blue-500 text-white placeholder-white/30 transition-all"
|
|
type="text"
|
|
placeholder=${translateText("cosmetics.search")}
|
|
.value=${this.search}
|
|
@change=${this.handleSearch}
|
|
@keyup=${this.handleSearch}
|
|
/>
|
|
</div>
|
|
</div>
|
|
`;
|
|
}
|
|
|
|
protected renderBody(tab: string) {
|
|
let grid: TemplateResult;
|
|
if (tab === "crowns") {
|
|
grid = this.renderCrownGrid();
|
|
} else if (tab === "effects") {
|
|
grid = html`<effects-grid
|
|
mode="select"
|
|
tabbed
|
|
.cosmetics=${this.cosmetics}
|
|
.userMeResponse=${this.userMeResponse}
|
|
.search=${this.search}
|
|
></effects-grid>`;
|
|
} else {
|
|
grid = this.renderSkinGrid();
|
|
}
|
|
return html`
|
|
<div class="flex justify-center py-3 shrink-0">
|
|
<o-button
|
|
class="no-crazygames"
|
|
variant="primary"
|
|
size="sm"
|
|
translationKey="main.store"
|
|
@click=${() => {
|
|
this.close();
|
|
window.showPage?.("page-item-store");
|
|
}}
|
|
></o-button>
|
|
</div>
|
|
<div class="px-3 pb-3">${grid}</div>
|
|
`;
|
|
}
|
|
|
|
protected async onOpen(): Promise<void> {
|
|
await this.refresh();
|
|
}
|
|
|
|
protected onClose(): void {
|
|
this.search = "";
|
|
}
|
|
|
|
private selectCosmetic(resolved: ResolvedCosmetic) {
|
|
if (resolved.type === "pattern") {
|
|
this.selectPattern(resolvedToPlayerPattern(resolved));
|
|
} else if (resolved.type === "skin") {
|
|
this.selectSkin((resolved.cosmetic as Skin | null)?.name ?? null);
|
|
}
|
|
}
|
|
|
|
private selectSkin(skinName: string | null) {
|
|
this.userSettings.setSelectedPatternName(
|
|
skinName === null ? undefined : `skin:${skinName}`,
|
|
);
|
|
this.selectedSkinName = skinName;
|
|
this.selectedPattern = null;
|
|
// Stay open — the tile highlight moves to the new selection.
|
|
this.refresh();
|
|
}
|
|
|
|
private selectCrown(crownName: string | null) {
|
|
this.userSettings.setSelectedCrownName(crownName ?? undefined);
|
|
// Stay open — the tile highlight moves to the new selection.
|
|
this.refresh();
|
|
}
|
|
|
|
private selectPattern(pattern: PlayerPattern | null) {
|
|
this.selectedColor = null;
|
|
if (pattern === null) {
|
|
this.userSettings.setSelectedPatternName(undefined);
|
|
} else {
|
|
const name =
|
|
pattern.colorPalette?.name === undefined
|
|
? pattern.name
|
|
: `${pattern.name}:${pattern.colorPalette.name}`;
|
|
this.userSettings.setSelectedPatternName(`pattern:${name}`);
|
|
}
|
|
this.selectedPattern = pattern;
|
|
this.selectedSkinName = null;
|
|
// Stay open — the tile highlight moves to the new selection.
|
|
this.refresh();
|
|
this.showSkinSelectedPopup();
|
|
}
|
|
|
|
private showSkinSelectedPopup() {
|
|
let skinName = translateText("territory_patterns.pattern.default");
|
|
if (this.selectedPattern && this.selectedPattern.name) {
|
|
skinName = this.selectedPattern.name
|
|
.split("_")
|
|
.map((w) => w.charAt(0).toUpperCase() + w.slice(1))
|
|
.join(" ");
|
|
if (
|
|
this.selectedPattern.colorPalette &&
|
|
this.selectedPattern.colorPalette.name
|
|
) {
|
|
skinName += ` (${this.selectedPattern.colorPalette.name})`;
|
|
}
|
|
}
|
|
window.dispatchEvent(
|
|
new CustomEvent("show-message", {
|
|
detail: {
|
|
message: `${skinName} ${translateText("territory_patterns.selected")}`,
|
|
duration: 2000,
|
|
},
|
|
}),
|
|
);
|
|
}
|
|
|
|
public async refresh() {
|
|
this.requestUpdate();
|
|
}
|
|
}
|