/3do-devkit

A new development environment for the 3DO Opera game console

Primary LanguageC

This is a 3DO Opera (M1) development environment. It is built from a number of components both new and old. The hope is that by making setup more turnkey and bringing documentation and examples into one location it will help facilitate more homebrew on the 3DO.

Components

Compilers

  • Norcroft ARM C v4.91 (ARM Ltd SDT2.51) [Build number 130] for Linux
  • Norcroft ARM C v4.91 (ARM Ltd SDT2.51) [Build number 128] for Windows
  • Norcroft ARM C++ v0.61/v4.91 (ARM Ltd C++1.11) [Build number 130] for Linux
  • Norcroft ARM C++ v0.61/v4.91 (ARM Ltd C++1.11) [Build number 128] for Windows

Libraries

  • 3DO libraries from Portfolio 2.5 (including Lib3DO)
  • cpplib: basic replacement C++ standard library
  • svc_funcs: provides access to kernel functions while in supervisor mode
  • svc_mem: example device driver and its library
  • example_folio: example Folio (shared library)
  • Roguewave STL which originally came with ARM C++ (probably not worth using)

Documentation

Tooling

  • 3it: trapexit's 3DO Image Tool
  • 3dt: trapexit's 3DO Disc Tool
  • 3ct: trapexit's 3DO Compression Tool
  • modbin: trapexit's recreation of the original SDK's tool by the same name
  • 3doiso v0.1 by nikk
  • 3DOEncrypt v0.6a by Charles Doty
  • MakeBanner v1.0b by Charles Doty
  • BMPTo3DOCel v0.6a by Charles Doty
  • BMPTo3DOImage v1.0b by Charles Doty
  • BMPTo3DOAnim v0.6a by Charles Doty

trapexit's tooling may not always be fully up to date in this repo so double check by visiting the links provided above.

Examples

Misc

  • 3DO "takeme" CDROM base files from Portfolio 2.5 w/ a swapped out boot_code from Game Guru

Usage

Linux

Make sure you have WINE installed. Some tools are currently only available on Windows.

makefile

  • Get dev kit: git clone --depth=1 https://github.com/trapexit/3do-devkit
  • You can also download a zip file from the GitHub page
  • Enter the directory: cd 3do-devkit
  • Source the environment: source activate-env
  • Run make: make
    • Generates file helloworld.iso
  • Run in Opera emulator (via RetroArch): make run

Windows

We need project files for common Windows IDEs.

WSL2

Same as Linux

Media Conversion

images

3it is a pretty comprehensive tool supporting conversion to and from CELs, IMAGs, Banners, etc. Older tools are included for completeness but should not be needed.

audio

ffmpeg can be used to convert files to AIFF files but to compress them you will need to use the original software for now. See below.

SDX2 encoding is not currently supported by ffmpeg but work is being done to build an encoder.

uncompressed AIFF signed 16bit bigendian

ffmpeg -i input.file -ar 22050 -c:a pcm_s16be output.aiff"

uncompressed AIFF signed 8bit

ffmpeg -i input.file -ar 22050 -c:a pcm_s8 output.aiff"

uncompressed raw signed 16bit bigendian

ffmpeg -i input.file -ar 22050 -f s16be -acodec pcm_s16be output.raw"

uncompressed raw signed 8bit

ffmpeg -i input.file -ar 22050 -f s8 -acodec pcm_s8 output.raw"

compressed 4bit ADPCM IMA WS

Make sure you have a more recent version of ffmpeg to use adpcm_ima_ws

ffmpeg -i input.file -c:a adpcm_ima_ws output.aifc

video

Same as audio. Cinepak creation by ffmpeg is not compatible with the 3DO provided decoder. https://3dodev.com has a tutorial.

http://3dodev.com/software/sdks#prebuilt_qemu_macos_9_vm

Notes

ARM C++ 1.11 compiler

  • ARM C++ 1.11 is a pre-standard compiler. From section 3.10 in the ref guide:
    • Exceptions are NOT supported
    • Namespaces are NOT supported
    • RTTI is only partially suported
    • C++ style casting is only partially supported
    • While technically mostly supported templates can be buggy and complex usage may crash the compiler

Memory Management

ARM C++ 1.11 treats POD (plain old data) and objects differently so POD must be expressly handled/ignored when worrying about object destruction. There are no default destructors for objects either meaning it is not possible to simulate a 'placement delete' to force destruction. obj->~OBJ() will not work unless expressly defined. As a result it is difficult to write generic template based data types. To work around this the STL like library provided removed memory freeing from 'delete' to force its use as a placement delete. Meaning that when wanting to free data from 'new' one should use memory_delete(ptr). That said best to use or create higher level objects to manage such things. Simple versions of shared_ptr and unique_ptr are provided.

There might be a better solution to this problem but after many attempts, including attempting to use the strategy by RogueWave which didn't seem to work, this was settled on till something better could be be done.

TODO

  • Project files for popular IDEs.
  • Continue to enhance the C++ standard library replacement.
  • C++ based 3DO specific libraries.
  • Create a new iso building tool.
  • Create a new iso encrypt tool.
  • More examples.
  • Better compiler support. Possibly use CLANG or GCC to generate assembly and translate it to work with Norcroft armasm.
  • More languages? If you have a ARMv3 compatible compiler and AIF linker (even if just different versions of Norcroft compilers) please reach out.
  • A version of the Opera emulator tailored for development work?

Thanks

  • @ArmSoftwareDev on Twitter and Arm Support: for providing me with copies of ARM SDT 2.51 and ARM C++ 1.11. After reaching out to former Norcroft employees, software archivists, and even Bjarne Stroustrup without success finding a copy of ARM C++ from the 3DO era I reached out to ARM directly and they were able to find some copies and offered them to me for this project.
  • everyone at The 3DO Community Discord
  • XProger (author of OpenLara) who was the first project to use this dev kit

Links

Donations / Sponsorship

If you find 3do-devkit useful please consider supporting its ongoing development.

https://github.com/trapexit/support