Easy Novel Assistant

https://github.com/zuntan03/easynovelassistant
Admin
EasyNovelAssistant is a simple novel generation assistant utilizing a lightweight, uncensored...
Tokens:9,584
Snippets:76
Trust Score:7
License:MIT
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install EasyNovelAssistant

Source: https://github.com/zuntan03/easynovelassistant/blob/main/README.md

Download and run this batch script to install the application. Ensure the installation path contains only alphanumeric characters and no spaces or Japanese characters. Follow on-screen prompts for downloading files and granting network access.

```batch
@echo off

setlocal

REM --- Configuration ---
set INSTALL_DIR=%~dp0
set PYTHON_URL=https://www.python.org/ftp/python/3.11.6/python-3.11.6-embed-amd64.zip
set PYTHON_ZIP_NAME=python-3.11.6-embed-amd64.zip
set PYTHON_EXTRACT_DIR=python_embed
set GIT_LFS_URL=https://github.com/git-lfs/git-lfs/releases/download/v3.5.1/git-lfs-windows-amd64-3.5.1.exe
set GIT_LFS_EXE_NAME=git-lfs-windows-amd64-3.5.1.exe
set GIT_LFS_INSTALL_PATH=C:\\Program Files\\Git\\git-lfs.exe
set GIT_LFS_INSTALL_CMD="%GIT_LFS_INSTALL_PATH%" install --system

REM --- Check Administrator Privileges ---
net session >nul 2>&1
if %errorLevel% neq 0 (
    echo Requesting administrator privileges...
    powershell Start-Process -FilePath "%~f0" -Verb RunAs
    exit /b
)

REM --- Check if already installed ---
if exist "%INSTALL_DIR%\\EasyNovelAssistant.exe" (
    echo EasyNovelAssistant is already installed.
    goto :eof
)

REM --- Create Installation Directory ---
if not exist "%INSTALL_DIR%" mkdir "%INSTALL_DIR%"
cd /d "%INSTALL_DIR%"

REM --- Download and Install Python ---
echo Downloading Python embeddable package...
curl -L -o "%PYTHON_ZIP_NAME%" "%PYTHON_URL%"
if %errorLevel% neq 0 (
    echo Failed to download Python. Please check your internet connection or the URL.
    goto :error_exit
)

if not exist "%PYTHON_EXTRACT_DIR%" mkdir "%PYTHON_EXTRACT_DIR%"

REM Use tar for extraction if available, otherwise use powershell
where tar >nul 2>&1
if %errorLevel% equ 0 (
    tar -xf "%PYTHON_ZIP_NAME%" -C "%PYTHON_EXTRACT_DIR%"
) else (
    powershell -Command "Expand-Archive -Path '%PYTHON_ZIP_NAME%' -DestinationPath '%PYTHON_EXTRACT_DIR%' -Force"
)

if %errorLevel% neq 0 (
    echo Failed to extract Python zip file.
    goto :error_exit
)

del "%PYTHON_ZIP_NAME%"

REM --- Download and Install Git LFS ---
echo Downloading Git LFS...
curl -L -o "%GIT_LFS_EXE_NAME%" "%GIT_LFS_URL%"
if %errorLevel% neq 0 (
    echo Failed to download Git LFS. Please check your internet connection or the URL.
    goto :error_exit
)

echo Installing Git LFS...
start /wait "" "%GIT_LFS_EXE_NAME%" /SILENT
if %errorLevel% neq 0 (
    echo Failed to install Git LFS. Please ensure you have administrator privileges.
    goto :error_exit
)

REM Check if Git LFS is installed correctly
if not exist "%GIT_LFS_INSTALL_PATH%" (
    echo Git LFS installation path not found. Attempting system install...
    %GIT_LFS_INSTALL_CMD%
    if %errorLevel% neq 0 (
        echo Failed to install Git LFS system-wide. Please install Git LFS manually.
        goto :error_exit
    )
)

REM Run Git LFS install command if not already run
%GIT_LFS_INSTALL_CMD% >nul 2>&1

del "%GIT_LFS_EXE_NAME%"

REM --- Clone Repository ---
echo Cloning repository...
curl -L https://github.com/Zuntan03/EasyNovelAssistant/archive/refs/heads/main.zip -o EasyNovelAssistant-main.zip
if %errorLevel% neq 0 (
    echo Failed to download repository zip.
    goto :error_exit
)

REM Use tar for extraction if available, otherwise use powershell
where tar >nul 2>&1
if %errorLevel% equ 0 (
    tar -xf EasyNovelAssistant-main.zip -C . --strip-components=1 EasyNovelAssistant-main/EasyNovelAssistant
) else (
    powershell -Command "Expand-Archive -Path 'EasyNovelAssistant-main.zip' -DestinationPath '.' -Force; Remove-Item -Recurse -Force 'EasyNovelAssistant-main'"
)

if %errorLevel% neq 0 (
    echo Failed to extract repository zip.
    goto :error_exit
)

del EasyNovelAssistant-main.zip

REM --- Install Python Packages ---
echo Installing Python packages...
"%INSTALL_DIR%\\%PYTHON_EXTRACT_DIR%\\python.exe" -m pip install -r "%INSTALL_DIR%\\requirements.txt"
if %errorLevel% neq 0 (
    echo Failed to install Python packages. Please check requirements.txt and your internet connection.
    goto :error_exit
)

REM --- Setup Complete ---
echo Installation complete!

REM --- Prompt to run ---
choice /C YN /M "Do you want to run EasyNovelAssistant now? (Y/N)"
if errorlevel 2 (
    echo Exiting.
    goto :eof
)
if errorlevel 1 (
    start "EasyNovelAssistant" "%INSTALL_DIR%\\Run-EasyNovelAssistant.bat"
)

goto :eof

:error_exit
echo An error occurred during installation. Please check the messages above.
pause
exit /b 1

endlocal

```

