This project is an implementation of the LC-3 Virtual Machine (VM) in Rust.
The LC-3 is a simple educational computer designed to teach the basics of computer architecture and machine language programming.
| Instruction | OpCode | Description | Implemented |
|---|---|---|---|
| BR | 0000 | Performs a conditional branch based on the condition flags. | ✅ |
| ADD | 0001 | Adds two values. Can use immediate mode or register mode. | ✅ |
| LD | 0010 | Loads a value from a memory address into a register. | ✅ |
| ST | 0011 | Stores the value of a register into a memory address. | ✅ |
| JSR | 0100 | Jumps to a subroutine and saves the return address. | ✅ |
| AND | 0101 | Performs a bitwise AND operation between two registers. | ✅ |
| LDR | 0110 | Loads a value from a memory address calculated based on a register. | ✅ |
| STR | 0111 | Stores the value of a register into a calculated memory address. | ✅ |
| RTI | 1000 | Unused. | ✅ |
| NOT | 1001 | Performs a bitwise NOT operation on a register. | ✅ |
| LDI | 1010 | Loads a value from an indirect memory address into a register. | ✅ |
| STI | 1011 | Stores the value of a register into an indirect memory address. | ✅ |
| JMP | 1100 | Jumps to the address contained in a register. | ✅ |
| RES | 1101 | Unused. | ✅ |
| LEA | 1110 | Loads the effective address into a register. | ✅ |
| TRAP | 1111 | Invokes an operating system routine. | ✅ |
You can play two games that are implemented with this VM: 2048 and rogue.
To play the 2048 game, use the following command:
cargo run examples/2048.objThe output should look like this:
Control the game using WASD keys.
Are you on an ANSI terminal (y/n)?
y
+--------------------------+
| |
| |
| |
| 2 |
| |
| 2 |
| |
| |
| |
+--------------------------+
Note
You need to press Enter before typing y or n and press Enter again to start playing.
To play the rogue game, use the following command:
cargo run examples/rogue.objThe output should look like this:
Welcome to LC3 Rogue.
Use WSAD to move.
Press any key..
And then you can start playing the game.
################## ############
################### ########
####################### #
######################## # #
###############################D
################################
################################
@ ##############################
# #############################
## ##########################
##### #########################
###### ########################
####### ######################
######### ###################
############ ## ##############
############# #############
To run the tests, use the following command:
cargo testTo format the code, use the following command:
cargo fmtThis project is based on the following articles and resources: