How to Use Shiply Remote Resources

1. Flow Diagram

2. Create a Resource Key

• Resource key: Unique ID for each resource under the app

Purpose of resource keys

Resource keys are called resId in the SDK. The SDK fetches remote resources by resId.

// iOS SDK
- (ResHubModel *)latestResWithId:(NSString *)resId

• Resource name: For console display only; not delivered to clients.

• Owner: Non-owners cannot modify resource info or create/edit release tasks.

• Reviewer: Final approver for each online release action

• Category: File type of the resource (zip, 7z, apk, so).

How to choose a category

We recommend compressing resources as zip for delivery. The SDK auto-extracts them (disable auto-extraction in advanced options if you need to keep the zip file).

• Associated scene: When linked to a scene, the SDK can fetch by resId or fetch all resources under a scene by sceneId.

• Tags: For console filtering only

3. Create a Resource Release Task

3.1 Create your first resource release task

3.2 Link or upload artifacts

• Artifact name: Name of the artifact; not delivered to the SDK.

• Artifact description: Description of the artifact; not delivered to the SDK.

• Resource file: Supports zip, 7z, apk, so, and other formats. zip is recommended—any file can be compressed to zip for delivery.

• Extra info: Config delivered with the file. JSON format is recommended, e.g.: {"key1": "value1", "key2": "value2"}.

• File matching: Regex specifying which extracted zip sub-files require MD5/CRC32 verification. Do not set unless you have a specific need.

• Auto packaging: Ignore this option.

Use with caution

• Pre-download: When enabled, the SDK downloads resources at startup. Resources are no longer on-demand, increasing CDN traffic consumption in your plan.

• Network environment: When pre-download is enabled, choose whether to download on WiFi only.

3.4 Set delivery conditions and rollout strategy

Learn more

• Available release conditions
• Available release strategies

4. Testing and Verification

4.1 Add testers and experience users

Learn more

• How to test and experience

5. Approval and Release

5.1 Submit for approval

5.2 Approve

6. Gray or Full Release

7. Pause or Stop a Task

• Pause task: For tasks in gray rollout, pause if issues are found. Can resume after pausing.

  • Users who already fetched the resource keep it. (Stop the task if the issue is severe.)

  • Users who have not fetched it cannot fetch the resource.

• Stop task: Any task can be stopped. After stopping, no users can fetch it.

8. One-Click Rollback

If you need to roll back artifacts to a historical version after an issue, use One-Click Resource Rollback:

1. Select the artifact version to roll back (automatically filtered to historically fully released artifacts).

   To overwrite with a new artifact, create a new task and release it.

2. Delivery conditions remain unchanged!

3. Choose gray rollout or immediate release based on rollback urgency.

Rollback consumes CDN traffic

One-click resource rollback creates a new rollback task. The SDK must download artifacts in the rollback task to complete rollback, consuming CDN traffic.