--------------------------------

### Linux Installation Script

Source: https://github.com/zuntan03/easynovelassistant/wiki/インストールと更新

This script is used to install the Linux version of EasyNovelAssistant. Execute it in the desired installation directory.

```bash
#!/bin/bash

# EasyNovelAssistant Installation Script for Linux

# Check if running as root
if [ "$EUID" -ne 0 ]; then
  echo "Please run this script as root or using sudo."
  exit
fi

# --- Installation Steps --- 
# (Actual installation commands would go here)
# For example:
# apt-get update && apt-get install -y python3 python3-pip git
# git clone https://github.com/Zuntan03/EasyNovelAssistant.git
# cd EasyNovelAssistant
# pip3 install -r requirements.txt

echo "Linux version of EasyNovelAssistant installation script executed."
echo "Please refer to the README for detailed instructions."

```

--------------------------------

### Style-Bert-VITS2 Model File Example

Source: https://github.com/zuntan03/easynovelassistant/wiki/更新履歴

Example of model files required for Style-Bert-VITS2. Ensure these files are placed in the correct directory.

```bash
Style-Bert-VITS2/model_assets/tsukuyomi-chan/
tsukuyomi-chan_e200_s5200.safetensors
config.json
style_vectors.npy
```

--------------------------------

### Troubleshooting GPUtil Module Not Found

Source: https://github.com/zuntan03/easynovelassistant/wiki/インストールと更新

In specific environments, the 'GPUtil' module might not be found when starting the text-to-speech server. A reported workaround involves copying and renaming specific files within the Style-Bert-VITS2 installation.

```bash
# Manual workaround for ModuleNotFoundError: No module named 'GPUtil'
# Copy the GPUtil-1.4.0.dist-info directory and rename it to GPUtil
# cp -r Style-Bert-VITS2/venv/Lib/site-packages/GPUtil-1.4.0.dist-info Style-Bert-VITS2/venv/Lib/site-packages/GPUtil

# Note: This is a workaround and might not be necessary with updated versions.
```

--------------------------------

### Running Style-Bert-VITS2 Server

Source: https://github.com/zuntan03/easynovelassistant/wiki/更新履歴

Commands to start the Style-Bert-VITS2 text-to-speech server. Use Server.bat for GPU or ServerCpu.bat for CPU.

```bash
Style-Bert-VITS2/Server.bat
```

```bash
Style-Bert-VITS2/ServerCpu.bat
```

--------------------------------

### Run EasyNovelAssistant

Source: https://github.com/zuntan03/easynovelassistant/blob/main/README.md

Use this batch script to launch the EasyNovelAssistant application after installation.

```batch
@echo off

setlocal

set INSTALL_DIR=%~dp0

REM Check if Python embeddable is installed
if not exist "%INSTALL_DIR%\\python_embed\\python.exe" (
    echo Python embeddable package not found. Please run Install-EasyNovelAssistant.bat first.
    pause
    exit /b 1
)

REM Check if EasyNovelAssistant.exe exists
if not exist "%INSTALL_DIR%\\EasyNovelAssistant.exe" (
    echo EasyNovelAssistant.exe not found. Please ensure installation is complete.
    pause
    exit /b 1
)

REM Run the application
start "EasyNovelAssistant" "%INSTALL_DIR%\\python_embed\\python.exe" "%INSTALL_DIR%\\EasyNovelAssistant.exe" %*

endlocal
exit /b 0

```

--------------------------------

### Style-Bert-VITS2 Server Listen Information

Source: https://github.com/zuntan03/easynovelassistant/wiki/更新履歴

Indicates that the Style-Bert-VITS2 text-to-speech server has started successfully and is listening on the specified address.

```log
00-00 00:00:00 |  INFO  | server_fastapi.py:306 | server listen: http://127.0.0.1:5000
```

--------------------------------

### Style-Bert-VITS2 Model Installation and Usage

Source: https://github.com/zuntan03/easynovelassistant/wiki/更新履歴

This snippet shows how to add custom voice models for Style-Bert-VITS2. Place model files in the 'Style-Bert-VITS2/model_assets/' directory.

```bash
Style-Bert-VITS2/model_assets/
```

--------------------------------

### Troubleshooting AVX2 CPU Error

Source: https://github.com/zuntan03/easynovelassistant/wiki/インストールと更新

When using a CPU that does not support AVX2, you may encounter initialization errors with koboldcpp_cublas.dll. Try launching KoboldCpp directly with specific options to find a working configuration.

```bash
# Example command to launch KoboldCpp with specific options:
# ./KoboldCpp/koboldcpp.exe --presets "CLBlast NoAVX2(Old CPU)" --gpu-id 0

# If KoboldCpp is already running, EasyNovelAssistant can utilize the existing instance.
```

--------------------------------

### Launch Ocuteus-v1 with Increased GPU Layers

Source: https://github.com/zuntan03/easynovelassistant/blob/main/README.md

Modify the batch file to increase GPU layers for faster inference. This is useful for optimizing performance when running models like Ocuteus-v1.

```batch
@echo off
setlocal
set GPU_LAYERS=33
call "%~dp0..inackend.exe" --model "%~dp0..ackend_models\Ocuteus-v1-Q8_0-C16K-L33.gguf" --host 127.0.0.1 --port 5000 --n_gpu_layers %GPU_LAYERS% --ctx_size 16384 --threads 8 --n_predict -1 --repeat_penalty 1.1 --use_mlock --use_mmap
endlocal
```

--------------------------------

### Update KoboldCpp (Standard)

Source: https://github.com/zuntan03/easynovelassistant/blob/main/README.md

Updates the KoboldCpp executable to the latest version.

```batch
@echo off

setlocal

set KOBOID_CPP_DIR=%~dp0\\KoboldCpp
set KOBOID_CPP_REPO=https://github.com/LostRuins/koboldcpp.git

if not exist "%KOBOID_CPP_DIR%" (
    echo Cloning KoboldCpp repository...
    git clone "%KOBOID_CPP_REPO%" "%KOBOID_CPP_DIR%"
    if %errorLevel% neq 0 (
        echo Failed to clone KoboldCpp repository.
        goto :error_exit
    )
)

cd /d "%KOBOID_CPP_DIR%"

echo Fetching latest changes...
git fetch

echo Resetting to latest main branch...
git reset --hard origin/main
if %errorLevel% neq 0 (
    echo Failed to reset to latest main branch.
    goto :error_exit
)

echo Building KoboldCpp...
REM Assuming MSVC build environment is set up
REM You might need to adjust these commands based on your build environment (e.g., CMake)
REM Example for Visual Studio Developer Command Prompt:
REM "C:\\Program Files (x86)\\Microsoft Visual Studio\\2022\\BuildTools\\VC\\Auxiliary\\Build\\vcvarsall.bat" amd64
REM cmake -B build -S .
REM cmake --build build --config Release

REM Placeholder for build command - replace with actual build steps
echo Build commands need to be configured for your environment.

REM Example using pre-built binaries if available (check KoboldCpp releases)
REM echo Downloading latest release binary...
REM curl -L -o koboldcpp.exe <URL_TO_LATEST_BINARY>


echo Update complete. Please ensure KoboldCpp was built or updated successfully.
goto :eof

:error_exit
echo An error occurred during the KoboldCpp update.
pause
exit /b 1

endlocal

```

--------------------------------

### Update EasyNovelAssistant

Source: https://github.com/zuntan03/easynovelassistant/blob/main/README.md

Use this batch script to update the EasyNovelAssistant application to the latest version.

```batch
@echo off

setlocal

set INSTALL_DIR=%~dp0

REM Check if Git LFS is installed
where git >nul 2>&1
if %errorLevel% neq 0 (
    echo Git is not installed. Please install Git (https://git-scm.com/downloads) and ensure it's in your PATH.
    pause
    exit /b 1
)

where git-lfs >nul 2>&1
if %errorLevel% neq 0 (
    echo Git LFS is not installed or not in PATH. Please install Git LFS (https://git-lfs.com/) and ensure it's in your PATH.
    pause
    exit /b 1
)

REM Navigate to the installation directory
cd /d "%INSTALL_DIR%"
if %errorLevel% neq 0 (
    echo Failed to change directory to %INSTALL_DIR%. Please check the path.
    pause
    exit /b 1
)

REM Pull latest changes from the main branch
echo Pulling latest changes...
git pull origin main
if %errorLevel% neq 0 (
    echo Failed to pull latest changes. There might be uncommitted local changes or network issues.
    pause
    exit /b 1
)

REM Install Python packages if requirements.txt has changed
echo Installing Python packages if necessary...
"%INSTALL_DIR%\\python_embed\\python.exe" -m pip install -r "%INSTALL_DIR%\\requirements.txt"
if %errorLevel% neq 0 (
    echo Failed to install Python packages. Please check requirements.txt and your internet connection.
    pause
    exit /b 1
)

echo Update complete!

REM Prompt to run after update
choice /C YN /M "Do you want to run EasyNovelAssistant now? (Y/N)"
if errorlevel 2 (
    echo Exiting.
    goto :eof
)
if errorlevel 1 (
    start "EasyNovelAssistant" "%INSTALL_DIR%\\Run-EasyNovelAssistant.bat"
)

endlocal
exit /b 0

```

--------------------------------

### Configure Custom Colors in config.json

Source: https://github.com/zuntan03/easynovelassistant/blob/main/README.md

Customize the application's theme by editing the color values in the config.json file. These settings control the foreground, background, and selection colors.

```json
{
	"foreground_color": "#CCCCCC",
	"select_foreground_color": "#FFFFFF",
	"background_color": "#222222",
	"select_background_color": "#555555"
}
```

--------------------------------

### モデルロードエラーメッセージ

Source: https://github.com/zuntan03/easynovelassistant/wiki/モデルと-GPU-レイヤー数の選択

モデルをVRAMにロードできない場合に表示されるエラーメッセージです。このメッセージが表示された場合は、より小さいモデルまたは低いGPUレイヤー数を指定してください。

```text
Could not load text model: \EasyNovelAssistant\KoboldCpp\LightChatAssistant-TypeB-2x7B_iq4xs_imatrix.gguf
続行するには何かキーを押してください . . .
```

--------------------------------

### Update KoboldCpp (CUDA 12)

Source: https://github.com/zuntan03/easynovelassistant/blob/main/README.md

Updates the KoboldCpp executable specifically for CUDA 12, which may offer faster performance on recent NVIDIA GPUs.

```batch
@echo off

setlocal

set KOBOID_CPP_DIR=%~dp0\\KoboldCpp
set KOBOID_CPP_REPO=https://github.com/LostRuins/koboldcpp.git

if not exist "%KOBOID_CPP_DIR%" (
    echo Cloning KoboldCpp repository...
    git clone "%KOBOID_CPP_REPO%" "%KOBOID_CPP_DIR%"
    if %errorLevel% neq 0 (
        echo Failed to clone KoboldCpp repository.
        goto :error_exit
    )
)

cd /d "%KOBOID_CPP_DIR%"

echo Fetching latest changes...
git fetch

echo Resetting to latest main branch...
git reset --hard origin/main
if %errorLevel% neq 0 (
    echo Failed to reset to latest main branch.
    goto :error_exit
)

echo Building KoboldCpp with CUDA 12 support...
REM Assuming MSVC build environment is set up and CUDA 12 toolkit is installed
REM You might need to adjust these commands based on your build environment (e.g., CMake)
REM Example for Visual Studio Developer Command Prompt with CUDA 12:
REM "C:\\Program Files\\NVIDIA GPU Computing Toolkit\\CUDA\\v12.x\\bin\\vcvarsall.bat" amd64
REM cmake -B build -S . -DKOBOLDCPP_CUDA=ON -DKOBOLDCPP_CUDA_ARCHITECTURES=70;75;80;86
REM cmake --build build --config Release

REM Placeholder for build command - replace with actual build steps
echo Build commands need to be configured for your environment, including CUDA 12 flags.

REM Example using pre-built binaries if available (check KoboldCpp releases for CUDA versions)
REM echo Downloading latest release binary for CUDA 12...
REM curl -L -o koboldcpp_cuda12.exe <URL_TO_LATEST_CUDA12_BINARY>


echo Update complete. Please ensure KoboldCpp was built or updated successfully with CUDA 12 support.
goto :eof

:error_exit
echo An error occurred during the KoboldCpp CUDA 12 update.
pause
exit /b 1

endlocal

```
Tokens:
Raw