Skip to main content

Compact command-line conlang manager

Project description

Wer's Compact Conlang Manager, or WCCM, is a simple command-line tool designed to make conlanging ever so slightly faster and easier by converting a simple, customizeable syntax into clean and readable conlang dictionaries.

I built this because spreadsheets had too much visual clutter and other existing tools were really overkill. All you need to do is type your properties with shorthands you can customize, and you'll receive a nicely formatted text file.

For example, this:

Agná 
$agˈna
%noun
#animals
?bird
~Masculine
+ágnaya
;gen :ágnand

Turns into this:

Agná
 \[agˈna] bird, plural: ágnaya
Gender: Masculine
POS: Noun
Semantic field: animals
Cases:
  gen: ágnand

Installation

  1. install Python 3.6 or newer from python.org
  2. download or clone this repository
  3. no additional packages are needed, uses only python standard library!

Usage:

Install it:

pip install wccm

Then you can just use it like this:

wccm file.wccm 

Outputs to Lexicon.txt by default.

Syntax

WCCM uses symbols to represent different properties. Their order is irrelevant, as long as the plain word is always first.

Lexicon

(Lexicon-related syntax goes in .wccm files).

Symbol Field Example
(None) Word Kat
$ IPA $kæt
# Semantic field #animal
~ Gender ~M
? Translation ?Cat
+ Plural form(s) +Cats
; and : Case name / case form ;gen :cat's
= Synonym(s) =feline
! Antonym(s) !dog
% Part of speech %noun
* Etymology ***from 'kaltnaen' **
| and / Conjugations |3rd sg present /does
@ and : Custom @class :animte
_ Comment _ what do I even put here

Inventory

(Inventory-related information goes in .cmi files).

Symbol Field Example
. consonant .tH
, vowel ,3
^ Tone ^rising
- romanization -ñ :ny

Don't like this set of symbols? That's completely fine! You can edit them anytime by going into config.json.

IPA

I know that typing IPA symbols can be tedious if you don't have the tools, which is why I implemented a function to let you map a character to an IPA sound, to make writing transcriptions easier!

Configuration

config.json lets you customize:

  • what each symbol means (which property it represents)
  • IPA character mapping (e.g., : -> ː)
  • default output file
{
    "ipa": {
        "S": "ʃ",
        "T": "θ",
        "R": "ɾ",
        "B": "β",
        "D": "ð",
        "N": "ŋ",
        "J": "ʲ",
        "Z": "ʒ",
        ":": "ː",
        "'": "ˈ",
        "ny": "ɲ",
        "W": "ʷ",
        "H": "ʰ",
        "A": "ɑ",
        "E": "ə",
        "I": "ɪ",
        "3": "ɛ",
        "O": "ɔ",
        "U": "ʊ",
        "^": "ʌ",
        "X": "χ"
    },
    "props": {
        "$": "ipa",
        "#": "field",
        "%": "pos",
        "_": "comment",
        "~": "gender",
        "=": "synonym",
        "!": "antonym",
        "+": "plural",
        "?": "meaning",
        "*": "etymology",
        ";": "case",
        "|": "conjugations",
        "@": "custom"
    },
    "inv":  {
        ".":  "consonant",
        ",": "vowel",
        "^": "tone",
        "-": "romanization"
    },
    "prefs": {
        "output": {
            "defaultFileName": "lexicon",
            "defaultFormat": ".txt"
        }
    }
}

For the IPA replacement mapping, the character on the left is the character that the program will replace. So, essentially, if your IPA is "SaTaZ", with the default configurations (the ones showed above) it would turn into "ʃaθaʒ". You can add/remove as many as you want! (As long as you don't map 1 character to 2 symbols or use digraphs).

Same goes for the properties, although it is very important that you do not alter the keywords, otherwise the tool will break.

As you might've guessed, you can also choose the default name and format of the output file! The name can be anything you want, and the file extension can be either .txt or .md. A lexicon.json file is always automatically generated, which is why .json isn't an option in preferences.

Limitations

Currently, the case symbols (; and :) can't be customized, as well as the conjugation symbols (| and /). If you ever want to remap a symbol, as said before, you're allowed (and encouraged) to do so! However, it is very important that you don't map \ to anything. Since i don't want to confuse you with tech talk, basically, \ is a special character and if you try to use it for mapping the configuration file is going to break.

Other than that, you should be able to change pretty much anything!

About

WCCM started as just a little personal tool I developed because I'm stubborn and don't like any of the tools that already exist, and now I'm sharing it in case someone finds it useful as well.

Feedback is appreciated!

This is my first time actually finishing and sharing a project, so I'd genuinely love to hear suggestions or ideas for future versions, as well as bug reports and other stuff like that. You can contact me pretty much any time in my twitter (I'm not calling it 'X')

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wccm-0.3.0.tar.gz (11.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wccm-0.3.0-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

Details for the file wccm-0.3.0.tar.gz.

File metadata

  • Download URL: wccm-0.3.0.tar.gz
  • Upload date:
  • Size: 11.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for wccm-0.3.0.tar.gz
Algorithm Hash digest
SHA256 989500e4dd19c7cc133b842e0a5e0ee5a8b05ec0575bfdb4ab56e10219577b61
MD5 ee754c51332d6de58cfb31160f90393d
BLAKE2b-256 cbc94c84aadd7827ef34fd47882869d647e6ac68bc99911f52912e7908166102

See more details on using hashes here.

File details

Details for the file wccm-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: wccm-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 10.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for wccm-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e361296f19348989a45ce31c06589d6c1c79efdd759bcab75f1fea75a6454845
MD5 691af89c50c28dd46dc62c07d70f63ad
BLAKE2b-256 682375f615cbe66176bb55c1bc208dc17bfc43ef1e5364f9a74e86d298936666

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page