mirror of https://github.com/RetroDECK/Supermodel.git synced 2024-11-22 05:45:38 +00:00

Find a file

toxieainc 5f97e5af6c address review		2022-10-03 17:59:59 -07:00
Config	Added some options to default Supermodel.ini that otherwise are not documented anywhere because README.txt is out of date	2022-08-16 18:33:33 -07:00
Docs	Preparing for Git snapshot build bot and updated copyright header to reference full lifespan of Supermodel repo	2022-06-23 12:34:02 -07:00
Libraries	Updated comment in DIR.txt (again!)	2011-11-05 20:59:38 +00:00
Makefiles	Rules.inc: whitespace error	2022-06-23 12:41:32 -07:00
Scripts	supermodel_build_bot.py: New build bot script for GitHub	2022-06-25 15:53:47 -07:00
Src	address review	2022-10-03 17:59:59 -07:00
VS2008	address review and move bit casts to new header	2022-10-03 17:59:59 -07:00
README.md	Update README.md	2022-06-25 15:53:36 -07:00

README.md

Supermodel: A Sega Model 3 Arcade Emulator

Overview

Supermodel emulates Sega's Model 3 arcade platform, allowing you to relive state-of-the-art 3D arcade gaming as it existed from 1996 through 1999. It uses OpenGL, SDL2, and can run on Windows, Linux, and macOS. It also supports network play on low-latency network connections. The source code is freely available under the terms of the GNU General Public License.

Model 3 first made its debut in 1996 with Virtua Fighter 3 and Scud Race, and for the subsequent three years boasted the most powerful 3D hardware of any gaming platform. Developed by Real3D, then a Lockheed Martin company, and with a heritage rooted in advanced flight simulator technology, Model 3 featured capabilities that would not appear on PCs for several years. Using an on-board scene graph and geometry processor, it could store, transform, light, and rasterize tens of thousands of polygons per frame at a fluid 57.524 frames per second.

The aim of the Supermodel project is to develop an emulator that is both accurate and playable. As with virtually all arcade hardware, no public documentation for the Model 3 platform exists. What is known so far has been painstakingly reverse engineered from scratch.

How To Get It

Windows builds are updated automatically and available on the official Supermodel download page. Linux and macOS users currently have to build from source.

Build Instructions

Windows

The preferred method for building Supermodel is to use GCC and MSYS2. After installing MSYS2, open the MSYS2 shell and install the required dependencies using the pacman package manager:

GCC (mingw64/mingw-w64-x86_64-gcc)
Make (mingw64/mingw-w64-x86_64-make)
SDL2 (mingw64/mingw-w64-x86_64-SDL2, mingw64/mingw-w64-x86_64-SDL2_net)

This can be done using the following commands:

pacman -S mingw64/mingw-w64-x86_64-gcc
pacman -S mingw64/mingw-w64-x86_64-make
pacman -S mingw64/mingw-w64-x86_64-SDL2
pacman -S mingw64/mingw-w64-x86_64-SDL2_net

At this point, you can continue using either the MSYS2 shell or Windows Command Prompt but ensure that both gcc and mingw32-make are in your path. In MSYS2, the location of these binaries will be /mingw64/bin and for Command Prompt, assuming MSYS2 was installed in the default location, add C:\msys64\mingw64\bin to your Windows PATH variable.

To build Supermodel without network support, use:

mingw32-make -f Makefiles/Makefile.Win32

For network support:

mingw32-make -f Makefiles/Makefile.Win32 NET_BOARD=1

Linux

Ensure SDL2 is installed. Most package managers ought to have this available. For example, on Ubuntu, it should be sufficient to run:

sudo apt install libsdl2-dev
sudo apt install libsdl2-net-dev

And then build Supermodel:

make -f Makefiles/Makefile.UNIX

For network support:

make -f Makefiles/Makefile.UNIX NET_BOARD=1