trapezoid 0.1.4

A PSX emulator, backed by vulkano for rendering
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

<!-- <p align="center">
  <a href="https://github.com/Amjad50/trapezoid"><img alt="trapezoid" src="images/logo.svg" width="60%"></a>
  <p align="center">PSX emulator in <em>Rust</em></p>
</p> -->
# Trapezoid

[![Build status](https://github.com/Amjad50/trapezoid/workflows/Rust/badge.svg)](https://actions-badge.atrox.dev/Amjad50/trapezoid/goto)
[![dependency status](https://deps.rs/repo/github/Amjad50/trapezoid/status.svg)](https://deps.rs/repo/github/Amjad50/trapezoid)
[![license](https://img.shields.io/github/license/Amjad50/trapezoid)](./LICENSE)
[![Crates.io trapezoid](https://img.shields.io/crates/v/trapezoid)](https://crates.io/crates/trapezoid)

**trapezoid** is a [PSX/PS1](https://en.wikipedia.org/wiki/PlayStation_(console)) emulator built from scratch using [Rust].

This is a personal project for fun and to experience emulating hardware and connecting them together.

## Showcase

<img src="assets/psx.png" alt="demo" width="600"/>

## Building and installation

### Installing
You can install `trapezoid` from [`crates.io`](https://crates.io/crates/trapezoid) using `cargo`:
```
cargo install trapezoid
```

### Building
If you want to experience the latest development version, you can build `trapezoid` yourself.
```
cargo build --release
```
> The emulator will be slow without optimization, that's why we have `opt-level = 2` in `debug` profile.

## Emulator core
The emulator core is implemented as a library in [`trapezoid-core`], this library is the emulator core, and contain
all the components. You can easily take the core and build a frontend around it, or use it as a server.

Check the [`trapezoid-core`] for more info and documentation.

## Frontend

### Controls
The Frontend implementations has its own controls mapping, this can be configured
if you decide to use [`trapezoid-core`] directly

#### Keyboard
| keyboard  | PSX controller |
| --------- | -------------- |
| Enter     | Start          |
| Backspace | Select         |
| Num1      | L1             |
| Num2      | L2             |
| Num3      | L3             |
| Num0      | R1             |
| Num9      | R2             |
| Num8      | R3             |
| W         | Up             |
| S         | Down           |
| D         | Right          |
| A         | Left           |
| I         | Triangle       |
| K         | X              |
| L         | Circle         |
| J         | Square         |

### Debugging
`trapezoid` has a built-in powerfull debugger to help debug games and access to data.

Check [DEBUGGER.md](./DEBUGGER.md) for more information.

#### VRAM

We can view the raw vram state, which you can think of as an image of 1024x512 pixels

This can be triggerd with the keyboard button `v`.

![vram](assets/psx_vram.png)

### Contributions and TODO
Check the [`trapezoid-core`] for more information about TODO items related to the emulator.

Also check the [issues](https://github.com/Amjad50/Trapezoid/issues).

Really appreciate any contributions. Thanks!


### License
This project is under [MIT](./LICENSE) license.

NES is a product and/or trademark of Nintendo Co., Ltd. Nintendo Co., Ltd. and is not affiliated in any way with Plastic or its author

### References
Most of the documentation for PSX components can be found in the [consoledev website](https://psx-spx.consoledev.net/)

[Rust]: https://www.rust-lang.org/
[`trapezoid-core`]: ./trapezoid-core/README.md