Skip to content

README.md

Latest commit

 

History

History
118 lines (76 loc) · 3.6 KB

README.md

File metadata and controls

118 lines (76 loc) · 3.6 KB
Raw

OpenccJavaFX

GitHub Release Total Downloads Latest Downloads License: MIT

OpenccJavaFX is a Chinese text conversion application built with JavaFX and the FXML design pattern. It leverages the OpenccJava library to provide simplified and traditional Chinese conversion.

🚀 Download

Download the latest version of OpenccJavaFX for your platform at Release section.

📦 These are Java builds, targeting Java 17+.
You must have Java Runtime 17+ installed to run them.

Features

  • Chinese Conversion: Convert between simplified and traditional Chinese text.
  • Regional Variant Phrases: Taiwan and Hong Kong forward variant conversion applies phrase-level exceptions before character-level variants.
  • Single/Batch Conversion: Perform Chinese text conversion in single or batch mode.
  • Designed to convert most text based file types and Office documents (.docx, .xlsx, .pptx, .odt)

Dependencies

  • JavaFX: Cross-platform Java UI framework.
  • RichTextFX: Text editor for JavaFX with virtualization support.
  • OpenccJava: Pure Java library for conversions between Traditional and Simplified Chinese.
  • picocli: A modern framework for building powerful, user-friendly command line apps with ease.

Getting Started

Clone the repository:

git clone https://github.com/laisuk/OpenccJavaFX.git

Navigate to the project directory:

cd OpenccJavaFX

Build the project:

./gradlew build

Run the application:

./gradlew run

Usage

Single Mode

image01

Support most text base file types.

  1. Paste the text or open a file you wish to convert (file/text drag and drop are supported).
  2. Select the desired conversion configuration (e.g., Simplified to Traditional).
  3. Click the Start button to see the results.

Batch Mode

image02 image03

Support most text base file types, Office documents (.docx, .xlsx, .pptx, .odt, .ods, .odp) and EPUB (.epub).

  1. Select or drag file(s) into the source list box.
  2. Select the desired conversion configuration.
  3. Set the output folder.
  4. Click the Start button to begin batch conversion.

Contributing

Contributions are welcome! Please fork the repository and submit a pull request for any enhancements or bug fixes.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgements

  • OpenCC for the Chinese text conversion lexicon.
  • OpenccJava for the Java Chinese conversion library.
  • JavaFX for the cross-platform UI framework.
  • RichTextFX for the text editor with virtualization.