star-sdk-cli 0.1.9 → 0.1.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/cli.mjs +24 -12
  2. package/package.json +1 -1
package/dist/cli.mjs CHANGED
@@ -35,6 +35,7 @@ import Star from 'star-sdk';
35
35
 
36
36
  \`\`\`javascript
37
37
  import Star from 'star-sdk';
38
+ Star.init({ gameId: 'YOUR_GAME_ID' }); // from .starrc
38
39
 
39
40
  Star.game(ctx => {
40
41
  const { canvas, width, height, ctx: c } = ctx;
@@ -108,6 +109,7 @@ Only these 17 presets exist:
108
109
 
109
110
  \`\`\`javascript
110
111
  import Star from 'star-sdk';
112
+ Star.init({ gameId: 'YOUR_GAME_ID' }); // from .starrc
111
113
 
112
114
  Star.game(ctx => {
113
115
  const { canvas, width, height, ctx: c } = ctx;
@@ -663,7 +665,7 @@ game(({ ctx, width, height, loop, toStagePoint, canvas }) => {
663
665
  import { game } from 'star-canvas';
664
666
  import { createLeaderboard } from 'star-leaderboard';
665
667
 
666
- const leaderboard = createLeaderboard();
668
+ const leaderboard = createLeaderboard({ gameId: 'YOUR_GAME_ID' });
667
669
 
668
670
  game(({ ctx, width, height, loop, ui, on, canvas, toStagePoint }) => {
669
671
  let score = 0;
@@ -1011,7 +1013,7 @@ yarn add star-leaderboard
1011
1013
  **Import:**
1012
1014
  \`\`\`javascript
1013
1015
  import { createLeaderboard } from 'star-leaderboard';
1014
- const leaderboard = createLeaderboard();
1016
+ const leaderboard = createLeaderboard({ gameId: 'YOUR_GAME_ID' });
1015
1017
  \`\`\`
1016
1018
 
1017
1019
  **CRITICAL:** Import in JavaScript - don't add \`<script>\` tags.
@@ -1024,7 +1026,7 @@ const leaderboard = createLeaderboard();
1024
1026
  import { createLeaderboard } from 'star-leaderboard';
1025
1027
  import { game } from 'star-canvas';
1026
1028
 
1027
- const leaderboard = createLeaderboard();
1029
+ const leaderboard = createLeaderboard({ gameId: 'YOUR_GAME_ID' });
1028
1030
 
1029
1031
  game(({ ctx, width, height, loop, ui, on, canvas }) => {
1030
1032
  let score = 0;
@@ -1080,7 +1082,7 @@ leaderboard.showLeaderboard() // Same as show()
1080
1082
  \`\`\`javascript
1081
1083
  import { createLeaderboard } from 'star-leaderboard';
1082
1084
 
1083
- const leaderboard = createLeaderboard();
1085
+ const leaderboard = createLeaderboard({ gameId: 'YOUR_GAME_ID' });
1084
1086
 
1085
1087
  function gameOver(finalScore) {
1086
1088
  // Fire and forget - simplest approach
@@ -1094,7 +1096,7 @@ function gameOver(finalScore) {
1094
1096
  \`\`\`javascript
1095
1097
  import { createLeaderboard } from 'star-leaderboard';
1096
1098
 
1097
- const leaderboard = createLeaderboard();
1099
+ const leaderboard = createLeaderboard({ gameId: 'YOUR_GAME_ID' });
1098
1100
 
1099
1101
  async function gameOver(finalScore) {
1100
1102
  const { success, rank } = await leaderboard.submit(finalScore);
@@ -1113,7 +1115,7 @@ async function gameOver(finalScore) {
1113
1115
  import { createLeaderboard } from 'star-leaderboard';
1114
1116
  import { game } from 'star-canvas';
1115
1117
 
1116
- const leaderboard = createLeaderboard();
1118
+ const leaderboard = createLeaderboard({ gameId: 'YOUR_GAME_ID' });
1117
1119
 
1118
1120
  game(({ ui, on }) => {
1119
1121
  ui.render(\`
@@ -1134,7 +1136,7 @@ game(({ ui, on }) => {
1134
1136
  \`\`\`javascript
1135
1137
  import { createLeaderboard } from 'star-leaderboard';
1136
1138
 
1137
- const leaderboard = createLeaderboard();
1139
+ const leaderboard = createLeaderboard({ gameId: 'YOUR_GAME_ID' });
1138
1140
 
1139
1141
  async function showCustomLeaderboard() {
1140
1142
  const { scores, you, config } = await leaderboard.getScores({
@@ -1159,7 +1161,7 @@ async function showCustomLeaderboard() {
1159
1161
  import { createLeaderboard } from 'star-leaderboard';
1160
1162
  import { game } from 'star-canvas';
1161
1163
 
1162
- const leaderboard = createLeaderboard();
1164
+ const leaderboard = createLeaderboard({ gameId: 'YOUR_GAME_ID' });
1163
1165
 
1164
1166
  game(({ ctx, width, height, loop, ui, on, canvas }) => {
1165
1167
  let score = 0;
@@ -1210,6 +1212,14 @@ game(({ ctx, width, height, loop, ui, on, canvas }) => {
1210
1212
 
1211
1213
  ---
1212
1214
 
1215
+ **Configuration:**
1216
+
1217
+ Always pass your gameId (from \`.starrc\`, created by \`npx star-sdk init\`):
1218
+ \`\`\`javascript
1219
+ import { createLeaderboard } from 'star-leaderboard';
1220
+ const leaderboard = createLeaderboard({ gameId: 'YOUR_GAME_ID' });
1221
+ \`\`\`
1222
+
1213
1223
  ---
1214
1224
 
1215
1225
  **getScores Options:**
@@ -1382,12 +1392,14 @@ async function initCommand(name, email) {
1382
1392
  log(`${colors.dim}Config saved to${colors.reset} ${colors.bright}.starrc${colors.reset}`);
1383
1393
  log("");
1384
1394
  log(`${colors.dim}Next steps:${colors.reset}`);
1385
- log(` 1. Import Star SDK in your game`);
1386
- log(` 2. Use Star.leaderboard.submit(score) to submit scores`);
1395
+ log(` 1. Install the leaderboard package: ${colors.cyan}yarn add star-leaderboard${colors.reset}`);
1396
+ log(` 2. Submit scores and show the leaderboard`);
1387
1397
  log("");
1388
1398
  log(`${colors.dim}Example:${colors.reset}`);
1389
- log(` ${colors.cyan}import Star from 'star-sdk';${colors.reset}`);
1390
- log(` ${colors.cyan}Star.leaderboard.submit(1500);${colors.reset}`);
1399
+ log(` ${colors.cyan}import { createLeaderboard } from 'star-leaderboard';${colors.reset}`);
1400
+ log(` ${colors.cyan}const leaderboard = createLeaderboard({ gameId: '${data.gameId}' });${colors.reset}`);
1401
+ log(` ${colors.cyan}leaderboard.submit(1500);${colors.reset}`);
1402
+ log(` ${colors.cyan}leaderboard.show();${colors.reset}`);
1391
1403
  log("");
1392
1404
  log(`${colors.dim}Using an AI coding agent?${colors.reset}`);
1393
1405
  log(` ${colors.cyan}npx star-sdk install${colors.reset} ${colors.dim}Claude Code, Codex, Cursor, Windsurf, Aider${colors.reset}`);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "star-sdk-cli",
3
- "version": "0.1.9",
3
+ "version": "0.1.10",
4
4
  "description": "CLI tool for Star SDK - register games and manage leaderboards",
5
5
  "type": "module",
6
6
  "bin": {