dingusppc/README.md

102 lines
2.8 KiB
Markdown
Raw Normal View History

2020-03-27 06:36:43 +00:00
# DingusPPC
Written by divingkatae and maximumspatium
2019-07-02 02:19:08 +00:00
Be warned the program is highly unfinished and could use a lot of testing. Any feedback is welcome.
## Philosophy of Use
2019-07-02 02:19:08 +00:00
While many other PowerPC emus exist (PearPC, Sheepshaver), none of them currently attempt emulation of PPC Macs accurately (except for QEMU).
2020-10-14 14:45:18 +00:00
This program aims to not only improve upon what Sheepshaver, PearPC, and other PowerPC mac emulators have done, but also to provide a better debugging environment. This currently is designed to work best with PowerPC Old World ROMs, including those of the PowerMac G3 Beige.
## Implemented Features
This emulator has a debugging environment, complete with a disassembler. We also have implemented enough to allow Open Firmware to boot, going so far as to allow audio playback of the boot-up jingles.
## How to Use
2019-07-02 02:19:08 +00:00
This program currently uses the command prompt to work.
2019-07-02 02:19:08 +00:00
There are a few command line arguments one must enter when starting the program.
2019-07-02 02:19:08 +00:00
2020-10-14 14:45:18 +00:00
```
-r, --realtime
```
2019-07-02 02:19:08 +00:00
Run the emulator in runtime.
2019-07-02 02:19:08 +00:00
2020-10-14 14:45:18 +00:00
```
-d, --debugger
```
2019-07-02 02:19:08 +00:00
Enter the interactive debugger.
2019-07-02 02:19:08 +00:00
2020-10-14 14:45:18 +00:00
```
-b, --bootrom TEXT:FILE
```
Specifies the Boot ROM path (optional; looks for bootrom.bin by default)
```
-m, --machine TEXT
```
Specify machine ID (optional; will attempt to determine machine ID from the boot rom otherwise)
2020-10-14 14:45:18 +00:00
2020-11-30 13:47:22 +00:00
As of now, only the Power Macintosh G3 Beige is implemented.
## How to Compile
2020-10-14 14:45:18 +00:00
You need to install development tools first.
At least, a C++11 compliant compiler and [CMake](https://cmake.org) are required.
You will also have to recursive clone or run
2020-10-14 14:45:18 +00:00
```
2020-11-21 23:17:09 +00:00
git submodule update --init --recursive
2020-10-14 14:45:18 +00:00
```
This is because the CubeB module is not included by default. All other components are already included in the thirdparty folder and compiled along with the rest of DingusPPC.
For example, to build the project in a Unix-like environment, you will need to run
the following commands in the OS terminal:
```
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
make dingusppc
```
You may specify another build type using the variable CMAKE_BUILD_TYPE.
2019-07-02 02:19:08 +00:00
2020-10-14 14:45:18 +00:00
Future versions may drop SDL 2 as a requirement.
For Raspbian, you may also need the following command:
```
sudo apt install doxygen graphviz
```
## Testing
DingusPPC includes a test suite for verifying the correctness of its PowerPC CPU
emulation. To build the tests, use the following terminal commands:
```
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
make testppc
```
2019-07-02 02:19:08 +00:00
## Intended Minimum Requirements
2019-07-02 02:19:08 +00:00
- Windows 7 or newer (64-bit), Linux 4.4 or newer, Mac OS X 10.9 or newer (64-bit)
- Intel Core 2 Duo or better
- 2 GB of RAM
- 2 GB of Hard Disk Space
2019-07-02 02:19:08 +00:00
- Graphics Card with a minimum resolution of 800*600
2019-07-02 02:19:08 +00:00
## Compiler Requirements
2019-07-02 02:19:08 +00:00
- GCC 4.7 or newer (i.e. CodeBlocks 13.12 or newer)
- Visual Studio 2013 or newer