Word Weaver

Your complete toolbox for creating conlangs.

Features

• Phonology: Define your conlang's phonology.
• Grammar: Define your conlang's grammar.
• Word Generator: Generate words in your conlang based on your grammar and phonology.
• Dictionary: Create and manage your conlang's lexicon.
• Sound Change Applier: Apply sound changes to words in your conlang.
• Orthography: Define your conlang's orthography.
• Text: Write and translate text in your conlang.
• Export: Export your conlang's data to a variety of formats.

Installation

Download the latest release from the releases page and run the installer. Open the application by searching for "Word Weaver" in the start menu or library.

Development

As an open-source project, we depend on the community for feedback such as bug reports and feature requests, as well as contributions such as code and documentation. If you would like to contribute, please follow the instructions below for setting up the development environment. If you only plan on writing documentation, you can skip the packaging step.

Prerequisites

• Python
• This repository

Setup

Clone the repository and install the dependencies with pip:

git clone https://github.com/PrestonHager/Wordweaver.git
cd Wordweaver
# Create a virtual environment and activate it
python -m venv .venv
source .venv/bin/activate   # or .venv\Scripts\activate on Windows
python -m pip install -r requirements.txt

If you don't want to work in a virtual environment, you can install the dependencies globally:

python -m pip install -r requirements.txt

Running and Testing

To run the application, use the main.py file:

python src/main.py

To run the tests, use the unittest module. For example, to run the tests in the test directory:

python -m unittest discover test

To lint the code, use pylint. It may need to be installed using pip install pylint if it is not already installed. Activate it using the following:

pylint --rcfile=pylintrc src

To build the documentation use the sphinx-build command as follows:

sphinx-build -b html docs docs/_build

Packaging

To package the application, use the pyinstaller module.

python -m PyInstaller Wordweaver.spec

The packaged application will be in the dist directory. You can then use the built binary to run the application.

When releasing new versions, update the version number in the VERSION file. The src/VERSION file is used only when running the application from source. The VERSION file is used when packaging the application with PyInstaller.

To build an installer will depend on your operating system. You must run the appropriate command for your system:

Windows

Instructions coming soon!

macOS

Instructions coming soon!

Linux

Instructions coming soon!