Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lmantw/lightbery

一個基於 Pixiv 的圖庫系統
https://github.com/lmantw/lightbery

Last synced: 18 days ago
JSON representation

一個基於 Pixiv 的圖庫系統

Awesome Lists containing this project

README 

        
# Lightbery

> Lightbery (Library 的諧音，~~我喜歡給我每個專案都加上一個 Light~~) 是一個基於 Pixiv 的圖庫系統，它擁有內建的 CLI 介面來管理圖庫，也有內建的網頁 APP 來瀏覽圖庫。



## 範例

```js

const { Lightbery, Plugins } = require('./Lightbery/API')    //導入 Lightbery 與 Plugins



let myLightbery = new Lightbery(`${__dirname}/My Lightbery`) //加載一個 Lightbery

myLightbery.addPlugin(Plugins.LightberyCLI)                  //添加插件 LightberyCLI (命令行介面)

```



# 目錄

* [Lightbery](#lightbery-1)

  * [size](#size)

  * [addPlugin(Plugin)](#addplugin)

  * [getImageInfo(imageID)](#getimageinfo)

  * [getImageData(imageID)](#getimagedata)

  * [search(query, type)](#search)

  * [add(imageID)](#add)

  * [checkImagesData(images)](#checkimagesdata)

  * [checkRepeatImages()](#checkrepeatimages)

* [內建插件](#內建插件)

   * [LightberyCLI](#lightberycli)

   * [LightberyWeb](#lightberyweb)

   * [LightberySync](#lightberysync)

* [資料格式](#資料格式)

  * [圖片資訊](#圖片資訊)

  * [圖片資料](#圖片資料)



# Lightbery

```js

new Lightbery(path, options) //加載一個 Lightbery

```

* `path `｜Lightbery 所在的路徑

* `options `｜Lightbery 的選項

  * `safetyMode `｜是否要隨時儲存資料，這可以確保 Lightbery 在崩潰的時候仍然可以保存所有資料，但效能可能會降低 `預設為: false`

  * `networkThread `｜網路的線程數 `預設為: 5`

  * `workerThread `｜Worker 的線程數 `預設為: 該設備的線程數`

  

> [!NOTE]

> 如果你要創建一個新的 Lightbery，只需要創建一個新的資料夾，然後將 path 設為該資料夾的路徑即可，Lightbery 會自動幫你生成所有的檔案。



## size

```js

.size //取得圖庫的大小 (圖片數)

```



## addPlugin()

```js

.addPlugin(Plugin, options) //添加插件        

```

* `Plugin `｜一個插件的 

* `options `｜插件的選項



> 返回 Plugin



## getImageInfo()

```js

await .getImageInfo(imageID) //取得圖片的資訊

```

* `imageID ` //圖片的 ID



> 返回 [圖片資訊](#圖片資訊)



## getImageData()

```js

await .getImageData(imageID) //取得圖片的資料 (如圖片儲存路徑, 圖片 buffer 等)

```

* `imageID ` //圖片的 ID



> 返回 [圖片資料](#圖片資料)



## search()

```js

.search(query, type) //搜尋圖片

```

* `query `｜搜尋的關鍵字 (一個包含關鍵字的陣列)

* `type `｜搜尋的類型 (title, author, tags)



> 返回一個包含所有搜尋到的圖片的ID的陣列



## add()

```js

await .add(imageID) //添加圖片

```

* `imageID `｜圖片的 ID



> [!NOTE]

> Lightbery 只能儲存單張圖片，如果你讓它下載一個包含多頁的 Pixiv 插畫，他只會下載第一張。



> 當在添加圖片的時候發生錯誤，他會返回 { error: true, content:  }，如果沒有發生錯誤則會返回 { error: false }



## checkImagesData()

```js

await .checkImagesData(images) //檢查圖片的資料

```

* `images `｜要檢查的圖片 (一個包含圖片 ID 的陣列)



> 返回 ``



## checkRepeatImages()

```js

await .checkRepeatImages() //檢查是否有重複的圖片

```



> 返回 ``



> [!NOTE]

> 在第一次進行重複圖片檢查的時後可能會花費較長的時間，因為它需要創建所有圖片的像素資料。



# 內建插件



## LightberyCLI

內建的命令行介面，你可以用它來新增, 檢查, 移除圖片

```js

const { Lightbery, Plugins } = require('./Lightbery/API')    //導入 Lightbery 與 Plugins



let myLightbery = new Lightbery(`${__dirname}/My Lightbery`) //加載一個 Lightbery

myLightbery.addPlugin(Plugins.LightberyCLI)                  //添加插件 LightberyCLI (命令行介面)

```



## LightberyWeb

內建的網頁圖片瀏覽器，你可以用它來瀏覽, 搜尋圖片

```js

const { Lightbery, Plugins } = require('./Lightbery/API')    //導入 Lightbery 與 Plugins



let myLightbery = new Lightbery(`${__dirname}/My Lightbery`) //加載一個 Lightbery

myLightbery.addPlugin(Plugins.LightberyWeb, )       //添加插件 LightberyWeb (網頁圖片瀏覽器)

```

* `options `｜LightberyWeb 的選項

  * `port `｜網頁瀏覽器使用的端口 `預設為: 8080`



## LightberySync

內建的 Lightbery 同步器，讓你可以在不同設備之間簡單的同步 Lightbery

```js

const { Lightbery, Plugins } = require('./Lightbery/API')                 //導入 Lightbery 與 Plugins



let myLightbery = new Lightbery(`${__dirname}/My Lightbery`)              //加載一個 Lightbery

myLightbery.addPlugin(Plugins.LightberyCLI)                               //可與 LightberyCLI 做搭配使用 (必須先添加)

let lightberySync myLightbery.addPlugin(Plugins.LightberySync, ) //添加插件 LightberySync (Lightbery 同步器)

```

* `options `｜LightberySync 的選項

  * `port `｜Socket 使用的端口 `預設為: 3000`



### connect

```js

await .connect(url) //連接至其他 Lightbery

```

* `url `｜Socket 的網址



> 當在連線的時候發生錯誤，他會返回 { error: true, content:  }，如果沒有發生錯誤則會返回 { error: false }



### merge

```js

await .merge() //合併 Lightbery

```



> 當在合併的時候發生錯誤，他會返回 { error: true, content:  }，如果沒有發生錯誤則會返回 { error: false }



### replace

```js

await .replace() //替換 Lightbery

```



> 當在替換的時候發生錯誤，他會返回 { error: true, content:  }，如果沒有發生錯誤則會返回 { error: false }



### disconnect

```js

.disconnect() //關閉連接

```



> 返回 ``



# 資料格式



## 圖片資訊

```js

{

  id: , //圖片的 ID

  url: , //圖片的下載網址

  width: , //圖片的寬度

  height: , //圖片的高度

  title: , //圖片的標題

  description: , //圖片的描述

  tags: , //圖片的標籤

  author: {

    id: , //作者的 ID

    name:  //作者的名稱

  },

  ai:  //圖片是否為 AI 創作

}

```



## 圖片資料

```js

{

  imagePath: , //圖片的儲存路徑

  width: , //圖片的寬度

  height: , //圖片的高度

  data:  //圖片的 buffer

}

```