Skip to content
This repository has been archived by the owner on May 13, 2023. It is now read-only.
/ FabricHDL Public archive

A Verilog synthesis flow for Minecraft redstone circuits

Notifications You must be signed in to change notification settings

MinecraftMachina/FabricHDL

Repository files navigation

Fabric HDL

Fabric HDL is a Fabric 1.18.2 port of the Forge 1.10.2 mod Minecraft HDL. The GUI has been removed in favor of a chat command:

/synth <path_to_netlist_json_file>

Installing

Grab the latest version from the releases and install it like any Fabric mod.

ℹ️ Fabric API is required.

Building

Make sure Java 17 is in your PATH. Then, run:

./gradlew build

The mod will be built under build/libs/.


Minecraft HDL

Minecraft HDL is a digital synthesis flow for minecraft redstone circuits. It is an attempt to use industry standard design tools and methods to generate digital circuits with redstone.

Example:

This file multiplexer4_1.v is a 6 input - 1 output circuit that selects one of the first 4 inputs (a, b, c, d) as the output based on the value of the last 2 inputs (x, y)

module multiplexer4_1 ( a ,b ,c ,d ,x ,y ,dout ); 
 
output dout ; 
input a, b, c, d, x, y; 
 
assign dout = (a & (~x) & (~y)) | 
     (b & (~x) & (y)) |  
     (c & x & (~y)) | 
     (d & x & y); 
endmodule 

When synthesized through Minecraft HDL it produces this circuit:

4to1mux

With the 6 inputs on the right and the single output on the left


Quick Links


About

MHDL_FLOW

MinecraftHDL was the final undergraduate design project made by three students in the Electrical, Computer & Software Engineering department at McGill University.

It is by no means bug-free or even complete; It produces objectively inferior circuits to 'hand-made' redstone designs, and is not intended to be used in modded survival. It can generate almost any verilog circuit, however only simple designs will actually be testable in-game since any moderately-complex design will end up being longer than the maximum number of blocks loaded in Minecraft.

Additionally, we are currently unable to synthesize sequential circuits, aka any circuits with a loopback or feedback. That means no memory, no counters or any circuit that could hold a state.

MinecraftHDL is an educational tool to illustrate on a macro-scopic scale how microelectronic digital circuits are designed and produced. It is a great way to introduce younger audiences to the world of digital design and can also be used to illustrate the difference between software and hardware design to undergraduate engineers taking their first RTL class.

Supervisor: Brett H. Meyer - Website
Students:    Francis O'Brien - Website
                   Omar Ba Mashmos
                   Andrew Penhale

2b7seg

A 2-bit 7-segment display decoder in action (the display itself was not generated by MinecraftHDL)

To show how easy it is to make a circuit with MinecraftHDL here is a gif of me creating a circuit, synthesizing, and generating it in minecraft in less than a minute!

2b7seg

The circuit I generate above is a 2bit adder. It takes two numbers of two bits and adds them. At the end of the gif I set both input numbers to '11' which is the binary representation of the number 3. Then I move to the output and we see that O3=1, O2=1, and O1=0, this gives the binary number '110' which is indeed 6.