# lightres

**Repository Path**: Jumping99/lightres

## Basic Information

- **Project Name**: lightres
- **Description**: 在进行应用程序开发时可以使用到的简易资源打包工具，参考windres。
- **Primary Language**: C++
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-06-27
- **Last Updated**: 2025-07-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# lightres

### 介绍
在进行应用程序开发时，不可避免地需要使用一些资源，一些平台具有打包资源的功能。
但在一些小的程序，亦或者在嵌入式开发时，没有找到合适的资源管理工具，因此自己写
了一个轻量化的资源打包工具。可以将多个资源打包成一个文件或者C数组的形式，便于管理。
文件资源描述使用json格式，在json顶层数组中添加资源文件路径(相对json文件的路径)即可。  

应用程序需要读取资源文件中的资源时，可以使用`Release/`目录下的源码进行读取，将源码添加到工程中即可使用。  

对接文件系统时，有三种文件系统API可选:`FatFs`、`posix`和`stdio`，也可以自行对接其他API。  

在目录`lvgl_port`中有对接**lvgl**文件系统的源码，向lvgl注册该驱动可以使lvgl对接资源管理器。
使得lvgl可以直接使用资源管理器中的资源，如：
```c
    lv_img_set_src(img, "A:images/img.jpg");
```


### 安装教程

#### 1.安装所需的依赖
因为此程序用到了nlohmann的json解析，因此需要安装，否则编译会不通过，以ubuntu24.04为例，使用以下命令安装这两个库即可。
```shell
    sudo apt update
    sudo apt install nlohmann-json3-dev 
```

#### 2.安装cmake
项目使用cmake构建，需要安装cmake
#### 3.编译 & 安装
如果上面2步都没问题后，进入源码目录，依次键入以下命令即可安装。
```shell
    mkdir build
    cd build
    cmake ..
    make
    sudo make install
```

### 使用说明

#### 1.帮助信息
加入 **-h** 参数可以查看帮助信息，包括每个参数的说明
```shell
    lightres -h
```
#### 2.打包示例
1. 准备要需要打包的资源。
2. 准备好json描述文件，见example/example.json
3. 使用工具指定输入json文件，进行打包。
4. 若打包成C数组，则随源代码一起编译; 若打包成二进制格式，则可以配合文件系统使用，或其他方式使用。
5. 使用Release/下的源码打开资源包，进行资源读取。

### 更新记录  
#### 2025.06.27-v0.1版本 
第一个版本发布