buildS3.lua

#!/usr/bin/env lua

-----------
-- Notes --
-----------

-- Sonic The Hedgehog 3 does not use kosinski for its sound driver compression.
-- In fact, it does not compress at all, using uncompressed maps.
-- Because of this, it is not yet possible to change the sound settings.
local improved_sound_driver_compression = false

------------------
-- End of notes --
------------------

-------------------------------------
-- Actual build script begins here --
-------------------------------------

local common = require "build_tools.lua.common"

-- Function to check if a directory exists
local function dir_exists(path)
    local ok, _, code = os.rename(path, path)
    if not ok and code == 2 then
        return false
    end
    return true
end

-- Create build directory only if it doesn't exist
if not dir_exists("build") then
    print('Creating build directory "build"...')
    os.execute("mkdir build")
end

-- Produce PCM and DPCM data.
print('Converting PCM files from directory "Sound/PCM"...')
common.convert_pcm_files_in_directory("Sound/PCM")

print('Converting DPCM files from directory "Sound/DAC"...')
common.convert_dpcm_files_in_directory("Sound/DAC")

-- Build the ROM.
local compression = "uncompressed"
print("Selected compression method: " .. compression)

print("Preparing to build the ROM...")
print('Type: Sonic The Hedgehog 3')
print('Build directory: "build/s3built"')
print("Building ROM... Please wait...")

common.build_rom_and_handle_failure(
    "s3",
    "build/s3built",
    "",
    "-p=FF -z=0,uncompressed,Size_of_Snd_driver_guess,before -z=1300,uncompressed,Size_of_Snd_driver2_guess,before",
    false,
    "https://github.com/sonicretro/skdisasm"
)

-- Correct the ROM's header with a proper checksum and end-of-ROM value.
print("Fixing the ROM's header with a proper checksum and end-of-ROM value...")
print("Please wait...")

common.fix_header("build/s3built.bin")

-- A successful build; we can quit now.
print("Build successful! ROM written to build/s3built.bin")
common.exit()