文档

下面每一页都是仓库里的一个文件，官网与 GitHub 读的是同一份源 —— 所以两边不会各说各话。每页都留了原文入口，想拿原始文件随时可以拿。

这里的每一页都是一个文件

下表就是全部文档：左边是仓库里的路径，右边是它变成的页面。重建站点时两边由同一个源渲染，改任何一边都会反映到另一边。

docs/ → 网站

docs/i18n/README_zh-CN.md项目说明

docs/i18n/plugins/README_zh-CN.md插件开发指南

docs/i18n/plugins/CONVENTION_zh-CN.md开发规范

docs/i18n/plugins/MARKET_zh-CN.md发布与发现

turbo-plugin-js/README.md用 JavaScript 写插件

turbo-plugin-js/ARCHITECTURE.mdJS 加载器架构

—清单字段参考

LICENSE开源协议（MIT）

docs/i18n/legal/THIRD-PARTY_zh-CN.md第三方组件与致谢

docs/i18n/legal/PRIVACY_zh-CN.md隐私说明

docs/i18n/legal/TERMS_zh-CN.md使用条款

没有对应语言版本的那几页会退回另一种语言的原文，并在页首说明。

从这三页开始

全部通过三样东西完成：一个依赖、一个配置对象、一次提交。暂停、继续、取消、批量与诊断都在同一个 client 上。

Kotlin

// build.gradle.kts
dependencies {
    implementation("dev.turbodl:turbodl-core:0.4.1.0")
}

// Kotlin
val client = TurboClient(TurboConfig(maxConnectionsPerTask = 16))
val id = client.submit(DownloadRequest(url, File("out.bin")))
val result = client.await(id)

shell

java -jar turbodl-cli-all.jar <url> -o out.bin -c 64
java -jar turbodl-cli-all.jar <url> --json       # NDJSON
java -jar turbodl-cli-all.jar --batch tasks.txt  # one URL per line

turbodl --json · 标准输出

{"type":"start","url":"<url>","output":"out.bin"}
{"type":"timing","stage":"metadata","t_ms":184,"probe_ms":96,"resume":""}
{"type":"progress","state":"downloading","downloaded":222732288,"total":358411469,"percent":62,"speed":19503514,"connections":16,"eta_ms":7020}
{"type":"completed","url":"<url>","file":"out.bin","bytes":358411469,"sha256":"0f3a…"}
{"type":"summary","total":1,"failed":0}

全部配置面

九个字段，全部公开、全部有明确取值域。运行时没有别的可调项 —— 引擎没有隐藏旋钮，也没有打电话回家的默认值。

TurboConfig 的字段

maxConnectionsPerTask16 · 1..256

maxConcurrentTasks3 · 1..64

globalSpeedLimitBytesPerSec0 = unlimited

maxRetries5 · 0..50, per segment

dynamicSegmentationtrue

tailAssist / tailAssistMinBytestrue · 2 MiB

overlapMerge / bufferedSegmentWritefalse · false

minSegmentSize / blockSize64 KiB · 16 MiB

proxy / dns / trustAllCertsDirect · System · Manual · PAC / System · StaticHosts · DoH

取值是 TurboConfig.kt 里的默认值；每一个都能按 client 单独设置。

一份插件清单长什么样

一个插件 = 一个 JAR + 这个文件。参考页列了每个字段的类型、是否必填、以及允许的取值。

turbodl-plugin.json

{
  "manifestVersion": "1.0",
  "id": "parser.example",
  "name": "Example parser",
  "description": "Turns example:// links into download requests.",
  "version": "0.1.0",
  "author": "you",
  "homepage": "https://github.com/you/turbodl-plugin-example",
  "license": "MIT",
  "category": "turbodl-parser",
  "capabilities": [
    "dev.turbodl.cap.parser"
  ],
  "protocols": [
    "example"
  ],
  "turbodl": {
    "apiMajor": 1,
    "requiredApiVersion": "1.0.0"
  },
  "entry": {
    "language": "kotlin",
    "pluginClass": "com.example.ExamplePlugin"
  },
  "extensionPoints": [
    "turbo.linkParser"
  ]
}

与「清单字段参考」那一页用同一个常量渲染，两页不会各说各话。