# ScriptBox

**Repository Path**: talonshaw/ScriptBox

## Basic Information

- **Project Name**: ScriptBox
- **Description**: 脚本盒子，为项目重复性工作提供一键操作的可能，并以工作台形式归集这些操作。
- **Primary Language**: C#
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 10
- **Forks**: 4
- **Created**: 2023-04-27
- **Last Updated**: 2025-06-16

## Categories & Tags

**Categories**: utils

**Tags**: None

## README

# ScriptBox

## 介绍

脚本盒子，为项目重复性工作提供一键操作的可能，并以工作台形式归集这些操作。

 

## 图文教程

[ScriptBox - 一键脚本工作台 - Qokori Note](https://www.qokorii.cn/archives/gX653h51)

 

## 简易使用说明

### 软件逻辑

ScriptBox软件配合**ScriptBox项目**使用，ScriptBox项目文件为自定义的**sbprj**格式，内容是**json**格式文本。

### 如何新建ScriptBox项目

新建项目步骤如下：

1. 创建一个文件夹，用于存放项目；
2. 点击菜单栏--项目--新建，选择上面创建的文件夹，填写项目名然后点保存即可；
3. 默认生成一个“hello word”测试按钮。

上面新建的test项目代码如下：

```json
{
  "projectName": "test",
  "workDir": "./",
  "buttonGroups": [
    {
      "groupName": "通用工具",
      "buttons": [
        {
          "title": "hello",
          "imgPath": "default",
          "scriptType": "cmd",
          "scriptContent": "echo Hello World!"
        }
      ]
    }
  ]
}
```

ScriptBox项目文件的框架是固定的，可以根据需要增加buttonGroups及其中的buttons，每个button对应一个操作。
点击菜单栏--项目--编辑，参考下述ScriptBox项目参数解，手动添加项目所需的按钮。

### ScriptBox项目参数说明

#### 一般参数

| 参数           | 说明      | 备注                                                                                                                                                |
| ------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| projectName  | 项目名     |                                                                                                                                                   |
| workDir      | 项目工作文件夹 | 应填写svn根文件夹相对于**ScriptBox**项目文件夹的相对路径，一般将**ScriptBox**项目文件放在branches的scripts文件夹下，则工作文件夹应该为`"../../"`。<br />`"./"`表示工作路径即为**ScriptBox**项目文件夹。<br /> |
| buttonGroups | 按钮组     | 这是一个数组，可以包含多个按钮组                                                                                                                                  |
| groupName    | 按钮组命名   |                                                                                                                                                   |
| buttons      | 按钮      | 这是一个数组，可以包含多个按钮                                                                                                                                   |

#### 按钮参数

| 参数              | 说明     | 备注                                                                                                                                                                        |
| --------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| title           | 按钮文本   | 必须项                                                                                                                                                                       |
| imgPath         | 按钮图标   | 填写相对于项目目录的相对路径，也可以填"default"，为默认的图标                                                                                                                                       |
| scriptType      | 按钮脚本类型 | 必须项，目前支持：<br/>file：打开文件<br/>dir：打开文件夹<br/>cmd：执行一句cmd命令<br/>bat：bat脚本，弹出命令窗口执行。对于有交互的bat脚本，选择这种类型<br/>simpleBat：简单的bat脚本，不弹出命令窗口，直接输出信息<br/>python：python脚本<br/>exe：可执行文件<br/>ps1：powershell脚本 |
| scriptContent   | 脚本内容   | 命令类型为cmd时，scriptContent为命令内容，否则为脚本路径；<br />当为脚本路径时，可以填相对于ScriptBox目录的相对路径，也可填写，相对于项目工作路径的相对路径。                                                                            |
| scriptParameter | 脚本参数   | 可选，对于bat及python脚本，都可以有参数                        

### 编辑脚本工程（Tsy117 贡献）

为了方便更多人使用这个软件，较少入门门槛，添加了界面编辑功能，该功能有一点点Idea + Deepseek + 部分代码整合实现

在原有的编辑项目按键扩展了编辑管理的对话框，左侧是一个项目树，分别对应上面的Project, ButtonGroup, Button层次，右侧是一个内容预览窗口
1. 分别点击树结构就可以看到每一个Item的相关内容。Item是Button时会将一些比较简单的路径使用文件/文件夹来选择
2. 鼠标右键Item有三个选项分别是:
    1. 新建子项: 当Item是Project的时候会新建一个Group, 当Item是Group的时候会新建一个Button,会预设一些内容避免报错
    2. 删除: 目前只对Group和Button有效
    3. 转换路径: 为了Copy别人的工程带来的错误或者工程整体转移位置后不必要的错误，会根据项目位置，转换成相对路径
3. 支持排序，或者跨组排序，方便调整相关组件的位置
4. 为了不妨碍更方便的编辑json提供了文本编辑的功能


### 注意事项

1. ==项目文件中的所有路径必须使用`'/'`，而不能使用`'\'`。
2. 项目文件必须符合JSON格式，如果打开出错，检查`","`、`"{}"`、`"[]"`是否有错。
3. 运行python脚本需要先安装python，推荐应用商店安装python3.9或更新，或官网下载：[https://www.python.org/ftp/python/3.9.0/python-3.9.0-amd64.exe](https://www.python.org/ftp/python/3.9.0/python-3.9.0-amd64.exe)，安装后重启。