com.superfive.js 1.0.2 → 1.0.3

package/Readme.md

@@ -4,10 +4,17 @@ This is the JS API for the SuperFive.io gaming platform where players can compet
 
 ## API usage
 
+In general adpating your game isn't gonna be much work. You only have to listen to a few events, consider some states and send a ``game_ready``.
+
+### Quick example
+
 ```js
 import {
   isInPlatformMode,
-  subscribeToPlatformMessages
+  subscribeToPlatformMessages,
+  sendReady,
+  sendWin,
+  sendLose,
 } from 'com.superfive.js'
 
 // Check if the platform is loading this game
@@ -20,10 +27,29 @@ if (isInPlatformMode()) {
     const { type } = customEvent.detail;
 
     if (type === 'game_restart') {
-      this.yourRestartGame();
+      yourStartGame();
     }
   });
 
+  create() {
+    // As soon as the game is loaded and ready to play send the 'ready event'
+    sendReady();
+  }
+
+  yourStartGame() {
+    // The user on the plafrom clicked "Start Game" ...
+    // Your game should run now / play sound effects etc
+  }
+
+  onWin() {
+    // If the player wins, pause the game, mute all sounds and let the platform know:
+    sendWin();
+  }
+
+  onLose() {
+    // If the player loses, pause the game, mute all sounds and let the platform know:
+    sendLose();
+  }
 }
 ```
 
@@ -196,8 +222,21 @@ type PlatformMessageType =
 
 # Game development
 
+If your game is already hosted somewhere, send us the link (dev@superfive.io).
+As we strive for quality we can not accept any game.
+
+## Best practices
+
 - The game should work in portrait (9:16)
 - The game should work on desktop (mouse input) and mobile (touch input)
 - The game should not start unless it receives the ``game_restart`` message from the platform
 - The game should not play any music - only sound effects (the platform plays music)
+- Make sure your game loads fast. We are trying to cater to people globally and everyone should be able to play.
 - The game can have different difficulty levels (0 = 'Easy', 1 = 'Medium', 2 = 'Hard').
+
+## Release
+
+As for now we do not have any games store or games simulator to test the game integration.
+Send us a static build of your game and we host it on our cloud.
+
+Contact dev@superfive.io

package/dist/main.d.ts

@@ -1,4 +1,11 @@
 import type { PlatformMessage } from './types.ts';
