orbum/README.md

# orbum [![Travis CI Status](https://travis-ci.com/hch12907/orbum.svg?branch=master)](https://travis-ci.com/hch12907/orbum) [![AppVeyor Status](https://ci.appveyor.com/api/projects/status/github/hch12907/orbum?branch=master&svg=true)](https://ci.appveyor.com/project/hch12907/orbum)


#### PS2 Emulator
Based off PCSX2's codebase, this is a completely rewritten PS2 emulator.
It does not boot games (yet), only useful to developers for now.

I can only work on this in my spare time, so I am thankful for any help!

## Current status

Status as of 2018/08/06:
- Primary focus for now is on the VIF/IPU.
- Work started on the SPU2 (DMA and IOP communication done, sound generation still to be done).
- Work started on the SIO/SIO2 (controllers and MC's), IOP communication done.
- No work done yet on the IPU and GSCore.
- Everything else not mentioned mostly done (EECore, IOPCore, etc). Interpreters only for now, dynarecs will not come for a while.

## Build Instructions
### General Information
CMake is used as the build system. 

The project uses the following dependecies:
  - Boost library, which is configured by the CMake FindBoost module.
  - Cereal for serialization.

Run the following commands to invoke a build:

`git submodule update --init --recursive`

`mkdir build && cd build`

`cmake ..` optionally specifying `-DBOOST_ROOT={path}` depending on your environment.

`make` (or equivalent)

## Running
`./orbumfront`

Logging is always enabled and will save files to `logs/` (uses boost logging).

The bios file scph10000.bin should be placed in `bios/`.
Other bios' are not currently supported or tested with.

Upon Ctrl-C, a number of options will be presented:
  - A memory dump (binary) can be created that will be placed in the `dumps/` folder.
  - A save state (json/text readable) can be created that will dump the PS2 state for inspection. Uses the `saves/` folder.

## Licence
[GPL3](LICENSE.md)
Update README. 2018-11-06 08:00:38 -05:00			`# orbum [![Travis CI Status](https://travis-ci.com/hch12907/orbum.svg?branch=master)](https://travis-ci.com/hch12907/orbum) [![AppVeyor Status](https://ci.appveyor.com/api/projects/status/github/hch12907/orbum?branch=master&svg=true)](https://ci.appveyor.com/project/hch12907/orbum)`
Update readme. 2018-01-23 07:30:13 -05:00
Fix cmake install rules. 2018-01-07 05:39:04 -05:00
Refactor all of the resources into a memory friendly (spatial) structure. WIP still. Removed individual register logging, use controller memory access ranges to do this. Controllers will need to be updated, the instruction tables will be auto generated shortly. 2017-11-18 01:39:28 -05:00			`#### PS2 Emulator`
Update README and add a LICENSE file it has been bugging me for too long 2018-11-03 02:46:28 -04:00			`Based off PCSX2's codebase, this is a completely rewritten PS2 emulator.`
			`It does not boot games (yet), only useful to developers for now.`
First commit. Implemented parts of the EE core. 2016-07-06 08:56:06 -04:00
Fixed up install target and added GCC/Clang flags. 2017-06-02 05:06:45 -04:00			`I can only work on this in my spare time, so I am thankful for any help!`
First commit. Implemented parts of the EE core. 2016-07-06 08:56:06 -04:00
Switched from std::unordered_map to boost::container::flat_map... much better when run under the optimised build. From 20s run time to almost nothing! 2016-09-24 04:56:24 -04:00			`## Current status`

Update CI scripts, readme. 2018-08-06 10:53:54 -04:00			`Status as of 2018/08/06:`
Update README. 2018-11-06 08:00:38 -05:00			`- Primary focus for now is on the VIF/IPU.`
Update readme. 2017-05-21 00:11:05 -04:00			`- Work started on the SPU2 (DMA and IOP communication done, sound generation still to be done).`
Update CI scripts, readme. 2018-08-06 10:53:54 -04:00			`- Work started on the SIO/SIO2 (controllers and MC's), IOP communication done.`
			`- No work done yet on the IPU and GSCore.`
Update readme. 2017-05-21 00:11:05 -04:00			`- Everything else not mentioned mostly done (EECore, IOPCore, etc). Interpreters only for now, dynarecs will not come for a while.`
Fixed up install target and added GCC/Clang flags. 2017-06-02 05:06:45 -04:00
Switched from std::unordered_map to boost::container::flat_map... much better when run under the optimised build. From 20s run time to almost nothing! 2016-09-24 04:56:24 -04:00			`## Build Instructions`
Fixed up install target and added GCC/Clang flags. 2017-06-02 05:06:45 -04:00			`### General Information`
Remove boost-cmake submodule, use system boost through FindBoost cmake module. 2018-03-02 09:44:03 -05:00			`CMake is used as the build system.`
Update CI scripts, readme. 2018-08-06 10:53:54 -04:00
			`The project uses the following dependecies:`
			`- Boost library, which is configured by the CMake FindBoost module.`
			`- Cereal for serialization.`
Update readme. 2018-01-23 07:30:13 -05:00
Remove boost-cmake submodule, use system boost through FindBoost cmake module. 2018-03-02 09:44:03 -05:00			`Run the following commands to invoke a build:`
Update readme. 2018-01-23 07:30:13 -05:00
Update CI scripts, readme. 2018-08-06 10:53:54 -04:00			`git submodule update --init --recursive`

Update readme. 2018-01-23 07:30:13 -05:00			`mkdir build && cd build`

Remove boost-cmake submodule, use system boost through FindBoost cmake module. 2018-03-02 09:44:03 -05:00			`cmake ..` optionally specifying `-DBOOST_ROOT={path}` depending on your environment.
Major refactor, moved to a scalable multithreaded design (executor). 2018-01-01 08:35:08 -05:00
Run clang-format and update README 2018-10-07 11:58:57 -04:00			`make` (or equivalent)
Finally sorted out a workflow to continue with... not as good as VS, but at least this is fully cross-platform. 2017-06-05 00:11:40 -04:00
Refactor all of the resources into a memory friendly (spatial) structure. WIP still. Removed individual register logging, use controller memory access ranges to do this. Controllers will need to be updated, the instruction tables will be auto generated shortly. 2017-11-18 01:39:28 -05:00			`## Running`
Major refactor, moved to a scalable multithreaded design (executor). 2018-01-01 08:35:08 -05:00			`./orbumfront`
Finally sorted out a workflow to continue with... not as good as VS, but at least this is fully cross-platform. 2017-06-05 00:11:40 -04:00
Update CI scripts, readme. 2018-08-06 10:53:54 -04:00			Logging is always enabled and will save files to `logs/` (uses boost logging).

Major refactor, moved to a scalable multithreaded design (executor). 2018-01-01 08:35:08 -05:00			The bios file scph10000.bin should be placed in `bios/`.
Refactor all of the resources into a memory friendly (spatial) structure. WIP still. Removed individual register logging, use controller memory access ranges to do this. Controllers will need to be updated, the instruction tables will be auto generated shortly. 2017-11-18 01:39:28 -05:00			`Other bios' are not currently supported or tested with.`
Finally sorted out a workflow to continue with... not as good as VS, but at least this is fully cross-platform. 2017-06-05 00:11:40 -04:00
Update CI scripts, readme. 2018-08-06 10:53:54 -04:00			`Upon Ctrl-C, a number of options will be presented:`
			- A memory dump (binary) can be created that will be placed in the `dumps/` folder.
			- A save state (json/text readable) can be created that will dump the PS2 state for inspection. Uses the `saves/` folder.
Remove boost-cmake submodule, use system boost through FindBoost cmake module. 2018-03-02 09:44:03 -05:00
Refactor all of the resources into a memory friendly (spatial) structure. WIP still. Removed individual register logging, use controller memory access ranges to do this. Controllers will need to be updated, the instruction tables will be auto generated shortly. 2017-11-18 01:39:28 -05:00			`## Licence`
Update README. 2018-11-06 08:00:38 -05:00			`[GPL3](LICENSE.md)`