Skip to content

ZWerduex/wxord

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

45 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Wxord

Presentation

Wxord is a pretty basic application that allows you to create words from a pattern along with three (at the moment) weighted sets of characters.

I have created this application because I'm interested in the concept of creating words from a pattern and I wanted to see if I could create a simple application that could do this. I was highly inspired by the WordGen website and its idea of using a pattern to structure generated words. While I can add some enhancements of my taste, it is also a good way to learn how to use ANTLR4 with Python and how to translate a simple application into multiple languages.

Features

Current features

  • Create words from a pattern
  • Three weighted sets of characters (non configurable via the UI at the moment)
  • Use a generated word as a pattern
  • Copy to clipboard a generated word
  • Language selection (English and French currently available)

Planned features

  • Customizable character sets using the UI
  • Export and import sets of characters (yours or shared ones)
  • Save generated words (like Séodès or Talledra, I like those words)
  • Export saved words to a file
  • A sort of "tutorial" to learn how to use Wxord
  • Add a minimum length for generated words, and I don't know how to achieve this yet :(
  • Create translations directly from the application

Actually, you can change the charset used by tweaking directly the JSON file in the charsets folder. More information about this in the documentation.

Installation

No release has been made yet, so you will have to run the application from sources. You will need Python 3.12.0 to launch Wxord.

Creating a virtual environment is recommended to install requirements.

cd wxord
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt

You're now ready to run the application.

py src/main.py

Documentation

See the documentation for more detailed information about the application.

Issues

Before reporting an issue, see below if it is known. If you find any unknown issue, please report it in the issues tab, and include the log file generated by the application. It is called wxord.log and should be located at the root.

Known issues

No known issues

About

A customisable word generator

Topics

Resources

Stars

Watchers

Forks