mumuy/relationship

This is a JavaScript library that calculates Chinese kinship terms. In Chinese family culture, every relative has a specific title that depends on which side of the family they are on, how many generations apart they are, and their gender. The rules are intricate enough that many adults get confused when visiting extended family. This library does the calculation for you: you describe the relationship in plain Chinese, and it returns the correct title to use. You can ask it questions in two ways. The first is a structured options object where you provide a relationship path (for example, "mom's mom's brother"), specify your own gender, and choose whether you want to know what you should call that person or what they would call you. The second is a natural-language sentence, like asking "how should my dad's mom address my wife?" and getting back the answer. The library also supports a reverse lookup: give it a title like "表哥" and it will explain the family chain that produces that relationship. Regional differences are built in. Northern and southern China use different words for many of the same relatives, and the library lets you define custom modes to match local conventions. You load a named set of overrides for the terms that differ in your dialect, and the calculator uses those instead of the defaults. The library runs in a browser (via a script tag) or in a Node.js project (via npm install as relationship.js). There is a live demo site where you can try it interactively without writing any code. The source includes a data table that maps relationship chains to titles, and the project wiki explains how the algorithm works for developers who want to understand or extend it.