Skip to content

Latest commit

 

History

History
101 lines (63 loc) · 4.12 KB

README.md

File metadata and controls

101 lines (63 loc) · 4.12 KB
Raw

Processor Emulator

PEMU Logo

Gradle Build

What's this project all about?

One day I woke up and decided to challenge myself. So this project came to life, it's a short story but full of headaches. Don't expect much from this emulator, it's made just for learning purposes.

Does this program create any files on disk?

From version 1.0.0 this program creates one file named PEMU.config in the user's home dir to save all config data.

From version 1.12.0 this program creates a folder named PEMU in the user's home dir to store all program's data.

On version 1.13.0 the config folder was renamed to .pemu.

  • Windows: %USERPROFILE%/.pemu/
  • Linux: $HOME/.pemu/

How to run:

This project is built using Adopt OpenJDK 8, though any newer JRE should be able to run this properly.

There are four main ways to run it:

  1. By downloading the jar file from GitHub Releases.
  2. By opening the project using IntelliJ IDEA and building the project's artifact.
  3. By opening the project using IntelliJ IDEA and creating a new Run Config:
    • Java Version: 1.8 (Adopt OpenJDK)
    • Class Path: PEMU.main
    • Main Class: io.github.marco4413.pemu.Main
  4. By building the source with gradle. Pull the latest version from the repo and run gradlew shadowJar, the jar file should be located in ./build/libs/PEMU-version.jar.

Examples:

PEMU Program Examples can be found in the examples folder.

PEMU Libraries:

Since version 1.10.0 added the #INCLUDE Compiler Instruction (see docs) libraries became possible, so I've made a Standard Library Which is separated into modules (since Memory Management is so important) with all functions that I've found myself rewriting all the time.

You can download the above linked folder and start using it yourself to make your life much easier!

Documentation:

Can be found in the file DOCUMENTATION.md

Plugins:

On version 1.12.0 plugin support was added, and since then you can write your own implementation of a Processor using the Ruby Programming Language (This added support also increased PEMU's size by ~25MB).

On version 1.13.0 Ruby Plugin support was dropped in favour of Native (Java) Plugins.

You can learn more about plugins in the plugins folder.

Utilities:

vscode-pemu-language

There's a VSCode Extension which currently adds Code Check (Through the "Verify PEMU Code" Command), Code Snippets, Syntax Highlighting (For PEMU Docs too!), Icons (Still waiting for VSCode to support extending other themes) and other utilities to be used with the PEMU Programming Language:

Dependencies:

There's only 2 dependencies:

Screenshots:

The Main Window that contains the Debugging Console (the one on the bottom), and the Processor Console (where the processor can print to on the top) and other info/settings:

The Processor Config Panel where you can change your Processor's settings (Clock can be changed while the Processor's running):

The Memory View window where the Processor's Memory is shown to the user, this has also some visual settings: