查看“系统文件与路径”的源代码

[[ru:Системные файлы и пути]] [[en:System Files and Paths]] [[zh:系统文件与路径]]
该软件将数据存储在三个不同的位置:'''项目文件夹'''中保存您构建的一切;'''程序文档文件夹'''中保存库、工作区和运行日志;而'''Windows 系统'''本身则保存程序设置和许可证。您需要在以下三种情况下了解这一点:将项目转移到另一台电脑时;转移或重新安装后项目中找不到图片和视频时;技术支持要求您提供运行日志时。

确切的文件夹名称取决于软件版本以及您的安装位置,因此下文按用途来称呼它们:'''项目文件夹'''、'''程序文档文件夹'''、'''安装文件夹'''。在复制或删除任何内容之前,请先在您自己的电脑上打开这些文件夹,核对其中实际存放的内容。

== 简要说明:各项内容存放在何处 ==

{| class="wikitable"
! 内容 !! 位置 !! 是否随项目一起转移
|-
| 固定装置(fixtures)、配接(patching)、合成(compositions)、效果(effects)、3D 场景 || 项目文件夹中的项目文件 <code>*.ls</code> || 是,这就是项目本身
|-
| 图片、视频、序列、音频、模型贴图 || 保存在您获取它们的原始位置;项目中只记录引用 || 仅当您将项目收集到一个文件夹中时
|-
| 导出的动画 <code>*.cue</code> || '''导出(Export)'''窗口中选择的文件夹(默认是项目旁边的 <code>Export</code> 子文件夹) || 否,需要重新导出
|-
| 自定义固定装置、效果库、工作区、日志 || 程序文档文件夹 || 否,需单独复制
|-
| 程序设置、最近项目列表、许可证 || Windows 系统中,当前用户的配置文件内 || 否,需重新设置
|}

== 项目文件夹 ==

=== 如何创建 ===

# 选择'''文件(File)''' → '''新建项目(New Project)'''(''Ctrl+N'')或在欢迎窗口中点击'''创建(Create)'''。
# 在'''创建项目(Create Project)'''窗口中设置'''项目名称(Project Name)''' —— 文件和文件夹都将以此命名。
# 在'''路径(Path)'''字段中指定要在何处创建该文件夹:可手动输入,也可点击'''打开(Open)'''按钮选择。默认建议使用程序文档文件夹中的 <code>Scenes</code> 子文件夹,但更方便的做法是将项目保存在您存放该场地工作素材的位置。
# 如有需要,修改'''项目每秒帧数(Frames per second for the project)''' —— 新建的合成将以此帧率创建。
# 点击'''创建(Create)'''。

程序会在指定位置创建一个以项目命名的文件夹,将扩展名为 <code>.ls</code> 的项目文件放入其中,并同时在旁边创建一个 <code>Export</code> 子文件夹 —— 它会自动填入'''导出(Export)'''窗口的'''路径(Path)'''字段。

此后,可以把这个文件夹当作场地文件夹:将您在项目中使用的所有图片、视频、序列、音频和模型都放入其中。程序只会在项目文件夹内部查找丢失的文件,而不会搜索整个磁盘。

=== 项目文件中包含的内容 ===

<code>.ls</code> 文件是一个单独的文件,汇集了您构建的全部内容:

* 映射上的固定装置及其尺寸、地址和名称;
* 设备(Player、转换器、端口)及配接;
* 合成、布局、效果及其关键帧;
* 整个 3D 场景,包括导入模型的几何体:导入后,原始模型文件 <code>*.obj</code> 或 <code>*.fbx</code> 已不再需要,没有它项目也能打开;
* 项目中使用过的固定装置 —— 因此即便在没有您自定义固定装置库的电脑上,项目也能正常打开;
* 合成的导出设置。

项目文件中'''没有'''的是媒体文件本身。图片、视频、视频序列、音轨、模型贴图和布局背景图都保存在磁盘上,项目中只记录指向它们的路径。如果此类文件被重命名、删除,或留在了旧电脑上,项目中对应的效果会被标记为丢失。

=== 项目备份 ===

每次保存时,程序都会先把项目的上一个状态另存为一个副本:项目文件旁边会出现一个同名并在末尾添加 <code>.backup</code> 的文件。

如果项目在一次失败的保存之后无法打开:

# 关闭程序。
# 把损坏的 <code>.ls</code> 文件挪到别处保存 —— 以防日后还用得上。
# 复制带 <code>.backup</code> 的文件,并从副本名称中去掉 <code>.backup</code>,得到一个普通的 <code>.ls</code> 文件。
# 在程序中打开它。

这样您得到的项目将是上一次保存时的状态。备份只有一份,并且每次保存都会被覆盖,因此不能把它当作归档使用:重要的工作阶段请通过'''文件(File)''' → '''另存为…(Save As…)'''以不同的名称分别保存。

=== 程序如何查找丢失的文件 ===

如果按项目中记录的路径找不到文件,程序不会立即放弃,而是自行搜索:

* 在项目文件夹及其所有子文件夹中查找同名文件;
* 对视频序列文件夹,还会在项目文件夹内的 <code>Import\Video</code> 子文件夹中查找。

由此得出一条简单的规则:把媒体文件保存在项目文件夹内。这样项目文件夹被重命名或迁移到另一块磁盘后依然能正常使用 —— 程序会自动找到所有文件。而如果图片存放在桌面或 U 盘上,迁移后就需要手动重新选择。

== 将项目转移到另一台电脑 ==

要连同所有外部文件一起收集项目,请使用'''文件(File)''' → '''收集项目(Collect Project)''':

# 打开项目,选择'''文件(File)''' → '''收集项目(Collect Project)'''。
# 指定要收集到的文件夹。最好选择一个空文件夹:程序会把项目文件以及它所使用的全部文件都放入其中。
# 等待完成 —— 对于包含视频的大型项目,这需要一些时间。

具体过程是:项目文件的副本被写入所选文件夹,所有外部文件被复制到 <code>CollectProjectFiles</code> 子文件夹中,并按照它们在磁盘上的原始位置分门别类地存放到对应的嵌套子文件夹里。收集后的项目内部路径会相对于新文件夹重新构建,因此需要转移的是'''整个文件夹''',而不是单独的 <code>.ls</code> 文件。

会被收集的内容包括:效果中的图片和视频、视频序列、音轨、布局背景图,以及导入模型的贴图。

有用的提示:

* 如果所选文件夹不可写入,程序会给出提示并且不会收集任何内容 —— 请另选一个位置;
* 收集完成后,您仍在原项目中继续工作,收集得到的副本只是单独存放在磁盘上;
* 程序设置、工作区和许可证不会随项目一起转移 —— 需要在新电脑上重新设置。

== 导出的文件 ==

合成导出会把文件保存到'''导出(Export)'''窗口'''路径(Path)'''字段中指定的文件夹。对于在当前版本中创建的项目,该字段默认就是项目旁边的 <code>Export</code> 子文件夹;可以通过'''打开(Open)'''按钮更改。

{| class="wikitable"
! 文件 !! 命名方式
|-
| '''Light Stream Player''' 使用的动画 || '''合成名称''',扩展名为 <code>.cue</code>
|-
| 用于演示的视频(视频渲染模式) || '''合成名称''',扩展名为 <code>.mp4</code>
|-
| 固定装置遮罩 || 保存时您指定的名称,扩展名为 <code>*.png</code>
|}

文件名取自合成名称,因此名称中不允许出现字符 <code>\ / : * ? " &lt; &gt; |</code> —— 程序不允许输入这些字符。

如果项目中有多台 '''Light Stream Player''' 设备,程序会在导出文件夹中为每台设备创建单独的子文件夹,并把 <code>*.cue</code> 文件分别放入对应文件夹 —— 这样一眼就能看出哪些动画应加载到哪台播放器上。

== 程序文档文件夹 ==

程序首次启动时,会在系统'''文档'''文件夹中创建自己的文件夹,并把所有与工作场所相关(而非与单个项目相关)的内容保存在其中。该文件夹的确切名称取决于软件版本 —— 请在'''文档'''中按程序名称查找它,并对照下表核实其中的内容。

{| class="wikitable"
! 内容 !! 查找位置
|-
| 欢迎窗口中展示的演示项目;新建项目也默认建议保存于此 || <code>Scenes</code> 子文件夹
|-
| 固定装置库:出厂自带的 <code>fixtures.lslib</code>、您的自定义 <code>UserFixtures.lslib</code>,以及 <code>Images</code> 子文件夹中固定装置和厂商的图片 || <code>Fixtures</code> 子文件夹
|-
| 效果库 —— '''效果(Effects)'''窗口的内容以及您保存的效果(文件 <code>LightStream.effects</code>) || <code>Effects</code> 子文件夹
|-
| 工作区 —— 已保存的窗口布局(文件 <code>ls.workspace</code>) || 程序文档文件夹根目录
|-
| 程序运行日志 || <code>logs</code> 子文件夹
|}

迁移到新电脑时,其中值得复制的内容有:

* <code>UserFixtures.lslib</code> 及 <code>Images</code> 子文件夹 —— 如果您制作过自己的固定装置,并希望在新项目中继续使用;
* <code>LightStream.effects</code> —— 如果您按自己的需要调整过效果库。保存效果库时,程序会在旁边留下一份带 <code>.backup</code> 后缀的旧版本副本;
* <code>ls.workspace</code> —— 如果您很看重自己的窗口布局。

复制这个文件夹中的文件时应先关闭程序,否则部分改动会在程序退出时被覆盖。

== 程序安装文件夹 ==

安装路径在安装向导中设置;默认是'''Program Files'''中的一个文件夹。程序本体就存放在这里 —— 例如在 NVIDIA 控制面板中配置性能时选择的可执行文件(参见 [[Light Stream - 快速开始]])。

不需要把自己的文件放到这里:普通用户在'''Program Files'''中没有写入权限,而且更新程序时该文件夹的内容会被覆盖。项目、媒体和导出内容请保存在项目文件夹中。

== 设置、最近项目和许可证 ==

'''选项(Options)'''窗口中的设置、'''文件(File)''' → '''最近文件(Recent Files)'''列表以及许可证数据,既不保存在项目中,也不在可以复制的独立文件里:它们记录在 Windows 系统中,并与本电脑上的用户账户绑定。由此可知:

* 无法通过复制文件夹的方式把设置转移到另一台电脑 —— 语言、网卡、音频设备等都需要重新设置;
* 同一台电脑上的每个 Windows 用户都有各自的设置和各自的最近项目列表;
* 许可证与电脑绑定。在把程序转移到另一台电脑之前,需要先在'''激活(Activation)'''窗口('''帮助(Help)''' → '''激活(Activation)''')中将其停用 —— 否则授权将一直被占用;
* 安装新版本程序后,窗口布局可能会恢复为默认状态。这是正常现象,您的工作区需要重新保存。

== 程序运行日志 ==

程序会记录日志:位于程序文档文件夹中的 <code>logs</code> 子文件夹,文件为 <code>ls.log</code>。当文件增长到大约 1 MB 时,会被移入 <code>archives</code> 子文件夹,记录则继续写入新文件;最多保留十份归档,更早的会自动删除。

联系技术支持时需要用到日志:如果程序自行关闭、卡死,或提示了不明确的错误,请在提交问题时附上 <code>logs</code> 文件夹的内容,并描述此前的操作。无需另外开启日志记录 —— 它始终在运行。

== 值得备份的内容 ==

备份的最小集合:

# 整个项目文件夹 —— <code>.ls</code> 文件连同媒体文件。如果媒体文件存放得比较分散,请先执行'''文件(File)''' → '''收集项目(Collect Project)''',再备份收集后得到的文件夹。
# 导出的 <code>*.cue</code> 文件 —— 如果不想在现场重新导出。
# 程序文档文件夹中的:带 <code>Images</code> 子文件夹的 <code>UserFixtures.lslib</code>、<code>LightStream.effects</code>、<code>ls.workspace</code>。

程序设置和许可证无法复制 —— 只能手动恢复,许可证则需要通过停用来转移。

== 另请参阅 ==

* [[Light Stream - 快速开始]]
* [[Settings]]
* [[Workspace]]
* [[Экспорт композиций]]
* [[Библиотека приборов]]
* [[Импорт моделей OBJ]]
* [[Терминология]]