benvenutti / img2hack

Convert images into hack assembly code

img2hack

This project is a small desktop program that converts image files to Hack assembly files. The assembly file is to be run on a Hack simulator/computer, where the code will output the original image to its screen. For more information on the Hack computer, take a look at nand2tetris.

Since the Hack screen has only two possible values for each pixel, it can basically output binary images to it. So once you load an image to img2hack, the program will give you the possibility to fine-tune the conversion from non-binary to binary image over a graphical user interface.

Watch this video to see img2hack in action! 📺

...and if you want to assemble the generated code into a Hack binary you can also use my assembler.

Building img2hack from source

The following list enumerates the tools and dependencies' minimum requirements:

• C++11 compiler
• CMake 3.2
• Magick++ 7.0
• Qt5 Widgets

Configuring and Compiling

Run cmake to configure the native tools (preferably an out of source configuration) and then run the build. Here is an example in Linux:

img2hack$ mkdir build
img2hack$ cd build
img2hack/build$ cmake ..
img2hack/build$ cmake --build .

img2hack's Issues

Garbage is displayed when image is smaller than screen

When the image is smaller than the Hack screen the image is force cropped to the screen size, which results in garbage being displayed. Issue #10 should take small images into account too.

Enable drag image around canvas

When an image bigger than 512 x 256 (the Hack screen size) is loaded, the image is trimmed to these dimensions and it snaps to reference position p(0, 0). This feature aims to enable the user to drag the image around the canvas in such a way that he/she can position the image at will before generating the assembly code.

• update cursor icon when the image can be dragged
• maybe show offset information

Update README

Update README file with proper markdown syntax and styling:

• add GPL license badge
• Travis CI build status badge
• add information regarding building the project
• dependencies list

Update to C++14

Is it possible to bump C++ version to 14?

Create CMake project

Create a (modern) CMake project for img2hack and drop everything related to QtCreator IDE. An initial monolithic approach is fine for now.

Add multi language support

Right now the application is all in English. Add support to Portuguese (and German? ...hm, warum nicht?).

Create Travis CI project

Create a CI project with the following minimal configuration:

• Linux: clang and gcc
• OSX: clang (xcode)

This depends on #1.

Optimize size of assembly output

What could be done to optimize the size of the assembly output? Remember, the hack machine has a pretty restricted memory size...

Separate img2hack from GUI

Separate the project into modules:

• img2hack: module to transform images into hack assembly
• app: holds the GUI executable that depends/uses img2hack

The main concern here is to make sure img2hack is completely independent of the GUI.

GUI images and icons are not displayed

The images and icons of the GUI are not being displayed. Probably the resources must be included in the CMake project using qt5_add_resources (more info here).

This issue started after #1.

Add Windows build on Appveyor

Create a Windows CI plan on Appveyor. Looks like using vcpkg is the way to go to get Qt and ImageMagick.

Version number on about dialog should update dynamically

The version displayed on the about dialog is hard coded in the dialog's form. Create a config file in CMake to expose the project version to the source files.

Add clang-format file

Define style and add clang-format file.

Refactor modernize code

Refactor and modernize C++11 style. Maybe bump to C++14?

Redesign GUI

Refactor/redesign the GUI, making sure it looks nice on OSX and Linux (and in the future, Windows?).

This should be done after #5 and #6.