Step 1 : Preparation

Prerequisites

  • Under Windows
    • Microsoft Windows XP sp3 or superior
    • Code::Blocks (optional)
  • Under Linux
    • wine
    • genisoimage
    • yabause

Installation

First, you have to download the engine in the "Download" section of this website.

It's a zip file that you have to extract where you want.

  • The folder "demo1" contains a minimalistic demo that display a sonic on the screen
    • There are several other demo but this one is the easier :)
  • The folder "jo_engine" contains the engine source code (.c .h)
  • The folder "Compiler" contains everything to compile and create iso
  • The folder SSF contains the SSF emulator version 0.12 beta R4
  • The folder yabause contains the yabause emulator version 0.9.14
  • The folder JoMapEditor contains a tool to create sprite, tileset and map.

Don't change folder names (except for demos)

Step 2 : Demo test

demo1 folder

We will now test the demo 1 to verify that everything works.

We will study the contents of the "demo1" folder:

The CD folder containing multiple files and a folder that is simply the CD contents that will be used to create the iso (the sprite of Sonic is in).

The other files are:

  • 6 batch files for Windows
    • clean.bat (delete iso, .o files and temporary files)
    • compile.bat (compile and generate a .iso)
    • run_with_yabause.bat (run yabause using the generated iso)
    • run_with_daemon_tools_and_ssf.bat (mount the iso using Deamon tools, run SSF and unmount the iso when SSF is closed)
    • run_with_virtual_clone_drive_and_ssf.bat (mount the iso using VCD, run SSF and unmount the iso when SSF is closed)
    • run_with_powershell_and_ssf.ps1 (doesn't work today because of SSF)
  • 3 shell scripts for Linux
    • clean.sh (delete iso, .o files and temporary files)
    • compile.sh (compile and generate a .iso)
    • run_with_yabause.sh (run yabause using the generated iso)
  • sl_coff.cue (ISO metadata)
  • main.c (the source code of the game)
  • makefile (Project Makefile which contains the list of file to compile)
  • Demo1.cbp (Code Blocks IDE project)

All files can be opened using a simple Notepad

Test

First we have to compile using the script "compile.bat/sh"

Some errors can be displayed when deleting temporary files

If everything is alright, you will find a new file on the folder:  "sl_coff.iso"

Now you just have to run the following script: "run_with_yabause.bat/sh"

  

And voilà  :) !

Step 3 : Create my own game

To create a new game, you just have to clone the "demo1" folder

Now, you can edit the main.c :)