石蒜模拟器网页小组件 - `sakana-widget` 使用手册

项目目录结构及介绍

sakana-widget 是一款用于网页端的轻量级石蒜模拟器组件。其目录结构如下：

sakana-widget/
├── lib/                     # 编译后的JavaScript库和CSS样式文件
│   ├── sakana.min.css       # 核心CSS样式
│   └── sakana.min.js        # 主要的JavaScript逻辑
├── src/                     # 源代码文件夹
│   ├── index.css            # 项目源CSS
│   └── index.js             # 项目主入口文件
├── README.zh.md             # 中文说明文档
├── package.json             # 包管理配置文件，包括依赖和脚本
├── ...
└── other necessary files    # 其他如许可证、构建脚本等

• lib 目录包含了压缩后的资源，供生产环境直接引用。
• src 是开发时的主要工作区，其中index.js是程序的启动文件，index.css提供必要的样式定义。
• README.zh.md 详细介绍了项目功能、使用方法以及如何集成到Web项目中。

项目的启动文件介绍

虽然本项目主要是通过引入预编译的.js和.css文件到你的项目中来使用的，但若从源码进行开发或贡献，主要关注的是src/index.js。这个文件定义了SakanaWidget类，它是核心功能的实现，允许开发者创建和定制模拟器的行为和外观。

在实际部署场景下，并不需要直接“启动”此文件，而是通过HTML引入编译好的lib/sakana.min.js来使用该组件。

项目的配置文件介绍

sakana-widget本身并不直接提供一个传统意义上的配置文件来让用户自定义设置。它的配置和个性化主要是通过构造函数SakanaWidget的参数或者静态方法来实现的。比如，在JavaScript环境中初始化组件时，可以通过传递一个配置对象给new SakanaWidget(options)来定制大小、是否自动适配、控制栏显示与否、选择角色等特性。以下是一个简单的配置示例：

new SakanaWidget({
  size: 250,
  character: 'takina',
  controls: false,
});

对于更复杂的定制需求，如添加新的角色类型，需通过静态方法registerCharacter进行扩展，这在源代码的高级使用或二次开发中更为常见。

---

以上就是关于sakana-widget项目的基本结构、启动文件的理解以及配置方式的简要介绍。通过上述指导，开发者应能顺利集成此组件至他们的网站或应用中。