Skip to content

Commit

Permalink
README Updates
Browse files Browse the repository at this point in the history
Update README.md

Typo
  • Loading branch information
IsaacMarovitz committed May 4, 2024
1 parent 010f9a0 commit 4b9f4f4
Showing 1 changed file with 17 additions and 33 deletions.
50 changes: 17 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,27 @@
# tetsuyu
<div align="left">
<h1>tetsuyu</h1>
<i>鉄遊 (tetsu-yū) - A Game Boy emulator, written in Rust.</i>
</div>

A GameBoy emulator, written in Rust.
<br>

### Features
- Supports MBC1/MBC2/MBC3/MBC5 Titles
- Sprite & BG Rendering
- Input
## Features
- Cycle-Accurate CPU
- (Almost) Fully Accurate Audio
- DMG & CGB Support
- Configurable Input
- Configurable Palettes & Shaders
- Cross-Platform
- wgpu-based Backend
- librashader support
- Configurable Settings
- Custom Palettes
- Custom Inputs
- MBC1/MBC2/MBC3/MBC5 Title Support
- Accurate Color Correction

### Partially Complete
- [ ] Channel 1
- [x] Period
- [x] Duty Cycle
- [ ] Sweep
- [ ] Envelope
- [ ] Channel 2
- [x] Period
- [x] Duty Cycle
- [ ] Envelope
- [ ] Channel 3
- [ ] Wave
- [ ] Period
- [ ] Channel 4
- [ ] LFSR
<img width="500" alt="Pokemon Gold" src="https://github.com/IsaacMarovitz/tetsuyu/assets/42140194/e594ea03-2c76-4756-91c9-4592245c5e56">
<img width="500" alt="Demo" src="https://github.com/IsaacMarovitz/tetsuyu/assets/42140194/d57351ba-00d7-4491-90a5-9ccb2b5cb91e">

<img width="400" alt="cpu_instrs Test" src="https://github.com/IsaacMarovitz/tetsuyu/assets/42140194/a1b62888-0efa-4132-93fe-7ee812f7c73e">
<img width="400" alt="instr_timing Test" src="https://github.com/IsaacMarovitz/tetsuyu/assets/42140194/56fe26c1-cc4b-498e-9fd0-26a3d109c0ba">
## Referenced Documentation
- https://gbdev.io/pandocs/


### Referenced Documentation
- https://gbdev.io/pandocs/CPU_Instruction_Set.html

### Referenced Implementations
## Referenced Implementations
- https://github.com/LIJI32/SameBoy
- https://github.com/mvdnes/rboy
- https://github.com/mohanson/gameboy

0 comments on commit 4b9f4f4

Please sign in to comment.