Skip to content

Latest commit

 

History

History
75 lines (48 loc) · 3.58 KB

compilation.md

File metadata and controls

75 lines (48 loc) · 3.58 KB
Raw

Compilation

All JT arcade cores depend on JTFRAME for compilation:

Prerequisites

  • Ubuntu 20.04
  • Install Quartus 13.1 to compile for MiST, SiDi and the Pocket in /opt/altera/13.1
  • Install Quartus 17 or higher to compile for MiSTer in /opt/intelFPGA_lite
  • Run the jotego_20.04.sh script to get other required packages in place

For parallel compilation across network machines, create a file $HOME/.parallel/sshloginfile with one host name per line. Configure SSH correctly across the machines, using ssh-copy-id, etc.

JTFRAME uses a submodule to give support to the Analogue Pocket target. This submodule is not open source and you will get an error if you try to initialize it. You can safely ignore this submodule, it is only needed to create Pocket files.

Quick Steps

These are the minimum compilation steps, using Pirate Ship Higemaru as the example core

> git clone --recursive https://github.com/jotego/jtgng
> cd jtgng
> source setprj.sh
> cd $JTFRAME/cc && make && cd -
> jtcore hige

That should produce the MiST output. If you have a fresh linux installation, you probably need to install more programs. These are the compilation steps in more detail

  • You need linux. I use Ubuntu mate but any linux will work
  • You need 32-bit support if you're going to compile MiST/SiDi cores
  • There are some linux dependencies that you can sort out with sudo apt install, mostly Python, the pypng pythong package, Go and the YAML.v2 package
  • Populate the arcade core repository including submodules recursively. I believe in using submodules to break up tasks and sometimes submodules may have their own submodules. So be sure to populate the repository recursively. Be sure to understand how git submodules work
  • Now jtframe should be located in core-folder/modules/jtframe go there and enter the cc folder. Run make. Make sure all files compile correctly and install whatever you need to make them compile. All should be in your standard linux software repository. Nothing fancy is needed
  • Now go to the core-folder and run source setprj.sh
  • Now you can compile the core using the jtcore script.

The output file is stored in releases/target where target stands for the FPGA platform (mist, mister, etc.). Most platforms use files with a .rbf extension, but some use a different extension -though the underlying file type is the same.

jtcore

jtcore is the script used to compile the cores. It does a lot of stuff and it does it very well. Taking as an example the CPS0 games, these are some commands:

jtcore gng -sidi

Compiles Ghosts'n Goblins core for SiDi.

jtcore tora -mister

Compiles Tiger Road core for MiSTer.

Some cores, particularly if they only produce one RBF file, may alias jtcore. For CPS1 do:

jtcore cps1 -mister

And that will produce the MiSTer version.

Run jtcore -h to get help on the commands.

jtcore can also program the FPGA (MiST or MiSTer) with the -p option. In order to use an USB Blaster cable in Ubuntu you need to setup two urules files. The script jtblaster does that for you.

jtupdate

To compile all cores in a JTFRAME project, run

jtupdate --target mister

The output will be created in $JTROOT/release. See jtupdate -h for more details.