pc-lib

A types library for viverse-world, pc-ui-ext.

Committing Code

For improved commit messages, use either:

pnpm commit

or

git commit -m "{type}: {description}"
# e.g.
# git commit -m "feat: add new feature"
# git commit -m "fix: fix a bug"

Follow the Conventional Commits guidelines at: https://www.conventionalcommits.org/en/v1.0.0/

Install in your project

# e.g.
# branch
pnpm add github:ViveportSoftware/pc-lib#master
# tag
pnpm add github:ViveportSoftware/pc-lib#v1.32.0

Create SDK TS

Directory

sdk 
  ├── create-sdk-ts
    ├── index.ts       - Export root & build the doc.
    ├── export-sdk.ts  - Export sdk for extension.
    ├── metadata.ts    - Store metadata like SDK's version.
    ├── template.ts    - Build from export-sdk.ts, will be injected into the creator's SDK of the extension. 
    ├── types.ts       - Store global type.
    ├── services       - Store SDK services.
        ├── ${serviceName}
            ├── enums                   - Store service enums.
            ├── interface               - Store service interface.
                ├── I${ServiceName}.ts  
            ├── ${ServiceName}.ts       - Services instance. (For extension SDK export.)
            ├── index.ts                - Export services.

Create create-sdk template

1. Bundle ESM interfaces script with Rollup
2. Convert bundle to a string and export as template.ts

After modifying the create-sdk interface, run the command below:

pnpm generate-create-sdk

Read create-sdk docs

You can view the documentation here.

For local development, you can follow the steps below to open the docs:

1. Open the create-sdk documentation by navigating to the docs directory in your project.
2. Open the index.html file in your web browser to view the documentation.