Merge pull request #2822 from goplus/dev

Release v1.12.1

Author: nighca

AGENTS.md

@@ -0,0 +1 @@
+./README.md

CLAUDE.md

@@ -0,0 +1 @@
+./README.md

Dockerfile

@@ -27,12 +27,14 @@ WORKDIR /app/spx-gui
 COPY spx-gui/package.json spx-gui/package-lock.json .
 COPY spx-gui/public ./public
 COPY spx-gui/install-spx.sh .
+COPY spx-gui/build-tutorial-books.sh .
 ARG NPM_CONFIG_REGISTRY
 RUN npm install
 
 COPY spx-gui .
 COPY docs ../docs
 COPY tools ../tools
+COPY tutorial ../tutorial
 # Copy assets (with wasm)
 COPY --from=go-builder /app/spx-gui/src/assets /app/spx-gui/src/assets
 

README.md

@@ -12,6 +12,12 @@ You can try XBuilder online at https://xbuilder.com.
 
 For users in mainland China, we recommend visiting https://x.qiniu.com for optimal performance.
 
+## Learn more about XBuilder
+
+Read [Product Design](./docs/product/index.md) to understand the core concepts in XBuilder.
+
+Read other content in [product docs directory](./docs/product/) to learn more about XBuilder's key features.
+
 ## How to develop
 
-See details in [Develop XBuilder](./docs/develop/index.md).
+For information like project structure, environment requirements, etc., refer to [Develop XBuilder](./docs/develop/index.md).

docs/develop/index.md

@@ -3,14 +3,14 @@
 ### Project Structure
 
 - **`/docs`**: Documentations for XBuilder.
+- **`/scripts`**: Scripts for building, deploying, or other automation tasks.
 - **`/spx-gui`**: Front-end project.
 - **`/tools`**: Other independent tools that XBuilder depends on.
-- **`/scripts`**: Scripts for building, deploying, or other automation tasks.
+- **`/tutorial`**: Tutorial content for learning in XBuilder.
 
 ### Environment Requirements
 
-- **Node.js**: >= 20.11.1
-- **Go**: >= 1.24.0
+See `package.json` or `go.mod` files in subdirectories for details.
 
 ### Architecture Design
 

docs/openapi.yaml

@@ -2255,6 +2255,23 @@ paths:
                     type: array
                     items:
                       $ref: "#/components/schemas/AIGCAnimationSettings"
+                  animationBindings:
+                    description: |
+                      Recommended mapping from sprite state enum values to animation names.
+                      Keys are sprite state enum values; values are animation name strings that should
+                      match the 'name' field from the animations array, omitted if no animation is bound to that state.
+                    type: object
+                    additionalProperties: false
+                    properties:
+                      default:
+                        type: string
+                      step:
+                        type: string
+                      die:
+                        type: string
+                    example:
+                      default: "idle"
+                      step: "walk"
         "403":
           description: Insufficient permissions or quota.
           headers:
@@ -2270,43 +2287,6 @@ paths:
               schema:
                 type: integer
 
-  /aigc/matting:
-    post:
-      tags:
-        - AIGC
-      deprecated: true
-      summary: Remove image background
-      description: |
-        Process the provided image URL to remove its background, resulting in a transparent background.
-
-        **Deprecated**: This endpoint is deprecated and will be removed in a future version. Use `POST /aigc/task` with
-        `type: "removeBackground"` instead, which provides better reliability for long-running operations.
-      requestBody:
-        required: true
-        content:
-          application/json:
-            schema:
-              type: object
-              required:
-                - imageUrl
-              properties:
-                imageUrl:
-                  description: URL of the image to process for background removal.
-                  type: string
-                  format: uri
-      responses:
-        "200":
-          description: Successfully processed the image for background removal.
-          content:
-            application/json:
-              schema:
-                type: object
-                properties:
-                  resultUrl:
-                    description: URL of the processed image with background removed.
-                    type: string
-                    format: uri
-
   /util/upinfo:
     get:
       tags:

spx-gui/.env

@@ -50,7 +50,7 @@ VITE_CASDOOR_ORGANIZATION_NAME=""
 VITE_DISABLE_AIGC="false"
 
 # Version of spx, keep in sync with the version in `install-spx.sh`.
-VITE_SPX_VERSION=2.0.0-pre.44
+VITE_SPX_VERSION=2.0.0-pre.45
 
 # Whether to show the license information (including copyright) in the footer.
 VITE_SHOW_LICENSE="false"

spx-gui/.gitignore

@@ -15,6 +15,9 @@ dist-ssr
 .eslintcache
 report.html
 
+# GitBook generated files
+public/tutorial-books
+
 npm-debug.log*
 .pnpm-error.log*
 .pnpm-debug.log

spx-gui/build-tutorial-books.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+# GitBook build script wrapper
+# This script calls the actual build script in the tutorial directory
+
+set -e
+
+# Execute the tutorial build script
+( cd ../tutorial && ./build.sh )

spx-gui/install-spx.sh

@@ -4,7 +4,7 @@ set -e
 cd "$(dirname "$0")"
 
 # Version of spx, keep in sync with the version in `.env`.
-SPX_VERSION=2.0.0-pre.44
+SPX_VERSION=2.0.0-pre.45
 SPX_NAME="spx_${SPX_VERSION}"
 SPX_FILE_NAME="${SPX_NAME}.zip"
 SPX_FILE_URL="https://github.com/goplus/spx/releases/download/v${SPX_VERSION}/spx_web.zip"