andreicozma1/stem

Simple Turing Machine EMulator (STEM)

Inspired by JFLAP and xTuringmachine

Inspired by the design of JFLAP only implementing Turing machines
Compatible with xTuringmachine files

Contributors:

• Andrei Cozma [[email protected]]
• Hunter Price [[email protected]]
• Sam MacLean [[email protected]]
• Joel Kovalcson [[email protected]]
• Dakota Sanders [[email protected]]
• Matt Matto [[email protected]]
• Jonathan Bryan [[email protected]]
• Josh Herman [[email protected]]

Pre-requisites

• Java 9 or greater
• https://www.oracle.com/java/technologies/javase-downloads.html

Build instructions

• This project uses the Maven build system. The configuration is in the pom.xml file.
• You can use the Maven wrapper executable, mvnw which is included with the project.

Install Dependencies

./mvnw validate

Compile Source Code

./mvnw clean compile

Package JAR Executable

• JAR file will be placed at target/STEM.jar

./mvnw install

Execution Instructions

Option 1: Run Executable

cd target
java -jar STEM.jar

Option 2: Run with Maven

./mvnw exec:java

Option 2.1: Compile & Run with Maven

./mvnw clean compile exec:java

License

Simple Turing machine EMulator (STEM)
Copyright (C) 2021 Andrei Cozma, Hunter Price, Sam MacLean, Joel Kovalcson, Dakota Sanders, Matt Matto, Jonathan Bryan

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

stem's Issues

Minimap to show users location in the editor

Implement Options Menu (popup window)

Revamp Main Menu

Remake of the main menu for a more visually appealing look.

Implement Key Shortcuts

Add State(1)
Add Transition (2)
Delete (3)
Edit (4)
Edit Tape (E)
Reset Tape (R)
Run Machine(X)
Save (CTRL+S)
Screenshot (P)

@hunterprice04 Thoughts?

Allow the User to Know How Many Transitions Were Executed on a Given Run

Allow the user to know which state the TM halts on

Make compatible with Java 9+

Update Maven pom file to ensure proper JavaFX versions and Java JRE compilation and target versions.

Add tooltips to all buttons in editor

BUG: clicking new machine then cancelling spawns a machine

Escape button to unselect menubar option

Expand/Collapse States

"One future enhancement I would like your opinion on (not asking you to do this), is the ability to drag over several states and have them gridded into a rectangle or square - like accomplishing VLSI for a TM. There would have to be the ability to click on the compacted grid and expand it back to the original form. "

Perhaps the first step would be to have the ability to simply group states and be able to drag/move the group around. For this, I'm thinking we could have another section in the save-file to define groups and children as key-value pairs. It would probably take a little longer to implement to ensure we're not accidentally breaking any functionality since it would most likely require a redesign of the data structures holding the states.
That would then perhaps allow for better access and control over the states to be able to expand/collapse them into a single special state.

Movable Canvas by Click and Drag

Create a pannable canvas to allow the user to move the location of the states and transitions.

Implement Help Menu (popup window)

Add min and max bounds for editor zooming

Editor should not be able to be zoomed in and out infinitely.
This ticket implements bounds for zooming in and out.

Ability to open multiple windows/projects at the same time

Multiple windows/projects can be open at the same time.
The main menu will stay open to allow for the opening of new windows.

Add icon for application

Toggle scroll bars in option menu

Does not check if machine is fully saved before closing machine

Implement zoomable pane for editor

Remove Unused Options Btn

The options button is not used, therefore we are removing it.

Add background image

Add image for main menu

Implement Persistent Settings

https://stackoverflow.com/questions/32757940/how-to-persiste-or-save-the-javafx-ui-state

Update README for new Maven Build system

Print Canvas Option For Images/PDF

Add names to copyright

Option to print current viewed window

Filename as Title of Window

Fix Maven Resources Path

Bug introduced due to new build system.
Image resource paths need to be fixed since the checkmark button cannot be found and causes a crash.
This ticket fixes the path of the resources.