Skip to content
/ NES4JAMS Public

NES editor, assembler and emulator for JAMS.

Notifications You must be signed in to change notification settings

gaeqs/NES4JAMS

Repository files navigation

NES4JAMS

A NES editor, assembler and simulator for JAMS.

Image NES4JAMS Image NES4JAMS 2 Image NES4JAMS 3

Introduction

JAMS4NES is a JAMS plugin that extends the editor's capabilities, allowing you to edit, assemble and simulate NES games.

Features

  • Built in Kotlin.
  • Modern design thanks to the JAMS framework.
  • Project-based editor and assembler.
  • Support for several project configurations.
  • Macros.
  • Sprite editor.
  • Cycle-based simulator with several tools to analyze your game.

Dependencies

JAMS is not published in maven central yet. Use the fat jat release as a dependency to use it as a library.

Download and installation

JAMS has been successfully built and Ubuntu 18.04/20.04 and Windows 10/11 using Intellij IDEA.

To compile the plugin inside the IDE use:

git clone https://github.com/gaeqs/NES4JAMS NES4JAMS

# Create a folder named lib/ in the project folder. 
# Add the JAMS fat jar. Name it JAMS.jar

gradle shadowJar

You can use the resulting .jar directly on JAMS.

You can also compile and run JAMS directly using the following gradle command:

# Shadows and runs the command
# java -jar lib/JAMS.jar 
#   -loadPlugin build/libs/NES4JAMS-XX.jar
gradle shadowAndRun

If you require the debugger, use the following gradle command:

gradle shadowAndRunWithDebugger