EN:Installation

English | 中文版

Installation Guide

This page describes how to install the luatex-cn package.

Method 1: Via CTAN/Package Manager (Recommended)

Install using your TeX distribution's package manager:

# TeX Live (Windows/Linux)
tlmgr install luatex-cn

# MiKTeX
# Open MiKTeX Console → Packages → Search for luatex-cn

⚠️ Note: The CTAN version may lag behind GitHub. We recommend using GitHub Release. When installed via CTAN/package manager, the documentation lands in the texmf doc tree automatically, so texdoc luatex-cn opens the PDF manual out of the box.

Method 2: Manual Installation from GitHub Release

1. Download: Go to GitHub Releases and download the latest luatex-cn-tex-v*.zip

2. Locate texmf directory:

   • Windows: C:\Users\<username>\texmf
   • macOS/Linux: ~/texmf

3. Place files: Put the contents of tex/ into:

   texmf/tex/latex/luatex-cn/
   

4. Refresh database:

   texhash

5. (Optional) Install the PDF manuals: put the contents of doc/ (luatex-cn-wiki-zh.pdf / luatex-cn-wiki-en.pdf, etc.) into:

   texmf/doc/latex/luatex-cn/
   

   After that, texdoc luatex-cn opens the PDF manual directly (the release zip ships doc/ since v0.4.0).

Method 3: Direct Usage

Place the contents of tex/ in the same directory as your .tex file and compile directly.

Verify Installation

Create a test file test.tex:

\documentclass[四库全书]{ltc-guji}
\begin{document}
\begin{正文}
天地玄黄，宇宙洪荒。
\end{正文}
\end{document}

Run:

lualatex test.tex

If compilation succeeds, installation is complete.

System Requirements

• LuaTeX (TeX Live 2024+ recommended)
• luaotfload and fontspec

Font Requirements

We recommend installing these fonts for best results:

• Noto Serif CJK SC (Source Han Serif)
• FangSong or KaiTi (for traditional book effects)