This work is licensed under the terms of the following licenses: GNU GPL 2.0-or-later (for the code), CC-BY-SA-4.0 (for the assets); see LICENSE and LICENSE.MEDIA for more details.

Cryptogenie

Cryptogenie is a game about discovering how various ciphers work, and the weaknesses of some of them. Progress through the wonders of cryptology as you discover Caesar, Vigenère, Enigma or RSA ciphers.

Running

The program at cryptogenie takes care of running everything. If Cryptogenie was installed system-wide, it lies in /usr/bin (unless it was installed somewhere else); else, it is located in the src directory of the program, next to the data files.

Thus the program can be run either from the directory src/:

$ ./cryptogenie

or, if installed:

$ cryptogenie

Note: It is not necessary to install Cryptogenie to use it.

Note: If you want a portable installation, for example on a USB stick, you may want to enable the 'single-user-install' setting in src/settings.

Cryptogenie can be run from a command-line, and accepts many options; see

$ ./cryptogenie --help

for more informations on available options.

Be aware that, unless 'single-user-install' is set to "1" in src/settings, Cryptogenie will store its user-specific data in a place that depends on your system:

• on Micro$oft Windows, it lies under %APPDATA%/cryptogenie.
• On other systems, it lies under ~/.cryptogenie if it already exists, else under ~/.local/share/cryptogenie.

Installing

See [INSTALL] for installation instructions. Cryptogenie needs not to be installed to use it.

Testing

The program at src/test is extremely similar to the main one, except that it does not start the GUI and runs in interactive mode. It can thus be used for tests (hence the name). We have to admit it is quite sloppy.

Test files for the processor are available under /src/tests/ (abstract path: /shared/tests/).

Documentation

Documentation for the various units of the program can be found under doc/. The ain documentation is at [doc/main].