https://github.com/ondoher/enigma

Tools and documentation to help with building and testing an Enigma Machine simulator.
https://github.com/ondoher/enigma

educational-project enigma-machine enigma-simulator simulator

Last synced: 3 days ago
JSON representation

Tools and documentation to help with building and testing an Enigma Machine simulator.

• Host: GitHub
• URL: https://github.com/ondoher/enigma
• Owner: Ondoher
• License: mit
• Created: 2022-12-28T18:37:33.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-15T21:32:09.000Z (about 2 years ago)
• Last Synced: 2025-01-03T20:49:07.643Z (29 days ago)
• Topics: educational-project, enigma-machine, enigma-simulator, simulator
• Language: JavaScript
• Homepage:
• Size: 1.11 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Citation: CITATION.cff

Awesome Lists containing this project

README

        


    



# What's in this toolkit

This toolkit is for anybody who wants to create their own Enigma Machine

simulation. Whether this is a class assignment or a fun side project, this

toolkit should provide the tools necessary to get there.

What you'll find here:

- [documentation](./docs/enigma.md) that gives a brief overview of what the

Enigma is, and some technical details about its operation. Following that is a

detailed breakdown of how to go about writing a simulation and all of the small

details and quirks that will need to be accounted for. And there are many.

- a reference JavaScript implementation of an Enigma simulation and code to

generate test data. There is an [API](./package/README.md) for the simulation

with hooks to observe data as it moves through the system. This is installed as

a node module using npm.

- sample data, both [generated](./test-data/test-messages.json) and

[validated](./test-data/validated-messages.json). The validated messages come in

two forms. The first is real messages that were sent during the war, and the

other is generated messages that have been validated against other simulators.