Adding some more readme.

This commit is contained in:
Nicolas Pixel Noble 2023-04-14 15:08:11 -07:00
parent 7f4da75b36
commit fcc6108e31
3 changed files with 32 additions and 2 deletions

View file

@ -14,7 +14,7 @@ To discuss PlayStation 1 development, hacking, and reverse engineering in genera
# PCSX-Redux
## What?
This is yet another fork of the Playstation emulator, PCSX. While the work here is very much in progress, the goal is roughly the following:
The PCSX-Redux project is a collection of tools, research, hardware design, and libraries aiming at development and reverse engineering on the PlayStation 1. The core product itself, PCSX-Redux, is yet another fork of the Playstation emulator, PCSX. While the work here is very much in progress, the goal is roughly the following:
- Bring the codebase to more up to date code standards.
- Get rid of the plugin system and create a single monolithic codebase that handles all aspects of the playstation emulation.
@ -22,7 +22,9 @@ This is yet another fork of the Playstation emulator, PCSX. While the work here
- Improve the debugging experience.
- Improve the rendering experience.
Please consult [the documentation pages](https://pcsx-redux.consoledev.net) for more information.
Please consult [the documentation pages](https://pcsx-redux.consoledev.net) for more information on the emulator itself.
The [tools](tools) directory contains a few tools that can be used to work with PlayStation 1 software. The [wiki](https://github.com/grumpycoders/pcsx-redux/wiki) directory contains a few research information that are not directly related to the emulator itself. The [mips](src/mips) directory contains various pieces of code targeting the PlayStation 1, and importantly, the OpenBIOS project, which is a MIPS R3000A BIOS implementation that can be used to boot PlayStation 1 games without the need for a retail BIOS. And the [hardware](hardware) directory contains various hardware designs that can be used with the PlayStation 1.
## Where?
|Download page|

13
hardware/README.md Normal file
View file

@ -0,0 +1,13 @@
# Hardware
This directory contains various hardware mods and addons for the PlayStation 1. The PCBs have been designed using Eagle, and pre-rendered gerber files are provided. When applicable, [jlcpcb](https://jlcpcb.com) build files are provided (BoM and assembly CSV files).
Some of these designs have been thoroughly documented [in the wiki](https://github.com/grumpycoders/pcsx-redux/wiki).
* [MC-Breakout](MC-Breakout) - A breakout board for the PlayStation 1's memory card slot. This board is made to fit directly into the slot without a case, and provides a simple header to connect to the memory card slot's signals.
* [PIO-Breakout](PIO-Breakout) - A breakout board for the PlayStation 1's parallel I/O port. This board is designed to function as a pass-through, which can then be used to sniff the parallel I/O port's signals when connecting another flash cart to it.
* [PIO-Dev](PIO-Dev) - A development board for the PlayStation 1's parallel I/O port. The board has [extensive documentation](https://github.com/grumpycoders/pcsx-redux/wiki/PIODev-Board) on the wiki.
* [PowerReplayUSB](PowerReplayUSB) - An easy to build mod for the popular and readily available [Power Replay Flash Cart](https://www.aliexpress.com/w/wholesale-ps1-power-replay.html) which adds USB support to it. The USB support is provided by the [FT232H](https://ftdichip.com/products/ft232hq/) chip, and [unirom](https://unirom.github.io/) has support for it. There is a [USB-C alternative](PowerReplayUSBC) available as well.

15
tools/README.md Normal file
View file

@ -0,0 +1,15 @@
# Tools
This directory contains tools designed to help with the PCSX-Redux project somehow. The top level, directly usable tools are:
* [exe2elf](exe2elf) - Converts a PS-EXE executable to an ELF file, which can be useful for loading and debugging through gdb.
* [exe2iso](exe2iso) - Converts a PS-EXE executable to a minimally bootable ISO file. The generated iso will not be conformant to the ISO9660 standard, but it will be bootable on a retail PlayStation 1.
* [ghidra_scripts](ghidra_scripts) - A collection of Ghidra scripts that can be used to integrate some parts of PCSX-Redux into Ghidra and vice versa.
* [ps1-packer](ps1-packer) - A tool for compressing PlayStation 1 executables into a single self-decompressing binary in various formats.
* [psyq-obj-parser]](psyq-obj-parser) - A tool for parsing the object files produced by the Psy-Q SDK, and converting them to ELF files.
For the tools that need to be built, the top level Makefile can be used to build them all using the `tools` target. On Windows, the tools are present within the PCSX-Redux solution file in the `vsprojects` folder.
The [linux-mips](linux-mips) and [macos-mips](macos-mips) folders contain scripts for generating a cross-compiler for the MIPS architecture.
The rest of the folders are the sources for some other internal tools that are not directly usable here, but published to other platforms.