+/**
+ * Get a parameter from the platform
+ *
+ * @param key The key of the parameter
+ * @returns The value of the parameter or null if the parameter is not found
+ */
+export declare function getPlatformParam(key: string): string | null;
 /**
  * Check if the game is running in the SuperFive platform
  *

package/dist/main.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAOlD;;;;GAIG;AACH,wBAAgB,gBAAgB,IAAI,OAAO,CAE1C;AAED;;;;GAIG;AACH,wBAAgB,UAAU,IAAI,OAAO,CAEpC;AAED;;;;;;;;;GASG;AACH,wBAAgB,aAAa,IAAI,MAAM,CAEtC;AAMD;;;;GAIG;AACH,wBAAgB,2BAA2B,IAAI,IAAI,CAGlD;AAED;;;;GAIG;AACH,wBAAgB,+BAA+B,IAAI,IAAI,CAEtD;AA0BD;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,eAAe,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,EAAE,GAAG,GAAG,IAAI,CAItF;AAED;;;;GAIG;AACH,wBAAgB,SAAS,IAAI,IAAI,CAEhC;AAED;;;;GAIG;AACH,wBAAgB,OAAO,IAAI,IAAI,CAE9B;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,IAAI,IAAI,CAE/B"}
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAuBlD;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAE3D;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,IAAI,OAAO,CAE1C;AAED;;;;GAIG;AACH,wBAAgB,UAAU,IAAI,OAAO,CAEpC;AAED;;;;;;;;;GASG;AACH,wBAAgB,aAAa,IAAI,MAAM,CAEtC;AAMD;;;;GAIG;AACH,wBAAgB,2BAA2B,IAAI,IAAI,CAGlD;AAED;;;;GAIG;AACH,wBAAgB,+BAA+B,IAAI,IAAI,CAEtD;AA0BD;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,eAAe,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,EAAE,GAAG,GAAG,IAAI,CAItF;AAED;;;;GAIG;AACH,wBAAgB,SAAS,IAAI,IAAI,CAEhC;AAED;;;;GAIG;AACH,wBAAgB,OAAO,IAAI,IAAI,CAE9B;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,IAAI,IAAI,CAE/B"}

package/dist/main.js

@@ -1,14 +1,21 @@
+function getHashParams(key) {
+	const hash = window.location.hash.replace(/^#!?/, "");
+	return new URLSearchParams(hash).get(key);
+}
 function getUrlParam(name) {
 	return new URLSearchParams(window.location.search).get(name);
 }
+function getPlatformParam(key) {
+	return getHashParams(key) || getUrlParam(key);
+}
 function isInPlatformMode() {
-	return getUrlParam("p") === "1";
+	return getPlatformParam("p") === "1";
 }
 function startMuted() {
-	return getUrlParam("muted") === "1";
+	return getPlatformParam("muted") === "1";
 }
 function getDifficulty() {
-	return parseInt(getUrlParam("difficulty") || "0", 10);
+	return parseInt(getPlatformParam("difficulty") || "0", 10);
 }
 function subscribeToPlatformMessages() {
 	if (!isInPlatformMode()) return;
@@ -44,6 +51,6 @@ function sendWin() {
 function sendLose() {
 	sendPlatformMessage("game_lost");
 }
-export { getDifficulty, isInPlatformMode, sendLose, sendPlatformMessage, sendReady, sendWin, startMuted, subscribeToPlatformMessages, unsubscribeFromPlatformMessages };
+export { getDifficulty, getPlatformParam, isInPlatformMode, sendLose, sendPlatformMessage, sendReady, sendWin, startMuted, subscribeToPlatformMessages, unsubscribeFromPlatformMessages };
 
 //# sourceMappingURL=main.js.map

package/dist/main.js.map

@@ -1 +1 @@
-{"version":3,"file":"main.js","names":["message: PlatformMessage"],"sources":["../src/main.ts"],"sourcesContent":["import type { PlatformMessage } from './types.ts';\n\nfunction getUrlParam(name: string): string | null {\n  const urlParams = new URLSearchParams(window.location.search);\n  return urlParams.get(name);\n}\n\n/**\n * Check if the game is running in the SuperFive platform\n *\n * @returns True if the game is in platform mode, false otherwise\n */\nexport function isInPlatformMode(): boolean {\n  return getUrlParam('p') === '1';\n}\n\n/**\n * Check if the game should start muted\n *\n * @returns True if the game should start muted, false otherwise\n */\nexport function startMuted(): boolean {\n  return getUrlParam('muted') === '1';\n}\n\n/**\n * Get the difficulty of the game\n *\n * The difficulty is a number between 0 and 2\n * - 0: Easy\n * - 1: Medium\n * - 2: Hard\n *\n * @returns The difficulty of the game as a number between 0 and 2\n */\nexport function getDifficulty(): number {\n  return parseInt(getUrlParam('difficulty') || '0', 10);\n}\n\n// ==============================================================\n// Message Handling\n// ==============================================================\n\n/**\n * Subscribe to the platform's messages to handle platform events\n *\n * @returns void\n */\nexport function subscribeToPlatformMessages(): void {\n  if (!isInPlatformMode()) return;\n  window.addEventListener('message', handlePlatformMessage);\n}\n\n/**\n * Unsubscribe from the platform's messages\n *\n * @returns void\n */\nexport function unsubscribeFromPlatformMessages(): void {\n  window.removeEventListener('message', handlePlatformMessage);\n}\n\n/**\n * Handle the platform's messages\n *\n * @param event The message event\n * @returns void\n */\nfunction handlePlatformMessage(event: MessageEvent): void {\n  const data = event.data;\n  if (!data || !data.type) return;\n\n  // Validate message shape\n  if (typeof data.type !== 'string') return;\n\n  // Emit custom event for game to handle\n  const customEvent = new CustomEvent('platformMessage', { \n    detail: { type: data.type, payload: data.payload } \n  });\n  window.dispatchEvent(customEvent);\n}\n\n// ==============================================================\n// Sending Messages Methods\n// ==============================================================\n\n/**\n * Send a message to the platform\n *\n * @param type The type of the message\n * @param payload The payload of the message\n * @returns void\n */\nexport function sendPlatformMessage(type: PlatformMessage['type'], payload?: any): void {\n  if (!isInPlatformMode()) return;\n  const message: PlatformMessage = { type, payload };\n  window.parent.postMessage(message, '*');\n}\n\n/**\n * Send a message to the platform to indicate that the game is ready (loaded and ready to play)\n *\n * @returns void\n */\nexport function sendReady(): void {\n  sendPlatformMessage('game_ready');\n}\n\n/**\n * Send a message to the platform to indicate that the game is won\n *\n * @returns void\n */\nexport function sendWin(): void {\n  sendPlatformMessage('game_won');\n}\n\n/**\n * Send a message to the platform to indicate that the game is lost\n *\n * @returns void\n */\nexport function sendLose(): void {\n  sendPlatformMessage('game_lost');\n}\n"],"mappings":"AAEA,SAAS,YAAY,MAA6B;AAEhD,QADkB,IAAI,gBAAgB,OAAO,SAAS,OAAO,CAC5C,IAAI,KAAK;;AAQ5B,SAAgB,mBAA4B;AAC1C,QAAO,YAAY,IAAI,KAAK;;AAQ9B,SAAgB,aAAsB;AACpC,QAAO,YAAY,QAAQ,KAAK;;AAalC,SAAgB,gBAAwB;AACtC,QAAO,SAAS,YAAY,aAAa,IAAI,KAAK,GAAG;;AAYvD,SAAgB,8BAAoC;AAClD,KAAI,CAAC,kBAAkB,CAAE;AACzB,QAAO,iBAAiB,WAAW,sBAAsB;;AAQ3D,SAAgB,kCAAwC;AACtD,QAAO,oBAAoB,WAAW,sBAAsB;;AAS9D,SAAS,sBAAsB,OAA2B;CACxD,MAAM,OAAO,MAAM;AACnB,KAAI,CAAC,QAAQ,CAAC,KAAK,KAAM;AAGzB,KAAI,OAAO,KAAK,SAAS,SAAU;CAGnC,MAAM,cAAc,IAAI,YAAY,mBAAmB,EACrD,QAAQ;EAAE,MAAM,KAAK;EAAM,SAAS,KAAK;EAAS,EACnD,CAAC;AACF,QAAO,cAAc,YAAY;;AAcnC,SAAgB,oBAAoB,MAA+B,SAAqB;AACtF,KAAI,CAAC,kBAAkB,CAAE;CACzB,MAAMA,UAA2B;EAAE;EAAM;EAAS;AAClD,QAAO,OAAO,YAAY,SAAS,IAAI;;AAQzC,SAAgB,YAAkB;AAChC,qBAAoB,aAAa;;AAQnC,SAAgB,UAAgB;AAC9B,qBAAoB,WAAW;;AAQjC,SAAgB,WAAiB;AAC/B,qBAAoB,YAAY"}
+{"version":3,"file":"main.js","names":["message: PlatformMessage"],"sources":["../src/main.ts"],"sourcesContent":["import type { PlatformMessage } from './types.ts';\n\n/**\n * Get a parameter from the hash (!#p=1&difficulty=2&muted=1)\n *\n * @param key The key of the parameter\n * @returns The value of the parameter or null if the parameter is not found\n */\nfunction getHashParams(key: string): string | null {\n  const hash = window.location.hash.replace(/^#!?/, '')\n  return new URLSearchParams(hash).get(key);\n}\n\n/**\n * Get a parameter from the url (?p=1&difficulty=2&muted=1)\n *\n * @param key The key of the parameter\n * @returns The value of the parameter or null if the parameter is not found\n */\nfunction getUrlParam(name: string): string | null {\n  return new URLSearchParams(window.location.search).get(name);\n}\n\n/**\n * Get a parameter from the platform\n *\n * @param key The key of the parameter\n * @returns The value of the parameter or null if the parameter is not found\n */\nexport function getPlatformParam(key: string): string | null {\n  return getHashParams(key) || getUrlParam(key);\n}\n\n/**\n * Check if the game is running in the SuperFive platform\n *\n * @returns True if the game is in platform mode, false otherwise\n */\nexport function isInPlatformMode(): boolean {\n  return getPlatformParam('p') === '1';\n}\n\n/**\n * Check if the game should start muted\n *\n * @returns True if the game should start muted, false otherwise\n */\nexport function startMuted(): boolean {\n  return getPlatformParam('muted') === '1';\n}\n\n/**\n * Get the difficulty of the game\n *\n * The difficulty is a number between 0 and 2\n * - 0: Easy\n * - 1: Medium\n * - 2: Hard\n *\n * @returns The difficulty of the game as a number between 0 and 2\n */\nexport function getDifficulty(): number {\n  return parseInt(getPlatformParam('difficulty') || '0', 10);\n}\n\n// ==============================================================\n// Message Handling\n// ==============================================================\n\n/**\n * Subscribe to the platform's messages to handle platform events\n *\n * @returns void\n */\nexport function subscribeToPlatformMessages(): void {\n  if (!isInPlatformMode()) return;\n  window.addEventListener('message', handlePlatformMessage);\n}\n\n/**\n * Unsubscribe from the platform's messages\n *\n * @returns void\n */\nexport function unsubscribeFromPlatformMessages(): void {\n  window.removeEventListener('message', handlePlatformMessage);\n}\n\n/**\n * Handle the platform's messages\n *\n * @param event The message event\n * @returns void\n */\nfunction handlePlatformMessage(event: MessageEvent): void {\n  const data = event.data;\n  if (!data || !data.type) return;\n\n  // Validate message shape\n  if (typeof data.type !== 'string') return;\n\n  // Emit custom event for game to handle\n  const customEvent = new CustomEvent('platformMessage', { \n    detail: { type: data.type, payload: data.payload } \n  });\n  window.dispatchEvent(customEvent);\n}\n\n// ==============================================================\n// Sending Messages Methods\n// ==============================================================\n\n/**\n * Send a message to the platform\n *\n * @param type The type of the message\n * @param payload The payload of the message\n * @returns void\n */\nexport function sendPlatformMessage(type: PlatformMessage['type'], payload?: any): void {\n  if (!isInPlatformMode()) return;\n  const message: PlatformMessage = { type, payload };\n  window.parent.postMessage(message, '*');\n}\n\n/**\n * Send a message to the platform to indicate that the game is ready (loaded and ready to play)\n *\n * @returns void\n */\nexport function sendReady(): void {\n  sendPlatformMessage('game_ready');\n}\n\n/**\n * Send a message to the platform to indicate that the game is won\n *\n * @returns void\n */\nexport function sendWin(): void {\n  sendPlatformMessage('game_won');\n}\n\n/**\n * Send a message to the platform to indicate that the game is lost\n *\n * @returns void\n */\nexport function sendLose(): void {\n  sendPlatformMessage('game_lost');\n}\n"],"mappings":"AAQA,SAAS,cAAc,KAA4B;CACjD,MAAM,OAAO,OAAO,SAAS,KAAK,QAAQ,QAAQ,GAAG;AACrD,QAAO,IAAI,gBAAgB,KAAK,CAAC,IAAI,IAAI;;AAS3C,SAAS,YAAY,MAA6B;AAChD,QAAO,IAAI,gBAAgB,OAAO,SAAS,OAAO,CAAC,IAAI,KAAK;;AAS9D,SAAgB,iBAAiB,KAA4B;AAC3D,QAAO,cAAc,IAAI,IAAI,YAAY,IAAI;;AAQ/C,SAAgB,mBAA4B;AAC1C,QAAO,iBAAiB,IAAI,KAAK;;AAQnC,SAAgB,aAAsB;AACpC,QAAO,iBAAiB,QAAQ,KAAK;;AAavC,SAAgB,gBAAwB;AACtC,QAAO,SAAS,iBAAiB,aAAa,IAAI,KAAK,GAAG;;AAY5D,SAAgB,8BAAoC;AAClD,KAAI,CAAC,kBAAkB,CAAE;AACzB,QAAO,iBAAiB,WAAW,sBAAsB;;AAQ3D,SAAgB,kCAAwC;AACtD,QAAO,oBAAoB,WAAW,sBAAsB;;AAS9D,SAAS,sBAAsB,OAA2B;CACxD,MAAM,OAAO,MAAM;AACnB,KAAI,CAAC,QAAQ,CAAC,KAAK,KAAM;AAGzB,KAAI,OAAO,KAAK,SAAS,SAAU;CAGnC,MAAM,cAAc,IAAI,YAAY,mBAAmB,EACrD,QAAQ;EAAE,MAAM,KAAK;EAAM,SAAS,KAAK;EAAS,EACnD,CAAC;AACF,QAAO,cAAc,YAAY;;AAcnC,SAAgB,oBAAoB,MAA+B,SAAqB;AACtF,KAAI,CAAC,kBAAkB,CAAE;CACzB,MAAMA,UAA2B;EAAE;EAAM;EAAS;AAClD,QAAO,OAAO,YAAY,SAAS,IAAI;;AAQzC,SAAgB,YAAkB;AAChC,qBAAoB,aAAa;;AAQnC,SAAgB,UAAgB;AAC9B,qBAAoB,WAAW;;AAQjC,SAAgB,WAAiB;AAC/B,qBAAoB,YAAY"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "com.superfive.js",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "type": "module",
   "main": "./dist/main.js",
   "module": "./dist/main.js",