npm - shipthis - Versions diffs - 0.0.31 → 0.0.33 - Mend

shipthis 0.0.31 → 0.0.33

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 (13) hide show

package/README.md CHANGED Viewed

@@ -1,8 +1,8 @@
 <h1 align="center">
   <a href="https://shipthis.cc">
     <picture>
-      <source height="56" width="260" media="(prefers-color-scheme: dark)" srcset="https://shipthis.cc/logo_darkmode.svg">
-      <img height="56" width="260" alt="ShipThis" src="https://shipthis.cc/logo_normal.svg">
+    <source height="56" width="260" srcset="https://shipthis.cc/logo_darkmode.svg">
+      <img height="56" width="260" alt="ShipThis" src="https://shipthis.cc/logo_darkmode.svg" ></img>
     </picture>
   </a>
   <br>
@@ -78,27 +78,3 @@ Re-run the `shipthis game ship` command each time you want to build a new releas
 - [login](https://shipthis.cc/docs/reference/login) - Signin or create a new account
 - [status](https://shipthis.cc/docs/reference/status) - Display your overall ShipThis account status
 - [help](https://shipthis.cc/docs/reference/help) - Display help for a specific topic or command
-@octocat :+1: This PR looks great - it's ready to merge! :shipit:
-> [!NOTE]
-> Highlights information that users should take into account, even when skimming.
-> [!TIP]
-> Optional information to help a user be more successful.
-> [!IMPORTANT]
-> Crucial information necessary for users to succeed.
-> [!WARNING]
-> Critical content demanding immediate user attention due to potential risks.
-> [!CAUTION]
-> Negative potential consequences of an action.
-<details>
-  <summary>📚 Test</summary>
-# This is a test
-</details>

package/docs/README.md CHANGED Viewed

@@ -1,105 +1,19 @@
-<h1 align="center">
-  <a href="https://shipthis.cc">
-    <picture>
-      <source height="56" width="260" media="(prefers-color-scheme: dark)" srcset="https://shipthis.cc/logo_darkmode.svg">
-      <img height="56" width="260" alt="ShipThis" src="https://shipthis.cc/logo_normal.svg">
-    </picture>
-  </a>
-  <br>
-  <a href="https://discord.gg/rHhguPjZ">
-    <img src="https://img.shields.io/discord/1304144717239554069?style=flat-square&label=%F0%9F%92%AC%20discord&color=00ACD7">
-  </a>
-</h1>
-<p align="center">
-  <em><b>ShipThis</b> is a <b>command line tool</b> which manages releasing your <a href="https://godotengine.org/">Godot</a> games to the <b>iOS App Store</b>. Designed to compile and upload your Godot games in the cloud, meaning <b>you do not need to install or run Xcode to release an iOS game</b>.</em>
-</p>
+# ShipThis CLI Reference
----
+**ShipThis** is a **command-line tool** which manages releasing your [Godot](https://godotengine.org/) games to the **iOS App Store**.
-## ⚡️ Quickstart
+:::tip New to ShipThis?
+Begin with our [Quickstart Guide](/docs/quickstart).
+:::
-### You will need
-- A Godot 3.6 or 4.3 game
-- [Node.js](https://nodejs.org/en/download/) version 18.0 or above
-- An [Apple Developer](https://developer.apple.com) account
-### 1. Install ShipThis
-ShipThis can be installed as a package via the [NPM package manager](https://www.npmjs.com/). Run the following at the command line:
-```bash
-npm install -g shipthis
-```
-### 2. Create an account
-Set up an account with ShipThis by logging in for the first time using the [`shipthis login`](https://shipthis.cc/docs/reference/login) command.
-```bash
-shipthis login
-```
-### 3. Configure your game
-Set up your ShipThis configuration using the built in [wizard](https://shipthis.cc/docs/wizard). Run this command from within a Godot game directory (with a project.godot file):
-```bash
-shipthis game wizard
-```
-### 4. Ship
-Now you can publish your game to TestFlight with the [`shipthis game ship`](https://shipthis.cc/docs/reference/game/ship) command:
-```bash
-shipthis game ship
-```
-Once you are happy with the build you can submit it to Apple using [App Store
-Connect](https://appstoreconnect.apple.com/).
-Re-run the `shipthis game ship` command each time you want to build a new release of your game. **You never need to run Xcode**.
-### Next Steps
-- Checkout the [ShipThis Tutorial](https://shipthis.cc/docs/tutorial)
-## 📖 Command Reference
-### Topics
+## Topics
 - [apple](https://shipthis.cc/docs/reference/apple) - Commands that relate to linking your ShipThis account with your Apple Developer Account
 - [game](https://shipthis.cc/docs/reference/game) - Commands that relate to configuring the specific game in the current working directory.
-### Commands
+## Commands
 - [dashboard](https://shipthis.cc/docs/reference/dashboard) - Opens the web browser to your shipthis.cc dashboard
 - [login](https://shipthis.cc/docs/reference/login) - Signin or create a new account
 - [status](https://shipthis.cc/docs/reference/status) - Display your overall ShipThis account status
 - [help](https://shipthis.cc/docs/reference/help) - Display help for a specific topic or command
-@octocat :+1: This PR looks great - it's ready to merge! :shipit:
-> [!NOTE]
-> Highlights information that users should take into account, even when skimming.
-> [!TIP]
-> Optional information to help a user be more successful.
-> [!IMPORTANT]
-> Crucial information necessary for users to succeed.
-> [!WARNING]
-> Critical content demanding immediate user attention due to potential risks.
-> [!CAUTION]
-> Negative potential consequences of an action.
-<details>
-  <summary>📚 Test</summary>
-# This is a test
-</details>

package/docs/apple/apiKey.md CHANGED Viewed

@@ -9,6 +9,8 @@ Commands in the apple apiKey topic are prefixed `shipthis apple apiKey`. These c
 :::info
 An **App Store Connect API key** is used to authenticate and authorize automated interactions with Apple's App Store Connect API, enabling tasks like managing app metadata, TestFlight, and sales reports.
+**ShipThis uses one of these keys to automatically upload new builds of your games.**
 :::
 :::tip

package/docs/apple/certificate.md CHANGED Viewed

@@ -11,6 +11,8 @@ These commands relate to iOS Distribution Certificates within your Apple Develop
 :::info
 An **iOS Distribution Certificate** is used to authenticate and authorize the distribution of iOS apps, ensuring they are signed and trusted for installation on devices or submission to the App Store.
+**ShipThis uses this certificate on our cloud-build servers when compiling new builds of your game.**
 :::
 :::tip

package/docs/game/build.md CHANGED Viewed

@@ -13,7 +13,7 @@ your game code. It should not be confused with the command [`shipthis game ship`
 ## Example
-[![asciicast](https://asciinema.org/a/m2i3bOvZHUpQXFWtYXc7UnaKQ.svg)](https://asciinema.org/a/m2i3bOvZHUpQXFWtYXc7UnaKQ)
+[![asciicast](https://asciinema.org/a/m2i3bOvZHUpQXFWtYXc7UnaKQ.svg)](https://asciinema.org/a/m2i3bOvZHUpQXFWtYXc7UnaKQ#shipthis-col160row32)
 ## Commands

package/docs/game/create.md CHANGED Viewed

@@ -3,13 +3,13 @@
 ## Description
 :::tip
-We recommend configuring your game using the [`shipthis game wizard`](/docs/reference/game/wizard).
+We recommend creating your game using the [`shipthis game wizard`](/docs/reference/game/wizard).
 The `shipthis game create` command is the first step run by the wizard
 :::
 Creates a new game in your [ShipThis account](https://shipthis.cc/games).
-It will read the name of your game from your `project.godot` file. You will be
+ShipThis will read the name of your game from your `project.godot` file. You will be
 prompted to confirm this name, or you can specify one with the `--name` flag.
 If there is already a ShipThis game config file (`shipthis.json`) in the current

package/docs/game/details.md CHANGED Viewed

@@ -2,7 +2,7 @@
 ## Description
-Shows and sets the details of the current game.
+Shows and sets the details of the current game. These details are used by when your game is built on our cloud servers.
 If you run the command without any flags it will show the details of the current
 game.
@@ -12,10 +12,10 @@ value, it will output all the values again.
 The following fields can only be changed if you have the `--force` flag set:
-- `--gameEngine` - Change the Game Engine (currently only "godot" is supported)
-- `--gameEngineVersion` - Change the version of the Game Engine (currently only 3.6 and 4.3 are supported)
-- `--iosBundleId` - iOS Bundle ID
-- `--androidPackageName` Android Package Name (not currently used)
+- **gameEngine** - Change the Game Engine (currently only "godot" is supported)
+- **gameEngineVersion** - Change the version of the Game Engine (currently only 3.6 and 4.3 are supported)
+- **iosBundleId** - iOS Bundle ID
+- **androidPackageName** Android Package Name (not currently used)
 :::tip
 After changing these values, you will need to trigger a new build of your game with [`shipthis game ship`](/docs/reference/game/ship)

package/docs/game/export.md CHANGED Viewed

@@ -4,6 +4,10 @@
 Downloads the shipthis.json file for a given game into the current directory.
+## Example
+[![asciicast](https://asciinema.org/a/kAclG6bghhwuXWP4E5NUssAfA.svg)](https://asciinema.org/a/kAclG6bghhwuXWP4E5NUssAfA#shipthis-col100row32)
 ## Help Output
 ```

package/docs/game/ios/app.md CHANGED Viewed

@@ -1,19 +1,46 @@
 # Topic: `game ios app`
-Commands related to the App Store App for a specific game
+Commands in the `game ios app` topic are prefixed `shipthis game ios app`. They relate to the App Store App and BundleId for for a specific game (generally in the currently directory).
+:::info
+An **App Store App** is the public-facing application available in the App Store. It includes metadata like descriptions, screenshots, and submission details, representing the final product users download.
+A **Bundle ID** is a unique identifier for your app within Apple’s ecosystem. It connects your app to services, certificates, and provisioning profiles, ensuring it can be built, run, and managed correctly.
+**You can view the registered Bundle IDs (Identifiers) and their associated capabilities in the [Apple Developer Portal](https://developer.apple.com/account/resources/identifiers/list)**
+:::
+:::tip
+You will need to be authenticated against ShipThis and Apple before you can use
+these commands. To do that please run the following commands first:
+- [`shipthis login`](/docs/reference/login)
+- [`shipthis apple login`](/docs/reference/apple/login)
+:::
 ## Commands
-### game ios app create
+### `game ios app create`
 #### Description
-Creates an App and BundleId in the Apple Developer Portal.
+Creates an App and BundleId in the Apple Developer Portal. This command is run
+as part of the [`shipthis game wizard`](/docs/reference/game/wizard) command.
+When run, this command will register a new App Store App and BundleId using the App
+Store Connect API. It will ask you to confirm the name of the App and the BundleId
+string which is typically in the form of `com.mycompany.mygame`. Both of these need
+to be unique within the Apple ecosystem. ShipThis will suggest values for these.
+#### Example
+[![asciicast](https://asciinema.org/a/xc5B3aQjSDU3ErUjyi2oAYUvG.svg)](https://asciinema.org/a/xc5B3aQjSDU3ErUjyi2oAYUvG#shipthis-col120row32)
 #### Help Output
-```
+```bash
 USAGE
   $ shipthis game ios app create [-q] [-g <value>] [-n <value>] [-b <value>] [-f]
@@ -31,15 +58,25 @@ EXAMPLES
   $ shipthis game ios app create
 ```
-### game ios app status
+### `game ios app status`
 #### Description
-Shows the Game iOS App status.
+Shows the Game iOS App status. The output will tell you if you need to run the
+create command or sync command.
+- If the App does not exist in the Apple Developer Portal then you should run the
+ `shipthis game ios app create` command
+- If you have updated your **export_presets.cfg** file with new capabilities then
+ you should run the `shipthis game ios app sync` command.
+#### Example
+[![asciicast](https://asciinema.org/a/XbQ1iKf1W021xOF5hupAAadhA.svg)](https://asciinema.org/a/XbQ1iKf1W021xOF5hupAAadhA#shipthis-col120row32)
 #### Help Output
-```
+```bash
 USAGE
   $ shipthis game ios app status [-g <value>]
@@ -53,15 +90,38 @@ EXAMPLES
   $ shipthis game ios app status
 ```
-### game ios app sync
+### `game ios app sync`
 #### Description
 Synchronies the Apple App &#34;BundleId&#34; with the capabilities from the local project.
+This command will read your **export_presets.cfg** file and determine which capabilities
+to enable in the Apple Developer Portal.
+Currently, only the following permissions are supported:
+- **Access WiFi**
+- **Push Notifications**
+:::warning
+If your game uses other capabilities or if you are using plugins to enable certain
+features such as **GPS** or **file access**, please get in touch so that we can work with you.
+**ShipThis is still in beta and we need your help to improve it.**
+:::
+:::tip
+You do not need to have an **export_presets.cfg** file in your game directory.
+ShipThis will use default values for this file if it does not exist.
+:::
 #### Help Output
-```
+```bash
 USAGE
   $ shipthis game ios app sync [-q] [-g <value>] [-f]

package/docs/game/ios.md CHANGED Viewed

@@ -1,7 +1,8 @@
 # Topic: `game ios`
-Commands in the Game iOS topic are prefixed `shipthis game ios`. They relate to
-managing the iOS platform configuration for the game in the current directory.
+Commands in the `game ios` topic are prefixed `shipthis game ios`. They relate to
+managing the iOS platform configuration for a specific game (generally in the
+currently directory).
 :::tip Info
 You will need to be authenticated against ShipThis and Apple before you can use

package/docs/game/job.md CHANGED Viewed

@@ -1,12 +1,10 @@
 # Topic: `game job`
-Commands related to jobs for a specific game
+Commands in the `game job` topic are prefixed `shipthis game job`. They relate to jobs for a specific game (generally in the currently directory).
 ## Commands
-### game job list
+### `game job list`
 #### Description
@@ -36,7 +34,7 @@ EXAMPLES
   $ shipthis game job list --gameId 0c179fc4
 ```
-### game job status
+### `game job status`
 #### Description

package/oclif.manifest.json CHANGED Viewed

@@ -663,139 +663,6 @@
         "status.js"
       ]
     },
-    "game:build:download": {
-      "aliases": [],
-      "args": {
-        "build_id": {
-          "description": "The ID of the build to download",
-          "name": "build_id",
-          "required": true
-        },
-        "file": {
-          "description": "Name of the file to output",
-          "name": "file",
-          "required": true
-        }
-      },
-      "description": "Downloads the given build artifact to the specified file",
-      "examples": [
-        "<%= config.bin %> <%= command.id %> 7a3f5c92 output.ipa",
-        "<%= config.bin %> <%= command.id %> --gameId 0c179fc4 e4b9a3d7 output.apk"
-      ],
-      "flags": {
-        "gameId": {
-          "char": "g",
-          "description": "The ID of the game",
-          "name": "gameId",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "force": {
-          "char": "f",
-          "description": "Overwrite the file if it already exists",
-          "name": "force",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "game:build:download",
-      "pluginAlias": "shipthis",
-      "pluginName": "shipthis",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "game",
-        "build",
-        "download.js"
-      ]
-    },
-    "game:build:list": {
-      "aliases": [],
-      "args": {},
-      "description": "Lists the builds for successful jobs of a game.",
-      "examples": [
-        "<%= config.bin %> <%= command.id %>",
-        "<%= config.bin %> <%= command.id %> --gameId 0c179fc4",
-        "<%= config.bin %> <%= command.id %> --gameId 0c179fc4 --pageSize 20 --pageNumber 1"
-      ],
-      "flags": {
-        "gameId": {
-          "char": "g",
-          "description": "The ID of the game",
-          "name": "gameId",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "pageNumber": {
-          "char": "p",
-          "description": "The page number to show (starts at 0)",
-          "name": "pageNumber",
-          "default": 0,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "pageSize": {
-          "char": "s",
-          "description": "The number of items to show per page",
-          "name": "pageSize",
-          "default": 10,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "orderBy": {
-          "char": "o",
-          "description": "The field to order by",
-          "name": "orderBy",
-          "default": "createdAt",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "options": [
-            "createdAt",
-            "updatedAt"
-          ],
-          "type": "option"
-        },
-        "order": {
-          "char": "r",
-          "description": "The order to sort by",
-          "name": "order",
-          "default": "desc",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "options": [
-            "asc",
-            "desc"
-          ],
-          "type": "option"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "game:build:list",
-      "pluginAlias": "shipthis",
-      "pluginName": "shipthis",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "game",
-        "build",
-        "list.js"
-      ]
-    },
     "apple:apiKey:create": {
       "aliases": [],
       "args": {},
@@ -945,6 +812,139 @@
         "status.js"
       ]
     },
+    "game:build:download": {
+      "aliases": [],
+      "args": {
+        "build_id": {
+          "description": "The ID of the build to download",
+          "name": "build_id",
+          "required": true
+        },
+        "file": {
+          "description": "Name of the file to output",
+          "name": "file",
+          "required": true
+        }
+      },
+      "description": "Downloads the given build artifact to the specified file",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> 7a3f5c92 output.ipa",
+        "<%= config.bin %> <%= command.id %> --gameId 0c179fc4 e4b9a3d7 output.apk"
+      ],
+      "flags": {
+        "gameId": {
+          "char": "g",
+          "description": "The ID of the game",
+          "name": "gameId",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "force": {
+          "char": "f",
+          "description": "Overwrite the file if it already exists",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "game:build:download",
+      "pluginAlias": "shipthis",
+      "pluginName": "shipthis",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "game",
+        "build",
+        "download.js"
+      ]
+    },
+    "game:build:list": {
+      "aliases": [],
+      "args": {},
+      "description": "Lists the builds for successful jobs of a game.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --gameId 0c179fc4",
+        "<%= config.bin %> <%= command.id %> --gameId 0c179fc4 --pageSize 20 --pageNumber 1"
+      ],
+      "flags": {
+        "gameId": {
+          "char": "g",
+          "description": "The ID of the game",
+          "name": "gameId",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "pageNumber": {
+          "char": "p",
+          "description": "The page number to show (starts at 0)",
+          "name": "pageNumber",
+          "default": 0,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "pageSize": {
+          "char": "s",
+          "description": "The number of items to show per page",
+          "name": "pageSize",
+          "default": 10,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "orderBy": {
+          "char": "o",
+          "description": "The field to order by",
+          "name": "orderBy",
+          "default": "createdAt",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "createdAt",
+            "updatedAt"
+          ],
+          "type": "option"
+        },
+        "order": {
+          "char": "r",
+          "description": "The order to sort by",
+          "name": "order",
+          "default": "desc",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "asc",
+            "desc"
+          ],
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "game:build:list",
+      "pluginAlias": "shipthis",
+      "pluginName": "shipthis",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "game",
+        "build",
+        "list.js"
+      ]
+    },
     "game:ios:status": {
       "aliases": [],
       "args": {},
@@ -1508,5 +1508,5 @@
       ]
     }
   },
-  "version": "0.0.31"
+  "version": "0.0.33"
 }

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "shipthis",
-  "description": "Game Shipping Tool",
-  "version": "0.0.31",
+  "description": "A command line tool which manages releasing your Godot games to the iOS App Store.",
+  "version": "0.0.33",
   "author": "Hello Invent Ltd",
   "bin": {
     "shipthis": "./bin/run.js"
@@ -146,10 +146,10 @@
         "description": "Commands related to App Store Connect API Keys"
       },
       "apple:certificate": {
-        "description": "Commands related to App Store Certificates"
+        "description": "Commands related to iOS Distribution Certificates"
       },
       "game": {
-        "description": "Commands related to Game Management"
+        "description": "Commands related to configuring a specific game"
       },
       "game:build": {
         "description": "Commands related to builds for a specific game"
@@ -158,10 +158,10 @@
         "description": "Commands related to the iOS platform for a specific game"
       },
       "game:ios:app": {
-        "description": "Commands related to the App Store App for a specific game"
+        "description": "Commands related to the App Store App and BundleId for a specific game"
       },
       "game:ios:profile": {
-        "description": "Commands related to the App Store Provisioning Profiles for this Game"
+        "description": "Commands related to the App Store Mobile Provisioning Profiles for a specific game"
       },
       "game:job": {
         "description": "Commands related to jobs for a specific game"