GLSL-Sandbox 技术文档

1. 安装指南

步骤

1. Fork 存储库

2. 下载存储库并创建新的开发分支：

   $ git clone [e-mail]:<your user>/glsl-sandbox
   $ cd glsl-sandbox
   $ git checkout -b <feature name>
   

3. 下载并解压测试数据：

   $ curl -O https://downloads.zooloo.org/glslsandbox-data.tar.gz
   $ tar xvf glslsandbox-data.tar.gz
   

4. 构建服务器二进制文件（需要 go 编译器）：

   $ go build ./server/cmd/glslsandbox
   

5. 或者，从存储库目录下载并解压二进制文件：

   # 从以下位置下载最新版本的二进制文件
   # https://github.com/mrdoob/glsl-sandbox/releases/latest
   

6. 运行服务器：

   $ ./glslsandbox
   

注意事项

• 首次启动时，将创建一个管理员用户并打印凭据。
• 服务器应在 http://localhost:8888 上可用。
• 管理界面位于 http://localhost:8888/admin。

2. 项目使用说明

模板和 JavaScript 修改

服务器在每个查询时重新加载模板和资源。这使得开发变得简单，因为您可以在文件上进行修改，并且在重新加载页面时更改将生效。

只有一个模板用于图库（首页）和管理页面。该文件为 server/assets/gallery.html 并使用 go 语言模板。您可以在此处了解更多关于其语法的更多信息：

• https://gohugo.io/templates/introduction/
• https://pkg.go.dev/text/template
• https://pkg.go.dev/html/template

当前页面接收以下数据：

type galleryEffect struct {
    ID     int
    Version int
    Image  string
    Hidden bool
}

type galleryData struct {
    Effects []galleryEffect
    URL     string
    Page    int
    IsPrevious bool
    PreviousPage int
    IsNext    bool
    NextPage   int
    Admin    bool
}

galleryData 为页面信息，galleryEffect 为每个效果的信息。例如，要打印所有效果的 ID，您可以使用：

<ul>
{{ range .Effects }}
    <li>{{ .ID }}</li>
{{ end }}
</ul>

以下目录可以从服务器访问并可以根据需要修改：

• server/assets/css -> /css
• server/assets/js -> /js

默认情况下，数据文件从 ./data 读取。此路径可以通过环境变量 DATA_PATH 更改。例如：

$ DATA_PATH=/my/data/directory ./glslsandbox

数据目录包含 sqlite 数据库 (glslsandbox.db) 和缩略图 (thumbs 目录)。

3. 项目 API 使用文档

本项目未提供专门的 API 文档。API 的使用应根据项目的具体实现和代码逻辑进行。

4. 项目安装方式

项目的安装方式已在“安装指南”部分详细描述。请按照上述步骤进行安装。