star-sdk-cli 0.1.10 → 0.1.11

package/dist/cli.mjs

@@ -23,6 +23,23 @@ import Star from 'star-sdk';
 
 **CRITICAL:** Always use \`import Star from 'star-sdk'\` - not destructured imports.
 
+## Setup (Required for Leaderboards)
+
+Before writing any leaderboard code, register your game by running this command in the terminal:
+
+\`\`\`bash
+npx star-sdk init "Your Game Name"
+\`\`\`
+
+This creates a \`.starrc\` file containing your gameId. Open \`.starrc\`, copy the \`gameId\` value, and pass it to \`Star.init()\`:
+
+\`\`\`javascript
+import Star from 'star-sdk';
+Star.init({ gameId: '<paste gameId from .starrc>' });
+\`\`\`
+
+**The gameId is a unique token issued by the Star API. Do not make one up \u2014 it will not work. You must run \`npx star-sdk init\` first and use the gameId it gives you.**
+
 ## API Overview
 
 | API | Use When | Docs |
@@ -35,7 +52,7 @@ import Star from 'star-sdk';
 
 \`\`\`javascript
 import Star from 'star-sdk';
-Star.init({ gameId: 'YOUR_GAME_ID' }); // from .starrc
+Star.init({ gameId: '<gameId from .starrc>' }); // run: npx star-sdk init
 
 Star.game(ctx => {
   const { canvas, width, height, ctx: c } = ctx;
@@ -109,7 +126,7 @@ Only these 17 presets exist:
 
 \`\`\`javascript
 import Star from 'star-sdk';
-Star.init({ gameId: 'YOUR_GAME_ID' }); // from .starrc
+Star.init({ gameId: '<gameId from .starrc>' }); // run: npx star-sdk init
 
 Star.game(ctx => {
   const { canvas, width, height, ctx: c } = ctx;
@@ -665,7 +682,7 @@ game(({ ctx, width, height, loop, toStagePoint, canvas }) => {
 import { game } from 'star-canvas';
 import { createLeaderboard } from 'star-leaderboard';
 
-const leaderboard = createLeaderboard({ gameId: 'YOUR_GAME_ID' });
+const leaderboard = createLeaderboard({ gameId: '<gameId from .starrc>' });
 
 game(({ ctx, width, height, loop, ui, on, canvas, toStagePoint }) => {
   let score = 0;
@@ -1006,6 +1023,16 @@ var LEADERBOARD_DOCS = `**Installation**
 yarn add star-leaderboard
 \`\`\`
 
+**Setup (do this first):**
+
+Register your game by running this in the terminal:
+
+\`\`\`bash
+npx star-sdk init "Game Name"
+\`\`\`
+
+This creates a \`.starrc\` file. Open it, copy the \`gameId\` value, and use it below. The gameId is a server-issued token \u2014 do not invent one. It must come from \`npx star-sdk init\`.
+
 ### Star Leaderboard SDK
 
 **Simple leaderboards for Star games.** Submit scores, show rankings, share results. Never crashes your game.
@@ -1013,7 +1040,7 @@ yarn add star-leaderboard
 **Import:**
 \`\`\`javascript
 import { createLeaderboard } from 'star-leaderboard';
-const leaderboard = createLeaderboard({ gameId: 'YOUR_GAME_ID' });
+const leaderboard = createLeaderboard({ gameId: '<gameId from .starrc>' });
 \`\`\`
 
 **CRITICAL:** Import in JavaScript - don't add \`<script>\` tags.
@@ -1026,7 +1053,7 @@ const leaderboard = createLeaderboard({ gameId: 'YOUR_GAME_ID' });
 import { createLeaderboard } from 'star-leaderboard';
 import { game } from 'star-canvas';
 
-const leaderboard = createLeaderboard({ gameId: 'YOUR_GAME_ID' });
+const leaderboard = createLeaderboard({ gameId: '<gameId from .starrc>' });
 
 game(({ ctx, width, height, loop, ui, on, canvas }) => {
   let score = 0;
@@ -1082,7 +1109,7 @@ leaderboard.showLeaderboard()   // Same as show()
 \`\`\`javascript
 import { createLeaderboard } from 'star-leaderboard';
 
-const leaderboard = createLeaderboard({ gameId: 'YOUR_GAME_ID' });
+const leaderboard = createLeaderboard({ gameId: '<gameId from .starrc>' });
 
 function gameOver(finalScore) {
   // Fire and forget - simplest approach
@@ -1096,7 +1123,7 @@ function gameOver(finalScore) {
 \`\`\`javascript
 import { createLeaderboard } from 'star-leaderboard';
 
-const leaderboard = createLeaderboard({ gameId: 'YOUR_GAME_ID' });
+const leaderboard = createLeaderboard({ gameId: '<gameId from .starrc>' });
 
 async function gameOver(finalScore) {
   const { success, rank } = await leaderboard.submit(finalScore);
@@ -1115,7 +1142,7 @@ async function gameOver(finalScore) {
 import { createLeaderboard } from 'star-leaderboard';
 import { game } from 'star-canvas';
 
-const leaderboard = createLeaderboard({ gameId: 'YOUR_GAME_ID' });
+const leaderboard = createLeaderboard({ gameId: '<gameId from .starrc>' });
 
 game(({ ui, on }) => {
   ui.render(\`
@@ -1136,7 +1163,7 @@ game(({ ui, on }) => {
 \`\`\`javascript
 import { createLeaderboard } from 'star-leaderboard';
 
-const leaderboard = createLeaderboard({ gameId: 'YOUR_GAME_ID' });
+const leaderboard = createLeaderboard({ gameId: '<gameId from .starrc>' });
 
 async function showCustomLeaderboard() {
   const { scores, you, config } = await leaderboard.getScores({
@@ -1161,7 +1188,7 @@ async function showCustomLeaderboard() {
 import { createLeaderboard } from 'star-leaderboard';
 import { game } from 'star-canvas';
 
-const leaderboard = createLeaderboard({ gameId: 'YOUR_GAME_ID' });
+const leaderboard = createLeaderboard({ gameId: '<gameId from .starrc>' });
 
 game(({ ctx, width, height, loop, ui, on, canvas }) => {
   let score = 0;
@@ -1214,11 +1241,7 @@ game(({ ctx, width, height, loop, ui, on, canvas }) => {
 
 **Configuration:**
 
-Always pass your gameId (from \`.starrc\`, created by \`npx star-sdk init\`):
-\`\`\`javascript
-import { createLeaderboard } from 'star-leaderboard';
-const leaderboard = createLeaderboard({ gameId: 'YOUR_GAME_ID' });
-\`\`\`
+Your gameId comes from \`.starrc\` (created by \`npx star-sdk init\`). See Setup at the top.
 
 ---
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "star-sdk-cli",
-  "version": "0.1.10",
+  "version": "0.1.11",
   "description": "CLI tool for Star SDK - register games and manage leaderboards",
   "type": "module",
   "bin": {