@fifine/aim-studio 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (289) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +159 -0
  3. package/bin/aim.js +3 -0
  4. package/dist/cli/index.d.ts +3 -0
  5. package/dist/cli/index.d.ts.map +1 -0
  6. package/dist/cli/index.js +89 -0
  7. package/dist/cli/index.js.map +1 -0
  8. package/dist/commands/init.d.ts +13 -0
  9. package/dist/commands/init.d.ts.map +1 -0
  10. package/dist/commands/init.js +513 -0
  11. package/dist/commands/init.js.map +1 -0
  12. package/dist/commands/update.d.ts +27 -0
  13. package/dist/commands/update.d.ts.map +1 -0
  14. package/dist/commands/update.js +1275 -0
  15. package/dist/commands/update.js.map +1 -0
  16. package/dist/configurators/claude.d.ts +32 -0
  17. package/dist/configurators/claude.d.ts.map +1 -0
  18. package/dist/configurators/claude.js +98 -0
  19. package/dist/configurators/claude.js.map +1 -0
  20. package/dist/configurators/index.d.ts +51 -0
  21. package/dist/configurators/index.d.ts.map +1 -0
  22. package/dist/configurators/index.js +113 -0
  23. package/dist/configurators/index.js.map +1 -0
  24. package/dist/configurators/shared.d.ts +12 -0
  25. package/dist/configurators/shared.d.ts.map +1 -0
  26. package/dist/configurators/shared.js +21 -0
  27. package/dist/configurators/shared.js.map +1 -0
  28. package/dist/configurators/workflow.d.ts +28 -0
  29. package/dist/configurators/workflow.d.ts.map +1 -0
  30. package/dist/configurators/workflow.js +147 -0
  31. package/dist/configurators/workflow.js.map +1 -0
  32. package/dist/constants/paths.d.ts +68 -0
  33. package/dist/constants/paths.d.ts.map +1 -0
  34. package/dist/constants/paths.js +77 -0
  35. package/dist/constants/paths.js.map +1 -0
  36. package/dist/constants/version.d.ts +9 -0
  37. package/dist/constants/version.d.ts.map +1 -0
  38. package/dist/constants/version.js +15 -0
  39. package/dist/constants/version.js.map +1 -0
  40. package/dist/index.d.ts +9 -0
  41. package/dist/index.d.ts.map +1 -0
  42. package/dist/index.js +9 -0
  43. package/dist/index.js.map +1 -0
  44. package/dist/migrations/index.d.ts +54 -0
  45. package/dist/migrations/index.d.ts.map +1 -0
  46. package/dist/migrations/index.js +160 -0
  47. package/dist/migrations/index.js.map +1 -0
  48. package/dist/migrations/manifests/0.0.1.json +9 -0
  49. package/dist/migrations/manifests/0.1.9.json +30 -0
  50. package/dist/migrations/manifests/0.2.0.json +49 -0
  51. package/dist/migrations/manifests/0.2.12.json +9 -0
  52. package/dist/migrations/manifests/0.2.13.json +9 -0
  53. package/dist/migrations/manifests/0.2.14.json +175 -0
  54. package/dist/migrations/manifests/0.2.15.json +33 -0
  55. package/dist/migrations/manifests/0.3.0-beta.0.json +278 -0
  56. package/dist/migrations/manifests/0.3.0-beta.1.json +9 -0
  57. package/dist/migrations/manifests/0.3.0-beta.10.json +9 -0
  58. package/dist/migrations/manifests/0.3.0-beta.11.json +9 -0
  59. package/dist/migrations/manifests/0.3.0-beta.12.json +9 -0
  60. package/dist/migrations/manifests/0.3.0-beta.13.json +9 -0
  61. package/dist/migrations/manifests/0.3.0-beta.14.json +9 -0
  62. package/dist/migrations/manifests/0.3.0-beta.15.json +9 -0
  63. package/dist/migrations/manifests/0.3.0-beta.16.json +9 -0
  64. package/dist/migrations/manifests/0.3.0-beta.2.json +9 -0
  65. package/dist/migrations/manifests/0.3.0-beta.3.json +9 -0
  66. package/dist/migrations/manifests/0.3.0-beta.4.json +9 -0
  67. package/dist/migrations/manifests/0.3.0-beta.5.json +9 -0
  68. package/dist/migrations/manifests/0.3.0-beta.6.json +9 -0
  69. package/dist/migrations/manifests/0.3.0-beta.7.json +11 -0
  70. package/dist/migrations/manifests/0.3.0-beta.8.json +9 -0
  71. package/dist/migrations/manifests/0.3.0-beta.9.json +9 -0
  72. package/dist/migrations/manifests/0.3.0-rc.0.json +9 -0
  73. package/dist/migrations/manifests/0.3.0-rc.1.json +9 -0
  74. package/dist/migrations/manifests/0.3.0-rc.2.json +9 -0
  75. package/dist/templates/CLAUDE.md +71 -0
  76. package/dist/templates/aim/gitignore.txt +29 -0
  77. package/dist/templates/aim/index.d.ts +49 -0
  78. package/dist/templates/aim/index.d.ts.map +1 -0
  79. package/dist/templates/aim/index.js +92 -0
  80. package/dist/templates/aim/index.js.map +1 -0
  81. package/dist/templates/aim/scripts/__init__.py +5 -0
  82. package/dist/templates/aim/scripts/add_session.py +392 -0
  83. package/dist/templates/aim/scripts/common/__init__.py +80 -0
  84. package/dist/templates/aim/scripts/common/cli_adapter.py +435 -0
  85. package/dist/templates/aim/scripts/common/developer.py +190 -0
  86. package/dist/templates/aim/scripts/common/git_context.py +383 -0
  87. package/dist/templates/aim/scripts/common/paths.py +347 -0
  88. package/dist/templates/aim/scripts/common/phase.py +253 -0
  89. package/dist/templates/aim/scripts/common/registry.py +366 -0
  90. package/dist/templates/aim/scripts/common/task_queue.py +255 -0
  91. package/dist/templates/aim/scripts/common/task_utils.py +178 -0
  92. package/dist/templates/aim/scripts/common/worktree.py +219 -0
  93. package/dist/templates/aim/scripts/create_bootstrap.py +290 -0
  94. package/dist/templates/aim/scripts/get_context.py +16 -0
  95. package/dist/templates/aim/scripts/get_developer.py +26 -0
  96. package/dist/templates/aim/scripts/init_developer.py +51 -0
  97. package/dist/templates/aim/scripts/multi_agent/__init__.py +5 -0
  98. package/dist/templates/aim/scripts/multi_agent/cleanup.py +403 -0
  99. package/dist/templates/aim/scripts/multi_agent/create_pr.py +329 -0
  100. package/dist/templates/aim/scripts/multi_agent/plan.py +233 -0
  101. package/dist/templates/aim/scripts/multi_agent/start.py +461 -0
  102. package/dist/templates/aim/scripts/multi_agent/status.py +817 -0
  103. package/dist/templates/aim/scripts/task.py +1068 -0
  104. package/dist/templates/aim/scripts-shell-archive/add-session.sh +384 -0
  105. package/dist/templates/aim/scripts-shell-archive/common/developer.sh +129 -0
  106. package/dist/templates/aim/scripts-shell-archive/common/git-context.sh +263 -0
  107. package/dist/templates/aim/scripts-shell-archive/common/paths.sh +208 -0
  108. package/dist/templates/aim/scripts-shell-archive/common/phase.sh +150 -0
  109. package/dist/templates/aim/scripts-shell-archive/common/registry.sh +247 -0
  110. package/dist/templates/aim/scripts-shell-archive/common/task-queue.sh +142 -0
  111. package/dist/templates/aim/scripts-shell-archive/common/task-utils.sh +151 -0
  112. package/dist/templates/aim/scripts-shell-archive/common/worktree.sh +128 -0
  113. package/dist/templates/aim/scripts-shell-archive/create-bootstrap.sh +299 -0
  114. package/dist/templates/aim/scripts-shell-archive/get-context.sh +7 -0
  115. package/dist/templates/aim/scripts-shell-archive/get-developer.sh +15 -0
  116. package/dist/templates/aim/scripts-shell-archive/init-developer.sh +34 -0
  117. package/dist/templates/aim/scripts-shell-archive/multi-agent/cleanup.sh +396 -0
  118. package/dist/templates/aim/scripts-shell-archive/multi-agent/create-pr.sh +241 -0
  119. package/dist/templates/aim/scripts-shell-archive/multi-agent/plan.sh +207 -0
  120. package/dist/templates/aim/scripts-shell-archive/multi-agent/start.sh +317 -0
  121. package/dist/templates/aim/scripts-shell-archive/multi-agent/status.sh +828 -0
  122. package/dist/templates/aim/scripts-shell-archive/task.sh +1204 -0
  123. package/dist/templates/aim/tasks/.gitkeep +0 -0
  124. package/dist/templates/aim/workflow.md +258 -0
  125. package/dist/templates/aim/worktree.yaml +47 -0
  126. package/dist/templates/claude/agents/check.md +122 -0
  127. package/dist/templates/claude/agents/debug.md +106 -0
  128. package/dist/templates/claude/agents/dispatch.md +230 -0
  129. package/dist/templates/claude/agents/implement.md +96 -0
  130. package/dist/templates/claude/agents/plan.md +396 -0
  131. package/dist/templates/claude/agents/research.md +120 -0
  132. package/dist/templates/claude/agents/story.md +53 -0
  133. package/dist/templates/claude/commands/aim/before-backend-dev.md +13 -0
  134. package/dist/templates/claude/commands/aim/before-frontend-dev.md +13 -0
  135. package/dist/templates/claude/commands/aim/break-loop.md +153 -0
  136. package/dist/templates/claude/commands/aim/check-backend.md +13 -0
  137. package/dist/templates/claude/commands/aim/check-cross-layer.md +153 -0
  138. package/dist/templates/claude/commands/aim/check-frontend.md +13 -0
  139. package/dist/templates/claude/commands/aim/check-story.md +59 -0
  140. package/dist/templates/claude/commands/aim/create-command.md +154 -0
  141. package/dist/templates/claude/commands/aim/export.md +187 -0
  142. package/dist/templates/claude/commands/aim/finish-work.md +104 -0
  143. package/dist/templates/claude/commands/aim/integrate-skill.md +219 -0
  144. package/dist/templates/claude/commands/aim/onboard.md +358 -0
  145. package/dist/templates/claude/commands/aim/parallel.md +217 -0
  146. package/dist/templates/claude/commands/aim/portrait.md +170 -0
  147. package/dist/templates/claude/commands/aim/record-session.md +92 -0
  148. package/dist/templates/claude/commands/aim/start.md +112 -0
  149. package/dist/templates/claude/commands/aim/story.md +140 -0
  150. package/dist/templates/claude/commands/aim/update-spec.md +285 -0
  151. package/dist/templates/claude/commands/aim/visualize.md +182 -0
  152. package/dist/templates/claude/commands/trellis/before-backend-dev.md +13 -0
  153. package/dist/templates/claude/commands/trellis/before-frontend-dev.md +13 -0
  154. package/dist/templates/claude/commands/trellis/break-loop.md +125 -0
  155. package/dist/templates/claude/commands/trellis/check-backend.md +13 -0
  156. package/dist/templates/claude/commands/trellis/check-cross-layer.md +153 -0
  157. package/dist/templates/claude/commands/trellis/check-frontend.md +13 -0
  158. package/dist/templates/claude/commands/trellis/create-command.md +154 -0
  159. package/dist/templates/claude/commands/trellis/finish-work.md +129 -0
  160. package/dist/templates/claude/commands/trellis/integrate-skill.md +219 -0
  161. package/dist/templates/claude/commands/trellis/onboard.md +358 -0
  162. package/dist/templates/claude/commands/trellis/parallel.md +193 -0
  163. package/dist/templates/claude/commands/trellis/record-session.md +62 -0
  164. package/dist/templates/claude/commands/trellis/start.md +280 -0
  165. package/dist/templates/claude/commands/trellis/update-spec.md +285 -0
  166. package/dist/templates/claude/hooks/inject-subagent-context.py +772 -0
  167. package/dist/templates/claude/hooks/ralph-loop.py +388 -0
  168. package/dist/templates/claude/hooks/session-start.py +142 -0
  169. package/dist/templates/claude/index.d.ts +54 -0
  170. package/dist/templates/claude/index.d.ts.map +1 -0
  171. package/dist/templates/claude/index.js +85 -0
  172. package/dist/templates/claude/index.js.map +1 -0
  173. package/dist/templates/claude/settings.json +41 -0
  174. package/dist/templates/extract.d.ts +68 -0
  175. package/dist/templates/extract.d.ts.map +1 -0
  176. package/dist/templates/extract.js +128 -0
  177. package/dist/templates/extract.js.map +1 -0
  178. package/dist/templates/markdown/agents.md +25 -0
  179. package/dist/templates/markdown/gitignore.txt +12 -0
  180. package/dist/templates/markdown/index.d.ts +32 -0
  181. package/dist/templates/markdown/index.d.ts.map +1 -0
  182. package/dist/templates/markdown/index.js +58 -0
  183. package/dist/templates/markdown/index.js.map +1 -0
  184. package/dist/templates/markdown/spec/backend/database-guidelines.md.txt +51 -0
  185. package/dist/templates/markdown/spec/backend/directory-structure.md.txt +54 -0
  186. package/dist/templates/markdown/spec/backend/error-handling.md.txt +51 -0
  187. package/dist/templates/markdown/spec/backend/index.md +40 -0
  188. package/dist/templates/markdown/spec/backend/index.md.txt +38 -0
  189. package/dist/templates/markdown/spec/backend/logging-guidelines.md.txt +51 -0
  190. package/dist/templates/markdown/spec/backend/quality-guidelines.md.txt +51 -0
  191. package/dist/templates/markdown/spec/backend/script-conventions.md +467 -0
  192. package/dist/templates/markdown/spec/frontend/component-guidelines.md.txt +59 -0
  193. package/dist/templates/markdown/spec/frontend/directory-structure.md.txt +54 -0
  194. package/dist/templates/markdown/spec/frontend/hook-guidelines.md.txt +51 -0
  195. package/dist/templates/markdown/spec/frontend/index.md.txt +39 -0
  196. package/dist/templates/markdown/spec/frontend/quality-guidelines.md.txt +51 -0
  197. package/dist/templates/markdown/spec/frontend/state-management.md.txt +51 -0
  198. package/dist/templates/markdown/spec/frontend/type-safety.md.txt +51 -0
  199. package/dist/templates/markdown/spec/guides/code-reuse-thinking-guide.md +118 -0
  200. package/dist/templates/markdown/spec/guides/code-reuse-thinking-guide.md.txt +92 -0
  201. package/dist/templates/markdown/spec/guides/cross-layer-thinking-guide.md.txt +94 -0
  202. package/dist/templates/markdown/spec/guides/cross-platform-thinking-guide.md +394 -0
  203. package/dist/templates/markdown/spec/guides/cross-platform-thinking-guide.md.txt +319 -0
  204. package/dist/templates/markdown/spec/guides/index.md.txt +89 -0
  205. package/dist/templates/markdown/spec/story/character.md.txt +95 -0
  206. package/dist/templates/markdown/spec/story/index.md.txt +31 -0
  207. package/dist/templates/markdown/spec/story/script.md.txt +313 -0
  208. package/dist/templates/markdown/spec/story/world.md.txt +92 -0
  209. package/dist/templates/markdown/workspace-index.md +123 -0
  210. package/dist/templates/markdown/worktree.yaml.txt +58 -0
  211. package/dist/templates/trellis/gitignore.txt +29 -0
  212. package/dist/templates/trellis/index.d.ts +49 -0
  213. package/dist/templates/trellis/index.d.ts.map +1 -0
  214. package/dist/templates/trellis/index.js +92 -0
  215. package/dist/templates/trellis/index.js.map +1 -0
  216. package/dist/templates/trellis/scripts/__init__.py +5 -0
  217. package/dist/templates/trellis/scripts/add_session.py +392 -0
  218. package/dist/templates/trellis/scripts/common/__init__.py +80 -0
  219. package/dist/templates/trellis/scripts/common/cli_adapter.py +435 -0
  220. package/dist/templates/trellis/scripts/common/developer.py +190 -0
  221. package/dist/templates/trellis/scripts/common/git_context.py +383 -0
  222. package/dist/templates/trellis/scripts/common/paths.py +347 -0
  223. package/dist/templates/trellis/scripts/common/phase.py +253 -0
  224. package/dist/templates/trellis/scripts/common/registry.py +366 -0
  225. package/dist/templates/trellis/scripts/common/task_queue.py +255 -0
  226. package/dist/templates/trellis/scripts/common/task_utils.py +178 -0
  227. package/dist/templates/trellis/scripts/common/worktree.py +219 -0
  228. package/dist/templates/trellis/scripts/create_bootstrap.py +290 -0
  229. package/dist/templates/trellis/scripts/get_context.py +16 -0
  230. package/dist/templates/trellis/scripts/get_developer.py +26 -0
  231. package/dist/templates/trellis/scripts/init_developer.py +51 -0
  232. package/dist/templates/trellis/scripts/multi_agent/__init__.py +5 -0
  233. package/dist/templates/trellis/scripts/multi_agent/cleanup.py +403 -0
  234. package/dist/templates/trellis/scripts/multi_agent/create_pr.py +329 -0
  235. package/dist/templates/trellis/scripts/multi_agent/plan.py +233 -0
  236. package/dist/templates/trellis/scripts/multi_agent/start.py +461 -0
  237. package/dist/templates/trellis/scripts/multi_agent/status.py +817 -0
  238. package/dist/templates/trellis/scripts/task.py +1056 -0
  239. package/dist/templates/trellis/scripts-shell-archive/add-session.sh +384 -0
  240. package/dist/templates/trellis/scripts-shell-archive/common/developer.sh +129 -0
  241. package/dist/templates/trellis/scripts-shell-archive/common/git-context.sh +263 -0
  242. package/dist/templates/trellis/scripts-shell-archive/common/paths.sh +208 -0
  243. package/dist/templates/trellis/scripts-shell-archive/common/phase.sh +150 -0
  244. package/dist/templates/trellis/scripts-shell-archive/common/registry.sh +247 -0
  245. package/dist/templates/trellis/scripts-shell-archive/common/task-queue.sh +142 -0
  246. package/dist/templates/trellis/scripts-shell-archive/common/task-utils.sh +151 -0
  247. package/dist/templates/trellis/scripts-shell-archive/common/worktree.sh +128 -0
  248. package/dist/templates/trellis/scripts-shell-archive/create-bootstrap.sh +299 -0
  249. package/dist/templates/trellis/scripts-shell-archive/get-context.sh +7 -0
  250. package/dist/templates/trellis/scripts-shell-archive/get-developer.sh +15 -0
  251. package/dist/templates/trellis/scripts-shell-archive/init-developer.sh +34 -0
  252. package/dist/templates/trellis/scripts-shell-archive/multi-agent/cleanup.sh +396 -0
  253. package/dist/templates/trellis/scripts-shell-archive/multi-agent/create-pr.sh +241 -0
  254. package/dist/templates/trellis/scripts-shell-archive/multi-agent/plan.sh +207 -0
  255. package/dist/templates/trellis/scripts-shell-archive/multi-agent/start.sh +317 -0
  256. package/dist/templates/trellis/scripts-shell-archive/multi-agent/status.sh +828 -0
  257. package/dist/templates/trellis/scripts-shell-archive/task.sh +1204 -0
  258. package/dist/templates/trellis/tasks/.gitkeep +0 -0
  259. package/dist/templates/trellis/workflow.md +416 -0
  260. package/dist/templates/trellis/worktree.yaml +47 -0
  261. package/dist/types/ai-tools.d.ts +48 -0
  262. package/dist/types/ai-tools.d.ts.map +1 -0
  263. package/dist/types/ai-tools.js +32 -0
  264. package/dist/types/ai-tools.js.map +1 -0
  265. package/dist/types/migration.d.ts +86 -0
  266. package/dist/types/migration.d.ts.map +1 -0
  267. package/dist/types/migration.js +8 -0
  268. package/dist/types/migration.js.map +1 -0
  269. package/dist/utils/compare-versions.d.ts +12 -0
  270. package/dist/utils/compare-versions.d.ts.map +1 -0
  271. package/dist/utils/compare-versions.js +76 -0
  272. package/dist/utils/compare-versions.js.map +1 -0
  273. package/dist/utils/file-writer.d.ts +23 -0
  274. package/dist/utils/file-writer.d.ts.map +1 -0
  275. package/dist/utils/file-writer.js +140 -0
  276. package/dist/utils/file-writer.js.map +1 -0
  277. package/dist/utils/project-detector.d.ts +16 -0
  278. package/dist/utils/project-detector.d.ts.map +1 -0
  279. package/dist/utils/project-detector.js +188 -0
  280. package/dist/utils/project-detector.js.map +1 -0
  281. package/dist/utils/template-fetcher.d.ts +51 -0
  282. package/dist/utils/template-fetcher.d.ts.map +1 -0
  283. package/dist/utils/template-fetcher.js +174 -0
  284. package/dist/utils/template-fetcher.js.map +1 -0
  285. package/dist/utils/template-hash.d.ts +78 -0
  286. package/dist/utils/template-hash.d.ts.map +1 -0
  287. package/dist/utils/template-hash.js +239 -0
  288. package/dist/utils/template-hash.js.map +1 -0
  289. package/package.json +87 -0
