@adiakys/feeling-lucky 0.1.0 → 0.3.0

package/README.md

@@ -64,10 +64,12 @@ Every field takes a value, a function, or a function returning a Promise.
 | `locale` | language code, e.g. `'it'` or `'pt-BR'` | follows the host page, see [Languages](#languages) |
 | `messages` | `{ [locale]: Messages }`: new languages, or overrides of the built-in ones | none |
 | `logo` | image URL of your brand mark, on the certificate, the wheel's hub and the scratch card | a clover |
+| `dealers` | `Dealer[]`: the dealers who take the Salon Privé's shifts, see [Dealers](#dealers) | the library's own dealer |
 | `player` | `{ name, avatar? }`, shown at the card tables | anonymous seat |
 | `onWin` | `(win: Win) => void` | none |
 | `onClaim` | `(win: Win) => Promise<void>`; shows **Claim** on the certificate | no claim button |
 | `developer` | `true` or `{ passwordHash? }`: enables the developer menu (Ctrl+Shift+L), behind a password when the hash is given | disabled |
+| `multiplayer` | base URL of a [multiplayer server](#multiplayer), or `{ url, headers? }` | single player |
 
 ```ts
 interface Prize {
@@ -159,8 +161,72 @@ createFeelingLucky({
   - Takeoff or Breakaway in place of the slot
   - Double Luck or Forever in place of the scratch card
   - colour Pachinko
+- **Dealers:** three shifts a day, the same for everyone, from the date's hash, see [Dealers](#dealers).
 - **Room themes:** Christmas, Halloween, Easter and August, taken from the calendar.
 
+## Dealers
+
+A dealer stands at the Salon Privé's tables during three shifts a day of 30 to 90 minutes between 10:00 and 23:00, local time. The shifts come from the date's hash, and the dealers in the list take them in turn. While a dealer is on shift, Blackjack and Texas Hold'em win twice as often. A dealer arriving or leaving mid-game walks in or out of the table, and the odds change from the next hand.
+
+```ts
+interface Dealer {
+  image: string;    // waist-up portrait, transparent background, forearms resting forward at the bottom
+  name?: string;
+  hands?: string;   // CSS clip-path of the forearms and hands, drawn over the table's rim
+}
+```
+
+Without `dealers`, the library's own illustrated dealer takes every shift; `dealers: []` leaves the tables without one.
+
+## Multiplayer
+
+Optional: with `multiplayer`, Blackjack and Texas Hold'em are played at shared tables, one per game, up to five players, each against the house.
+
+- **Seats:** players watch from the rail and pick a free seat, the same places for everyone; they can move or stand up between hands. A browser holds one seat per table, whatever its tabs; a signed-in user holds one across devices.
+- **Outcomes:** the server deals and draws them, with the same odds as single player, a dealer's bonus included; wins still reach `onWin` and `onClaim` in each player's browser.
+- **Fallback:** without the server the room plays single player; the developer menu switches between the two.
+- **Size:** the client code loads only when `multiplayer` is set.
+
+```ts
+createFeelingLucky({ prizes, multiplayer: '/feeling-lucky' });
+
+createFeelingLucky({
+  prizes,
+  multiplayer: { url: 'https://tables.example.com/feeling-lucky', headers: async () => ({ Authorization: `Bearer ${await token()}` }) },
+});
+```
+
+`headers` is asked for again on every request. On the same origin the browser's cookies go along, so the server sees the signed-in user.
+
+### Server
+
+In your ASP.NET Core app, from NuGet:
+
+```bash
+dotnet add package Adiakys.FeelingLucky
+```
+
+```cs
+builder.Services.AddFeelingLucky();
+app.MapFeelingLucky();                       // /feeling-lucky, chain .RequireAuthorization() or .RequireCors() as needed
+```
+
+Or standalone, from the container:
+
+```bash
+docker run -p 8080:8080 -e Cors__Origins__0=https://app.example.com ghcr.io/adiakys/feeling-lucky-server
+```
+
+| Option (`FeelingLucky__*` in the container) | Default |
+|---|---|
+| `Seats` | 5 |
+| `Pace`: the time between two cards | 480 ms |
+| `BettingTime`: from the first bet to the deal | 10 s |
+| `ActionTime`: to hit, stand, call or fold | 20 s |
+| `TimeZone`: the dealers' shifts, IANA id | the server's |
+
+Tables live in memory: one instance, no storage.
+
 ## Structure
 
 ```
@@ -178,6 +244,7 @@ src/
   locales/      en, it, es, fr, de
 playground/     demo with sample prizes
 tests/          unit (engine), e2e
+server/         multiplayer server: the NuGet package, the standalone host, tests
 ```
 
 ### Rules
@@ -191,7 +258,7 @@ tests/          unit (engine), e2e
 
 ```bash
 npm install
-npm run dev        # playground
+npm run dev        # playground; multiplayer through docker compose up -d
 npm test           # unit tests
 npm run test:e2e   # one smoke test per game
 npm run typecheck
@@ -201,11 +268,12 @@ npm run build:demo # site/: the playground, as on GitHub Pages
 
 ## Release
 
-Bump `version` in `package.json`, then push a `v<version>` tag. The release workflow:
+Publish a GitHub release or pre-release on a `v<version>` tag, e.g. `v1.2.0` or `v1.3.0-beta.1`: the version comes from the tag, `package.json` only holds a placeholder. The release workflow:
 - runs the checks;
-- publishes the package to npm;
-- attaches the packed `.tgz` to a GitHub release;
-- deploys the playground to GitHub Pages.
+- publishes the package to npm: `latest` for a release, `next` for a pre-release;
+- attaches the packed `.tgz` to the release;
+- publishes the server to NuGet through Trusted Publishing, and its image to `ghcr.io/adiakys/feeling-lucky-server`, `latest` for a release;
+- deploys the playground to GitHub Pages, for releases only.
 
 ## License
 

package/dist/config/types.d.ts

@@ -24,10 +24,19 @@ export interface Win<V extends Variant = Variant> {
     tier: PrizeTier;
     game: GameId;
 }
+export interface Dealer {
+    image: string;
+    name?: string;
+    hands?: string;
+}
 export interface Player {
     name: string;
     avatar?: string;
 }
+export interface Multiplayer {
+    url: string;
+    headers?: Resolvable<Record<string, string>>;
+}
 export type Messages = {
     [key: string]: string | Messages;
 };
@@ -37,11 +46,13 @@ export interface FeelingLuckyConfig<V extends Variant = Variant> {
     messages?: Resolvable<Record<string, Messages>>;
     player?: Resolvable<Player>;
     logo?: Resolvable<string>;
+    dealers?: Resolvable<Dealer[]>;
     onWin?: (win: Win<V>) => void;
     onClaim?: (win: Win<V>) => Promise<void>;
     developer?: Resolvable<boolean | {
         passwordHash?: string;
     }>;
+    multiplayer?: Resolvable<string | Multiplayer>;
 }
 export interface FeelingLucky<V extends Variant = Variant> {
     open(options?: {

package/dist/{de-Cp-ILcpM.js → de-CmzpGbNK.js}

@@ -34,7 +34,9 @@ var t = e({
 	boost: {
 		badge: "×{n}",
 		title: "Bonus des Tages",
-		odds: "Bonus des Tages: Gewinne {n}-mal so wahrscheinlich"
+		odds: "Bonus des Tages: Gewinne {n}-mal so wahrscheinlich",
+		dealer: "Croupier am Tisch",
+		dealerOdds: "Croupier am Tisch: Gewinne {n}-mal so wahrscheinlich"
 	},
 	themes: {
 		christmas: {
@@ -335,7 +337,14 @@ var t = e({
 	cards: {
 		you: "Du",
 		dealer: "Bank",
-		deal: "Geben"
+		deal: "Geben",
+		player: "Spieler",
+		stand: "Vom Tisch aufstehen",
+		sit: "Hier hinsetzen",
+		chooseSeat: "Wähle einen Platz",
+		dealingIn: "Neue Hand in {seconds}s",
+		playIn: "{seconds}s zum Spielen",
+		nextHand: "Du spielst ab der nächsten Hand"
 	},
 	blackjack: {
 		print: "Bank steht bei 17 · Pik-Blackjack: Jackpot",
@@ -447,6 +456,13 @@ var t = e({
 	calendar: "Nach Kalender",
 	noTheme: "Keins",
 	language: "Sprache",
-	autoLanguage: "Automatisch"
+	autoLanguage: "Automatisch",
+	tables: "Kartentische",
+	multiplayer: "Mehrspieler",
+	singlePlayer: "Einzelspieler",
+	dealer: "Croupier",
+	dealerShifts: "Nach den Schichten des Tages",
+	dealerAbsent: "Abwesend",
+	dealerNumber: "Croupier {n}"
 } });
 export { t as default };

package/dist/developer/panel.d.ts

@@ -36,6 +36,8 @@ export declare class Developer extends LuckyElement {
     private reset;
     private toggle;
     private setLanguage;
+    private setDealer;
+    private setTables;
     private setTheme;
     private shortcut;
     private keydown;

package/dist/developer/settings.d.ts

@@ -16,6 +16,8 @@ export declare const settings: Partial<Record<GameId, GameSettings>>;
 export declare const room: {
     theme?: Theme | 'none';
     locale?: string;
+    dealer?: number | 'none';
+    singlePlayer?: boolean;
     prizes: Prize[];
 };
 export declare const blankSettings: () => GameSettings;

package/dist/engine/dealer.d.ts

@@ -0,0 +1,21 @@
+declare module './rig' {
+    interface Decisions {
+        dealer: {
+            context: {
+                count: number;
+            };
+            value: number | null;
+        };
+    }
+}
+export declare const DEALER_BOOST = 2;
+export interface Shift {
+    start: number;
+    end: number;
+    dealer: number;
+}
+export declare function dealerShifts(date: Date, count: number): Shift[];
+export declare function shiftAt(date: Date, count: number): number | null;
+export declare const roster: import("../runtime/signal").Signal<number>;
+export declare const onDuty: import("../runtime/signal").Signal<number | null>;
+export declare function checkDuty(now?: Date): void;

package/dist/{es-DHZIstf4.js → es-k_kS6Fn2.js}

@@ -34,7 +34,9 @@ var t = e({
 	boost: {
 		badge: "×{n}",
 		title: "Bonus del día",
-		odds: "Bonus del día: premios {n} veces más probables"
+		odds: "Bonus del día: premios {n} veces más probables",
+		dealer: "Crupier en la mesa",
+		dealerOdds: "Crupier en la mesa: premios {n} veces más probables"
 	},
 	themes: {
 		christmas: {
@@ -335,7 +337,14 @@ var t = e({
 	cards: {
 		you: "Tú",
 		dealer: "Banca",
-		deal: "Repartir"
+		deal: "Repartir",
+		player: "Jugador",
+		stand: "Levantarse de la mesa",
+		sit: "Siéntate aquí",
+		chooseSeat: "Elige un asiento",
+		dealingIn: "Se reparte en {seconds}s",
+		playIn: "{seconds}s para jugar",
+		nextHand: "Juegas desde la próxima mano"
 	},
 	blackjack: {
 		print: "Banca se planta en 17 · Blackjack de picas: jackpot",
@@ -447,6 +456,13 @@ var t = e({
 	calendar: "Según el calendario",
 	noTheme: "Ninguno",
 	language: "Idioma",
-	autoLanguage: "Automático"
+	autoLanguage: "Automático",
+	tables: "Mesas de cartas",
+	multiplayer: "Multijugador",
+	singlePlayer: "Un jugador",
+	dealer: "Crupier",
+	dealerShifts: "Según los turnos del día",
+	dealerAbsent: "Ausente",
+	dealerNumber: "Crupier {n}"
 } });
 export { t as default };