Skip to content

ishefi/semantle-he

Repository files navigation

Hebrew Semantle

A Hebrew version of Semantle.

Poetry Ruff Checked with mypy License: GPL v3

Installation

Extract word2vec model in repository. you can download one by following the instructions here.

Console

pip install poetry
poetry install

Install mongodb and redis.

Docker Compose

install Docker Compose from here

build the game with:

docker build compose

Configuring databases

populate mongodb with vectors from word2vec model by running populate.py (make sure mongo db is running). select secret word by running set_secret.py (make sure redis and mongo are running).

Running the game

configurations should be set by creating a config.yaml file with the relevant settings (see config.format.yaml). when running with docker compose, every change to configuration requires rebuilding.

Console

You can run the game with:

python app.py

you should run and configure mongo and redis server (see "Configuring Databases" section). Word2Vec model was trained as described here

Docker Compose

run the game with:

docker build up

Scripts

There are some useful scripts in the scripts/ folder:

  • populate.py: Given a Word2Vec model, will populate mongo collection used by the game.
  • set_secret.py: Well...
  • semantle.py: A CLI version of the game.

Tests

Only for some of the logic right now. Sorry.