@@ -0,0 +1,89 @@
1
+ # Thinking Guides
2
+
3
+ > **Purpose**: Expand your thinking to catch things you might not have considered.
4
+
5
+ ---
6
+
7
+ ## Why Thinking Guides?
8
+
9
+ **Most bugs and tech debt come from "didn't think of that"**, not from lack of skill:
10
+
11
+ - Didn't think about what happens at layer boundaries → cross-layer bugs
12
+ - Didn't think about code patterns repeating → duplicated code everywhere
13
+ - Didn't think about edge cases → runtime errors
14
+ - Didn't think about future maintainers → unreadable code
15
+
16
+ These guides help you **ask the right questions before coding**.
17
+
18
+ ---
19
+
20
+ ## Available Guides
21
+
22
+ | Guide | Purpose | When to Use |
23
+ |-------|---------|-------------|
24
+ | [Code Reuse Thinking Guide](./code-reuse-thinking-guide.md) | Identify patterns and reduce duplication | When you notice repeated patterns |
25
+ | [Cross-Layer Thinking Guide](./cross-layer-thinking-guide.md) | Think through data flow across layers | Features spanning multiple layers |
26
+ | [Cross-Platform Thinking Guide](./cross-platform-thinking-guide.md) | Catch platform-specific assumptions | Scripts, paths, commands |
27
+
28
+ ---
29
+
30
+ ## Quick Reference: Thinking Triggers
31
+
32
+ ### When to Think About Cross-Layer Issues
33
+
34
+ - [ ] Feature touches 3+ layers (API, Service, Component, Database)
35
+ - [ ] Data format changes between layers
36
+ - [ ] Multiple consumers need the same data
37
+ - [ ] You're not sure where to put some logic
38
+
39
+ → Read [Cross-Layer Thinking Guide](./cross-layer-thinking-guide.md)
40
+
41
+ ### When to Think About Code Reuse
42
+
43
+ - [ ] You're writing similar code to something that exists
44
+ - [ ] You see the same pattern repeated 3+ times
45
+ - [ ] You're adding a new field to multiple places
46
+ - [ ] **You're modifying any constant or config**
47
+ - [ ] **You're creating a new utility/helper function** ← Search first!
48
+
49
+ → Read [Code Reuse Thinking Guide](./code-reuse-thinking-guide.md)
50
+
51
+ ### When to Think About Cross-Platform Issues
52
+
53
+ - [ ] Writing scripts that users will run directly
54
+ - [ ] Adding usage examples or help text
55
+ - [ ] Working with file paths or commands
56
+ - [ ] **Migrating from shell scripts to Python**
57
+
58
+ → Read [Cross-Platform Thinking Guide](./cross-platform-thinking-guide.md)
59
+
60
+ ---
61
+
62
+ ## Pre-Modification Rule (CRITICAL)
63
+
64
+ > **Before changing ANY value, ALWAYS search first!**
65
+
66
+ ```bash
67
+ # Search for the value you're about to change
68
+ grep -r "value_to_change" .
69
+ ```
70
+
71
+ This single habit prevents most "forgot to update X" bugs.
72
+
73
+ ---
74
+
75
+ ## How to Use This Directory
76
+
77
+ 1. **Before coding**: Skim the relevant thinking guide
78
+ 2. **During coding**: If something feels repetitive or complex, check the guides
79
+ 3. **After bugs**: Add new insights to the relevant guide (learn from mistakes)
80
+
81
+ ---
82
+
83
+ ## Contributing
84
+
85
+ Found a new "didn't think of that" moment? Add it to the relevant guide.
86
+
87
+ ---
88
+
89
+ **Core Principle**: 30 minutes of thinking saves 3 hours of debugging.
@@ -0,0 +1,95 @@
1
+ # 角色设定规范 (Character Profile)
2
+
3
+ ## 核心角色表
4
+
5
+ | 姓名 | 性别 | 年龄 | 核心关键词 (Tag) |
6
+ |---|---|---|---|
7
+ | 主角名 | 男/女 | 18 | 热血, 腹黑, 剑客 |
8
+
9
+ ---
10
+
11
+ ## 角色详情模板
12
+
13
+ 请为每个主要角色复制以下模板并填写:
14
+
15
+ ### [角色姓名]
16
+
17
+ **基本信息**
18
+ - **全名**:
19
+ - **昵称/代号**:
20
+ - **性别**:
21
+ - **年龄**:
22
+ - **生日**:
23
+ - **职业/身份**:
24
+
25
+ **外貌特征 (Visual Description)**
26
+ > *用于 AI 绘画提示词参考*
27
+ - **发型/发色**:
28
+ - **眼睛/瞳色**:
29
+ - **体型/身高**:
30
+ - **服装风格**:
31
+ - **饰品/特征**:
32
+ - **面部表情惯例**:
33
+
34
+ **性格特征 (Personality)**
35
+ - **核心性格**: (如:傲娇、冷静、鲁莽)
36
+ - **优点**:
37
+ - **缺点/弱点**:
38
+ - **说话风格**: (如:口头禅、语速、用词习惯)
39
+ - **价值观/动机**:
40
+
41
+ **背景故事 (Backstory)**
42
+ - **过往经历**:
43
+ - **核心冲突**:
44
+ - **人际关系**:
45
+ - vs [角色B]: (关系描述)
46
+
47
+ ---
48
+
49
+ ## 配角/路人设定
50
+
51
+ - **[配角A]**: 简短描述...
52
+
53
+ ---
54
+
55
+ ## 进阶设定(可选)
56
+
57
+ > 以下内容适用于长篇连续剧,根据项目需要选择使用。
58
+
59
+ ### 角色成长轨迹
60
+
61
+ > 记录角色在故事中的变化,避免性格突变
62
+
63
+ | 章节/集数 | 状态/阶段 | 关键变化 | 心理状态 | 备注 |
64
+ |-----------|-----------|----------|----------|------|
65
+ | (示例) EP01 | 初登场 | - | 天真烂漫 | |
66
+ | (示例) EP05 | 转折点 | 经历背叛 | 开始怀疑 | |
67
+ | (示例) EP10 | 成熟期 | 接受现实 | 冷静务实 | |
68
+
69
+ ### 角色关系演变
70
+
71
+ > 追踪角色间关系的变化,适用于多角色长篇故事
72
+
73
+ | 角色 | 初始关系 | 当前关系 | 关键转折点 | 当前章节 |
74
+ |------|----------|----------|------------|----------|
75
+ | (示例) 配角A | 陌生人 | 盟友 | EP03共同战斗 | EP10 |
76
+
77
+ ### 章节状态快照
78
+
79
+ > 每集结束时角色的状态(位置、装备、情绪、知识等),帮助保持连续性
80
+
81
+ | 章节 | 当前位置 | 装备/道具 | 情绪状态 | 已知信息 | 重要变化 |
82
+ |------|----------|-----------|----------|----------|----------|
83
+ | (示例) EP05 | 王都 | 佩剑、信物 | 焦虑 | 知道了真相 | 获得信物 |
84
+
85
+ ### 角色视觉一致性检查表
86
+
87
+ > 确保 AI 绘画/视频生成时角色外观一致
88
+
89
+ | 特征项 | 设定 | 是否可变 | 备注 |
90
+ |--------|------|----------|------|
91
+ | 发型/发色 | | 固定/可变 | |
92
+ | 瞳色 | | 固定/可变 | |
93
+ | 标志性饰品 | | 固定/可变 | |
94
+ | 服装变化 | | 按章节记录 | |
95
+ | SD Prompt 片段 | | | |
@@ -0,0 +1,31 @@
1
+ # 漫剧创作指南 (Story Creation Guide)
2
+
3
+ > 本目录包含漫剧/小说创作的规范与最佳实践。
4
+
5
+ ---
6
+
7
+ ## 概览
8
+
9
+ 本目录下的文档旨在指导 AI 与创作者协作进行高质量的漫剧或小说创作。请根据项目具体需求填写相关设定。
10
+
11
+ ---
12
+
13
+ ## 指南索引
14
+
15
+ | 指南 | 说明 | 状态 |
16
+ |------|------|------|
17
+ | [角色设定](./character.md) | 角色档案、性格、外貌、背景故事 | 待定 |
18
+ | [世界观设定](./world.md) | 地理、历史、魔法/科技体系、势力分布 | 待定 |
19
+ | [剧本规范](./script.md) | 剧本格式、分镜描述、对白规范 | 待定 |
20
+
21
+ ---
22
+
23
+ ## 使用说明
24
+
25
+ 1. **角色先行**:在开始写作前,请先完善[角色设定](./character.md)。
26
+ 2. **构建世界**:明确[世界观](./world.md)有助于维持故事逻辑的一致性。
27
+ 3. **遵循格式**:请严格按照[剧本规范](./script.md)输出现场/对白,以便后续进行 AI 绘画或分镜制作。
28
+
29
+ ---
30
+
31
+ **语言**:建议使用**简体中文**进行创作。
@@ -0,0 +1,313 @@
1
+ # 剧本与分镜规范 (Script & Storyboard)
2
+
3
+ ## 视频格式配置(必填)
4
+
5
+ > 在开始创作前,请先确定视频格式。这将影响每场戏的时长和内容密度。
6
+
7
+ | 配置项 | 选项 | 当前设定 |
8
+ |--------|------|----------|
9
+ | 视频类型 | 单集 / 连续剧 | (请填写) |
10
+ | 视频长度 | 短视频(1-3分钟)/ 中视频(5-15分钟)/ 长视频(20分钟+) | (请填写) |
11
+ | 单场时长 | 短视频:15-30秒/场;中视频:30-60秒/场;长视频:1-3分钟/场 | (请填写) |
12
+ | 每集场次数 | 建议:短视频3-5场;中视频5-10场;长视频10-20场 | (请填写) |
13
+
14
+ **示例配置**:
15
+ ```
16
+ 视频类型:连续剧
17
+ 视频长度:短视频(2-3分钟/集)
18
+ 单场时长:20-30秒
19
+ 每集场次数:4-6场
20
+ ```
21
+
22
+ ---
23
+
24
+ ## Seedance 2.0 Prompt 优化指南
25
+
26
+ > 基于 Seedance 2.0 论文核心分析,以下是针对音视频联合生成的最优 Prompt 策略。
27
+
28
+ ### Prompt 结构框架(必填六要素)
29
+
30
+ ```
31
+ 【主体描述】+ 【动作/表演细节】+ 【环境/氛围】+ 【镜头语言】+ 【音频/声音设计】+ 【风格/影调】
32
+ ```
33
+
34
+ ### 各维度优化技巧
35
+
36
+ #### 1. 主体描述(利用强语义理解)
37
+ - ✅ **具体明确**:"一位穿着暗红色羊绒大衣的40岁女性" 优于 "一个女人"
38
+ - ✅ **多模态细节**:同时描述视觉外观和声音特征
39
+ ```
40
+ 例:"一位嗓音略带沙哑的中年男性,穿着磨损的皮夹克,说话时带有明显的四川方言口音"
41
+ ```
42
+
43
+ #### 2. 动作与表演(避免慢动作陷阱)
44
+ - ⚠️ **避免**:仅写 "缓慢行走"(模型可能用慢动作糊弄)
45
+ - ✅ **推荐**:明确动作意图和情绪强度
46
+ ```
47
+ 例:"她快步穿过人群,肩膀微微颤抖,表现出压抑的愤怒,步伐急促但保持平衡"
48
+ ```
49
+
50
+ #### 3. 镜头控制(利用原生运镜能力)
51
+
52
+ | 运镜类型 | Prompt 写法 |
53
+ |---------|------------|
54
+ | 希区柯克变焦 | "Dolly zoom effect: camera pulls back while zooming in" |
55
+ | 环绕镜头 | "360-degree orbital shot around the subject" |
56
+ | 跟踪镜头 | "Handheld tracking shot following the character" |
57
+ | 长镜头 | "Continuous long take without cuts" |
58
+ | 特写转场 | "Push-in to extreme close-up on eyes" |
59
+ | 推镜头 | "Slow push-in from medium shot to close-up" |
60
+ | 拉镜头 | "Pull-back shot revealing the environment" |
61
+
62
+ #### 4. 音频设计(核心差异化能力)
63
+ **必须显式描述音频**,因为模型是音视频联合生成:
64
+
65
+ ```
66
+ 【人声细节】
67
+ - 语言:"普通话/粤语/四川话/英语"
68
+ - 音色:"清脆的少女音/浑厚的男低音/沙哑的烟嗓"
69
+ - 情绪语调:"颤抖的哭腔/抑扬顿挫的朗诵/冷漠的平淡语气"
70
+ - 内容:直接写出台词或描述说话内容
71
+
72
+ 【环境音效】
73
+ - "海浪拍打礁石的声音,海鸥远处鸣叫"
74
+ - "雨声从轻柔转为倾盆,配合雷声渐近"
75
+
76
+ 【音乐氛围】
77
+ - "低沉的大提琴独奏,逐渐加入弦乐,营造悬疑感"
78
+ ```
79
+
80
+ #### 5. 风格与影调
81
+ - ✅ 描述具体视觉特征而非空泛词
82
+ - ❌ 避免:"高质量"、"4K"、"精美"
83
+ - ✅ 推荐:"冷色调,高对比度,电影级调色"
84
+
85
+ ### 中文场景特化技巧
86
+
87
+ 1. **方言使用**:直接指定
88
+ ```
89
+ "角色用上海话交谈,语调软糯,带有老派弄堂口音"
90
+ ```
91
+
92
+ 2. **文化元素**:模型对东方表演有理解
93
+ ```
94
+ "京剧旦角,兰花指手势,眼波流转,念白带有韵白节奏"
95
+ "武侠风格,抱拳行礼,衣袂飘动,配乐是古筝与笛子"
96
+ ```
97
+
98
+ 3. **短剧节奏**:指定快节奏叙事
99
+ ```
100
+ "短剧风格,快节奏剪辑感,每3秒一个情绪转折,配合紧张的音乐节拍"
101
+ ```
102
+
103
+ ---
104
+
105
+ ## 场次文件格式标准
106
+
107
+ ### 文件结构(Seedance 2.0 优化版)
108
+
109
+ ```markdown
110
+ 【主体描述】
111
+ 角色外观、服装、体型、年龄等具体描述
112
+ 声音特征:音色、语调、方言口音
113
+
114
+ 【动作与表演】
115
+ 具体动作描述,包含情绪强度和动作意图
116
+ 避免模糊描述,明确动作节奏
117
+
118
+ 【环境与氛围】
119
+ 场景地点、时间、天气、光线
120
+ 环境氛围关键词
121
+
122
+ 【镜头语言】
123
+ 运镜方式:推/拉/摇/移/跟/升降
124
+ 景别:远景/全景/中景/近景/特写
125
+ 特殊效果:慢动作/快进/定格
126
+
127
+ 【音频设计】
128
+ 人声:语言、音色、语调、台词内容
129
+ 环境音:具体的环境声音描述
130
+ 音乐:背景音乐风格和情绪
131
+
132
+ 【风格影调】
133
+ 整体视觉风格
134
+ 色调和光影特点
135
+ 参考作品风格(可选)
136
+
137
+ 【剧本内容】
138
+ 对白和动作描写
139
+ ```
140
+
141
+ ---
142
+
143
+ ## 文件命名规范(简体中文)
144
+
145
+ > **重要**:所有目录和文件名必须使用简体中文,便于用户识别和管理。
146
+
147
+ **剧集目录命名**:`第{集数}集_{中文标题}`
148
+
149
+ **场次文件命名**:`场次{序号}.txt`
150
+
151
+ **封面图片命名**:`场次{序号}_封面.png` 或 `场次{序号}_封面.jpg`
152
+
153
+ **示例目录结构**:
154
+ ```
155
+ 输出/
156
+ ├── 项目配置.md # 视频格式配置
157
+ ├── 全局上下文.txt # 角色设定、世界观
158
+ ├── 第1集_系统觉醒/
159
+ │ ├── 剧本.md # 完整剧本
160
+ │ ├── 场次1.txt # 可粘贴到视频生成工具
161
+ │ ├── 场次1_封面.png # 场次1封面图片
162
+ │ ├── 场次2.txt
163
+ │ ├── 场次2_封面.png
164
+ │ └── 上下文摘要.txt # 本集结尾状态
165
+ ├── 第2集_一剑开天门/
166
+ │ └── ...
167
+ └── ...
168
+ ```
169
+
170
+ ---
171
+
172
+ ## 封面图片生成规范
173
+
174
+ > 每个场次视频都应有对应的封面图片,用于视频封面展示。
175
+
176
+ ### 封面图片要求
177
+
178
+ | 属性 | 要求 |
179
+ |------|------|
180
+ | 尺寸 | 1920x1080(横版)或 1080x1920(竖版) |
181
+ | 格式 | PNG 或 JPG |
182
+ | 风格 | 与视频视觉风格一致 |
183
+
184
+ ### 封面 Prompt 模板
185
+
186
+ ```
187
+ 【封面图片提示词】
188
+ 风格:[视觉风格关键词]
189
+ 主体:[主要角色/物体]
190
+ 动作:[关键姿势/表情]
191
+ 场景:[背景环境]
192
+ 光线:[光照效果]
193
+ 构图:[镜头角度/构图方式]
194
+ ```
195
+
196
+ ---
197
+
198
+ ## 完整示例 Prompt
199
+
200
+ ### 示例1:修仙玄幻场景
201
+
202
+ ```markdown
203
+ 【主体描述】
204
+ 沈安在:白衣中年男子,约40岁,两鬓霜白,面容俊俏,身材修长。
205
+ 声音特征:沉稳有力的男中音,说话时带有仙风道骨的从容感。
206
+
207
+ 【动作与表演】
208
+ 双手负于身后,从高处跃下,落地时衣袂飘动,表情从慵懒转为严肃。
209
+ 步伐稳健,眼神锐利地盯着前方,表现出高人的威严感。
210
+
211
+ 【环境与氛围】
212
+ 青云峰山道,清晨,阳光透过云层洒落,山间云雾缭绕。
213
+ 氛围:仙侠意境,空灵飘逸。
214
+
215
+ 【镜头语言】
216
+ 运镜:从高处俯拍沈安在跃下,跟随下落,落地时切换到低角度仰拍。
217
+ 景别:全景 → 中景 → 近景。
218
+ 节奏:落地瞬间有轻微的慢动作效果。
219
+
220
+ 【音频设计】
221
+ 人声:沈安在大喝"站住!",声音在山谷中回荡。
222
+ 环境音:山风吹过树林的沙沙声,远处鸟鸣。
223
+ 音乐:古筝急促拨动,营造紧张感,落地时音乐骤停。
224
+
225
+ 【风格影调】
226
+ xianxia, chinese fantasy, cinematic lighting, ethereal atmosphere.
227
+ 色调:冷色调为主,晨光带来暖色点缀。
228
+ 参考:《琅琊榜》《陈情令》的仙侠视觉风格。
229
+
230
+ 【剧本内容】
231
+ 沈安在落地,双手负于身后,故作高深地看着慕容天。
232
+ 沈安在:(冷淡) 你要去哪?
233
+ 慕容天低头,不敢直视沈安在。
234
+ ```
235
+
236
+ ### 示例2:情绪特写场景
237
+
238
+ ```markdown
239
+ 【主体描述】
240
+ 慕容天:少年身形,约16岁,穿着朴素道袍,背着包袱。
241
+ 声音特征:清亮的少年音,说话时带着压抑的哭腔。
242
+
243
+ 【动作与表演】
244
+ 停下脚步,回头望向青云峰顶,眼眶泛红,嘴角苦笑。
245
+ 肩膀微微颤抖,表现出压抑的悲伤和不甘。
246
+
247
+ 【环境与氛围】
248
+ 青云峰山道,上午,阳光透过树叶洒落斑驳光影。
249
+ 氛围:落寞、决绝。
250
+
251
+ 【镜头语言】
252
+ 运镜:固定机位,缓慢推近到面部特写。
253
+ 景别:远景 → 中景 → 面部特写。
254
+ 特殊:最后定格在眼睛的极端特写,捕捉泪光。
255
+
256
+ 【音频设计】
257
+ 人声:慕容天自语,声音低沉颤抖。
258
+ 环境音:山间寂静,偶尔有风吹树叶声。
259
+ 音乐:低沉的大提琴独奏,逐渐加入弦乐,营造悲伤感。
260
+
261
+ 【风格影调】
262
+ xianxia, chinese fantasy, melancholic, cinematic.
263
+ 色调:偏冷的蓝色调,阳光带来微弱暖色。
264
+ 参考:《卧虎藏龙》的情感戏视觉风格。
265
+
266
+ 【剧本内容】
267
+ 慕容天:(自语) 三年了……我还是无法突破筑基期。
268
+ 慕容天停下脚步,回头望向青云峰顶。
269
+ 慕容天:(苦笑) 也许离开才是最好的选择。
270
+ ```
271
+
272
+ ---
273
+
274
+ ## 避坑指南
275
+
276
+ | ❌ 避免 | ✅ 替代 |
277
+ |--------|--------|
278
+ | "高质量"、"4K"、"精美" 等空泛词 | 具体描述材质、光影、运镜方式 |
279
+ | 仅描述视觉,忽略音频 | 音视频联合描述,至少指定环境音 |
280
+ | 过度限制(指定每秒的动作) | 给模型创意空间,描述意图和情绪 |
281
+ | 长句堆砌 | 用分段清晰分隔不同维度 |
282
+ | "像XX电影"(模型可能不理解) | 描述该电影的具体视觉特征 |
283
+ | "缓慢行走"等模糊动作 | 明确动作意图、情绪强度和节奏 |
284
+
285
+ ---
286
+
287
+ ## 进阶设定(可选)
288
+
289
+ ### 章节摘要模板
290
+
291
+ > 每章完成后记录核心信息,帮助 AI 记住前文。
292
+
293
+ ```markdown
294
+ ## 第X章摘要
295
+ - **核心事件**:(一句话概括)
296
+ - **关键决策**:(角色做出的重要决定)
297
+ - **角色登场**:(本章出现的角色)
298
+ - **伏笔埋设**:(埋下的伏笔ID)
299
+ - **伏笔揭示**:(揭示的伏笔ID)
300
+ - **角色状态变化**:(位置、情绪、关系等变化)
301
+ - **预计下章内容**:(简要提示)
302
+ ```
303
+
304
+ ### 场次时长估算指南
305
+
306
+ | 视频类型 | 对白密度 | 动作密度 | 建议时长 |
307
+ |----------|----------|----------|----------|
308
+ | 短视频 | 少(1-3句) | 多 | 15-20秒 |
309
+ | 短视频 | 多(5-10句) | 少 | 20-30秒 |
310
+ | 中视频 | 少 | 多 | 30-45秒 |
311
+ | 中视频 | 多 | 少 | 45-60秒 |
312
+ | 长视频 | 少 | 多 | 1-2分钟 |
313
+ | 长视频 | 多 | 少 | 2-3分钟 |
@@ -0,0 +1,92 @@
1
+ # 世界观设定规范 (World Building)
2
+
3
+ ## 世界概览
4
+
5
+ - **世界名称**:
6
+ - **核心基调**: (如:赛博朋克、高魔奇幻、现代都市、克苏鲁)
7
+ - **核心规则**: (如:魔法均需等价交换、科技高度发达但贫富悬殊)
8
+
9
+ ---
10
+
11
+ ## 地理与环境
12
+
13
+ ### [主要地点A]
14
+ - **描述**:
15
+ - **氛围**:
16
+ - **重要地标**:
17
+
18
+ ### [主要地点B]
19
+ - **描述**:
20
+
21
+ ---
22
+
23
+ ## 势力与组织
24
+
25
+ ### [组织名称]
26
+ - **性质**: (如:政府、公会、邪教)
27
+ - **宗旨**:
28
+ - **主要成员**:
29
+ - **徽章/标志**:
30
+
31
+ ---
32
+
33
+ ## 力量体系 (Magic/Tech System)
34
+
35
+ - **体系名称**:
36
+ - **等级划分**:
37
+ - **获取方式**:
38
+ - **代价/限制**:
39
+
40
+ ---
41
+
42
+ ## 历史大事记
43
+
44
+ 1. **[年份/时期]**: 事件描述...
45
+ 2. **[年份/时期]**: 事件描述...
46
+
47
+ ---
48
+
49
+ ## 进阶设定(可选)
50
+
51
+ > 以下内容适用于长篇连续剧,根据项目需要选择使用。
52
+
53
+ ### 故事时间线
54
+
55
+ > 统一记录故事内的时间流逝,避免时间逻辑错误
56
+
57
+ | 故事时间 | 章节/集数 | 关键事件 | 参与角色 |
58
+ |----------|-----------|----------|----------|
59
+ | 第1天 | EP01 | 主角觉醒 | 主角、导师 |
60
+ | (示例) 第3天 | EP02 | 进入王都 | 主角、配角A |
61
+
62
+ ### 伏笔追踪表
63
+
64
+ > 记录埋下的伏笔,避免烂尾或遗忘
65
+
66
+ | ID | 伏笔内容 | 埋设章节 | 计划揭示章节 | 状态 | 关联角色 |
67
+ |----|----------|----------|--------------|------|----------|
68
+ | F001 | (示例) 神秘项链 | EP01 | EP15 | 待揭示 | 主角 |
69
+ | F002 | (示例) 失踪的父亲 | EP03 | ? | 进行中 | 配角A |
70
+
71
+ **状态说明**:
72
+ - `待揭示`:尚未开始揭示
73
+ - `进行中`:正在逐步揭示
74
+ - `已完成`:伏笔已完全揭示
75
+
76
+ ### 场景视觉参考
77
+
78
+ > 为 AI 绘画/视频生成提供场景一致性参考
79
+
80
+ | 场景名称 | 关键特征 | 氛围 | 时间段 | SD Prompt 片段 |
81
+ |----------|----------|------|--------|----------------|
82
+ | (示例) 王都学院 | 欧式建筑 | 庄严 | 白天 | fantasy academy |
83
+ | (示例) 废弃仓库 | 破败 | 压抑 | 夜晚 | abandoned warehouse |
84
+
85
+ ### 设定变更日志
86
+
87
+ > 记录创作过程中的设定修改,便于追溯和同步更新
88
+
89
+ | 日期 | 变更内容 | 影响范围 | 需同步更新 | 状态 |
90
+ |------|----------|----------|------------|------|
91
+ | (示例) 2024-01-15 | 主角年龄改为18 | EP01-05对白 | ✅ 已更新 | 完成 |
92
+ | (示例) 2024-01-20 | 新增配角C | EP08起 | ⏳ 待更新 | 进行中 |