KOReader自定义书籍背景图片的实现方法

KOReader作为一款优秀的电子书阅读器，提供了丰富的自定义功能。其中，为书籍设置个性化背景图片是一个实用但不太为人所知的功能。本文将详细介绍如何在KOReader中实现书籍级别的背景图片自定义。

背景图片设置的基本原理

KOReader支持通过两种主要方式设置背景图片：

1. 全局设置：修改settings.reader.lua配置文件，添加["cre_background_image"]参数指向图片路径，此设置会应用于所有书籍。

2. 书籍级别设置：通过修改书籍的元数据文件或使用用户补丁实现单本书籍的背景定制。

实现方法一：CSS样式表

最直接的方法是使用CSS样式表来设置背景图片：

1. 将图片转换为Base64编码的数据URI
2. 创建CSS文件并添加以下内容：

body {
  background-image: url("data:image/jpeg;base64,/9j/4AA...");
}

这种方法简单直接，但有两个缺点：

• 需要手动转换图片格式
• 可能会影响标点悬挂效果

实现方法二：用户补丁

更专业的方法是使用Lua用户补丁，这需要创建一个.lua文件放置在KOReader的patch目录下。以下是实现代码示例：

local ReaderRolling = require("apps/reader/modules/readerrolling")
local UIManager = require("ui/uimanager")

local MY_IMAGE = "/path/to/your/image.jpg"

ReaderRolling_orig_addToMainMenu = ReaderRolling.addToMainMenu
ReaderRolling.addToMainMenu = function(self, menu_items)
    ReaderRolling_orig_addToMainMenu(self, menu_items)
    menu_items.toggle_background = {
        sorting_hint = "typeset",
        text = "使用自定义背景图片",
        checked_func = function()
            return self.ui.doc_settings:isTrue("use_my_background_image")
        end,
        callback = function(touchmenu_instance)
            self.ui.doc_settings:flipNilOrFalse("use_my_background_image")
            if self.ui.doc_settings:isTrue("use_my_background_image") then
                self.ui.document:setBackgroundImage(MY_IMAGE)
            else
                self.ui.document:setBackgroundImage()
            end
            UIManager:setDirty(self.view.dialog, "partial")
        end,
    }
end

ReaderRolling_orig_onReadSettings = ReaderRolling.onReadSettings
ReaderRolling.onReadSettings = function(self, ...)
    ReaderRolling_orig_onReadSettings(self, ...)
    if self.ui.doc_settings:isTrue("use_my_background_image") then
        self.ui.document:setBackgroundImage(MY_IMAGE)
    else
        self.ui.document:setBackgroundImage()
    end
end

多背景图片切换实现

如果需要为不同书籍使用不同背景图片，可以扩展上述代码，实现多背景切换功能：

local MY_IMAGE1 = "/path/to/image1.jpg"
local MY_IMAGE2 = "/path/to/image2.jpg"

-- 在addToMainMenu函数中添加多个菜单项
menu_items.toggle_background1 = {
    -- 配置项1
}

menu_items.toggle_background2 = {
    -- 配置项2
}

-- 在onReadSettings中增加判断逻辑
if 使用背景1 then
    -- 设置背景1
elseif 使用背景2 then
    -- 设置背景2
else
    -- 默认背景
end

注意事项

1. 图片路径需要使用绝对路径
2. 建议将图片文件存放在KOReader配置目录下
3. 不同实现方式可能会影响排版效果，特别是标点悬挂功能
4. 使用用户补丁前建议备份原始文件

通过以上方法，用户可以根据个人喜好为不同书籍设置独特的背景图片，提升阅读体验。相比全局设置，书籍级别的背景定制提供了更灵活的选择。