> For the complete documentation index, see [llms.txt](https://www.docszh.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.docszh.com/story-docs/introduction/quickstart.md).

# 快速入门

在Story上快速入门……那就开始吧！

* 我正在构建一个应用程序
* 我是一名智能合约开发者

{% hint style="info" %}
**想先了解“Story”吗？**

如果你想在了解技术细节之前了解Story，请查看强大的[Story学习中心](https://learn.story.foundation/)，它将带你深入了解Story的开发团队，以及什么是Story和为什么创立Story。
{% endhint %}

## 应用程序开发者

如果你想在Story上部署应用程序，本节适合你。

{% hint style="info" %}
**跳过一切，转到代码。**

如果你想直接跳过所有内容，进入编码阶段，下方为你提供了一个可复制的代码快速入门指南。你可以直接复制代码，并按照相关的自述文件操作。

**TypeScript SDK** Node.js 示例：[点击此处](https://github.com/storyprotocol/typescript-tutorial/tree/main)
{% endhint %}

### Story网络基础设施

[Story网络指南](/story-docs/network/guide.md)提供了关于RPC、区块浏览器和测试网水龙头等信息。

### 使用Story SDK

Story开发了一个[TypeScript SDK](/story-docs/developers/typescript-sdk.md)，并针对常用功能和用例提供了详细教程。

### 使用Story API

完整的API资源，请查看[API参考](https://docs.story.foundation/reference/api-introduction)，了解如何使用Story API。

### 在Story上注册IP

让我们从最基本的问题开始：如何在Story上注册IP？应该怎么做？

要在Story上注册IP，首先需要持有一个NFT。如果你的IP是ERC-721 NFT (例如Story上的Azuki或Pudgy Penguin)，那么你已经准备好了。如果不是，你必须铸造一个NFT来代表你的链下IP。不用担心，我们将在下方教程中指引你完成此操作。

接下来，你需要在Story上注册该NFT，最终创建一个[IP资产](/story-docs/concepts/ip-asset.md)。“IP资产”是指在Story上已完成注册的IP，其功能包括：

* 适用于Story的所有[模块](/story-docs/concepts/modules.md)，例如透明的授权、自动版税支付以及对不当注册的IP提出争议。
* 通过[可编程IP许可](/story-docs/concepts/programmable-ip-license.md) (PIL) 进行IP保护。

为了在代码中实现上述功能，Story SDK教程将向你展示如何做到以下几点：

* [注册IP资产](/story-docs/developers/typescript-sdk/register-ip-asset.md)

#### IP元数据与NFT元数据之间的区别

在Story上注册IP时，开发者提出的常见问题：NFT应该/预计附加哪些元数据，然后单独附加到IP资产？

要回答这个问题，请参阅[NFT与IP元数据](/story-docs/concepts/ip-asset.md)。

### 授权你的IP

你可能想知道：如何使用Story的链上许可？如何确保我注册的IP有可用的许可？

在将任何类型的许可证或许可条款附加到你的[IP资产](/story-docs/concepts/ip-asset.md)之前，最好先了解[可编程IP许可](/story-docs/concepts/programmable-ip-license.md) (PIL) 到底是什么。“PIL”定义了Story上可用的许可条款，当条款附加到IP资产时，其又定义了其他人可以如何使用该IP资产 (例如商业用途、进行二次创作等)。

Story SDK教程将向你展示如何将许可条款附加到IP资产：

* [将条款附加到IP资产](/story-docs/developers/typescript-sdk/attach-terms-to-ipa.md)

{% hint style="info" %}
**了解更多**

如需了解有关授权许可及其术语的更多信息，请查看[许可模块](/story-docs/concepts/licensing-module.md)。
{% endhint %}

### 版税/收入分成

现在你可能想知道：如何在个人IP资产和他人IP资产之间设置自动版税分成？如何获得分成？

当你将[许可条款](/story-docs/concepts/licensing-module/license-terms.md)附加到[IP资产](/story-docs/concepts/ip-asset.md)时，你可以选择特定的商业条款，例如`commercialRevShare`，该条款规定衍生作品必须与原始IP持有者共享收入 (包括任何来源，如原创和衍生作品收入)。有关许可问题，请参阅上文。

这里有一个示例：如果有人基于你的IP资产创作了衍生作品，并将许可条款`commercialRevShare`设置为10%。那么Story将通过[可编程IP许可](/story-docs/concepts/programmable-ip-license.md) (PIL)强制执行这部分收入分成 (否则将导致使用[争议模块](/story-docs/concepts/dispute-module.md)或传统法律仲裁链上争议)，然后在协议层面处理上游收入分成。如果衍生作品赚取了100美元的收入，原始IP资产持有者可以要求获得10美元收入分成。

Story SDK教程将向你展示如何领取收入分成：

* [领取收入分成](/story-docs/developers/typescript-sdk/claim-revenue.md)

{% hint style="info" %}
**了解更多**

如需了解有关版税及其运作方式的更多信息，请查看[版税模块](/story-docs/concepts/royalty-module.md)。
{% endhint %}

## 智能合约开发者

如果你想在Story上部署/构建智能合约，本节适合你。

{% hint style="info" %}
**跳过一切，转到代码。**

如果你想直接跳过所有内容，进入编码阶段，这里有一个[示例](https://github.com/storyprotocol/story-protocol-boilerplate)供你参考。你可以直接复制代码，研究示例智能合约，并按照相关的自述文件运行合约测试。
{% endhint %}

### Story网络基础设施

[Story网络指南](/story-docs/network/guide.md)提供了关于RPC、区块浏览器和测试网水龙头等信息。

### 已部署智能合约

点击[此处](/story-docs/developers/deployed-contracts.md)查看已部署的智能合约地址。请注意，有两种不同类型的合约：

* [**Story协议核心合约**](https://github.com/storyprotocol/protocol-core-v1)：该资源库包含核心协议逻辑，包括一个精简的IP注册器 ([IP资产](/story-docs/concepts/ip-asset.md)注册)、一组用于[许可](/story-docs/concepts/licensing-module.md)、[版税](/story-docs/concepts/royalty-module.md)、[争议](/story-docs/concepts/dispute-module.md)、元数据的模块，以及一个模块管理器 (用于管理模块和用户访问控制)。
* [**Story协议外围合约**](https://github.com/storyprotocol/protocol-periphery-v1)：核心合约处理协议底层逻辑，而外围合约则用于协议扩展，以提高用户体验并简化[IP资产](/story-docs/concepts/ip-asset.md)管理，主要通过[Story 协议网关 (SPG)](/story-docs/concepts/story-protocol-gateway.md)实现。

### 在 Story 上注册 IP

让我们从最基本的问题开始：在Story智能合约中注册IP需要准备什么？该怎么做？

首先，你需要在Story网络持有一个NFT，例如，基于ERC-721的NFT (Azuki或Pudgy Penguin)。如果尚未在Story网络持有NFT，你必须铸造一个NFT，以下教程将引导完成此步骤。

接下来，在Story上注册NFT，以创建IP资产。IP资产是你在Story上通过NFT注册的IP，并赋予以下功能：

* Story的所有[模块](/story-docs/concepts/modules.md)，如版权许可，自动版税支付，对错误注册的IP提出争议等。<br>
* 通过[可编程 IP 许可 (PIL)](/story-docs/concepts/programmable-ip-license.md)保护你的IP资产。

参阅[智能合约](/story-docs/developers/smart-contracts.md)教程，以尝试在合约中实现以上操作：

* [将NFT注册为IP资产](/story-docs/developers/smart-contracts/register-nft-as-ip-asset.md)

#### IP元数据与NFT元数据的区别

在Story注册IP时，一个常见问题：NFT和IP资产应该分别附加哪些元数据？

这个问题的具体回答，请参阅[NFT与IP元数据](/story-docs/concepts/ip-asset.md) 。

### 授权你的IP

让我们从最基本的问题开始：如何使用Story的链上授权？如何确保注册的IP已拥有许可？

在为IP资产附加任何类型的许可或许可条款之前，最好先了解一下[可编程 IP 许可 (PIL)](/story-docs/concepts/programmable-ip-license.md)到底是什么。`PIL`定义了Story上正在采用的[许可条款](/story-docs/concepts/licensing-module/license-terms.md)，当将其附加到IP资产时，它又定义了其他人对该IP资产拥有的使用权限 (如，商业用途、创建衍生作品等)。

参阅[智能合约](/story-docs/developers/smart-contracts.md)教程，以尝试将许可条款附加到IP资产：

* [为 IP 资产附加许可条款](/story-docs/developers/smart-contracts/attach-license-terms.md)

{% hint style="info" %}
**了解更多**

有关授权许可及其背后术语的更多信息，请参阅[许可模块](/story-docs/concepts/licensing-module.md)。
{% endhint %}

### 版税/收入分配

让我们从最基本的问题开始：如何在个人IP资产和他人IP资产间设置自动版税分配？如何申领分配？

当你将[许可条款](/story-docs/concepts/licensing-module/license-terms.md)附加到IP资产时，可以指定某些商业条款，如`commercialRevShare`，这是衍生作品必须与原IP持有人分配的收入比例 (可以来自任何来源，原创或衍生)。有关许可问题，请参阅上述章节。

举例说明：如果有人基于你的IP资产，创建了衍生作品，其许可条款中的`commercialRevShare`假设为10%，Story会通过[可编程 IP 许可 (PIL)](/story-docs/concepts/programmable-ip-license.md)强制执行收入分配 (对于有争议的作品，使用[争议模块](/story-docs/concepts/dispute-module.md)或传统法律仲裁)，然后在协议层面处理上游收入分配。如果衍生作品赚了100美元，原始IP资产持有人可以获得10美元。

参阅[智能合约](/story-docs/developers/smart-contracts.md)教程，以尝试向IP资产衍生作品申领版税：

* [申领版税](/story-docs/developers/smart-contracts/claiming-royalty.md)

{% hint style="info" %}
**了解更多**

有关版税及其功能的更多信息，请参阅[版税模块](/story-docs/concepts/royalty-module.md)。
{% endhint %}