Skip to content

Commit

Permalink
modify some documents
Browse files Browse the repository at this point in the history
  • Loading branch information
Dechrissen committed Sep 10, 2024
1 parent a0bea21 commit c90d6db
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 18 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,12 @@ There are three versions of this romhack: _Solus Red_, _Solus Green_, and _Solus

[Assembling the source code](#building-the-roms) will yield three ROMs:

- Solus Red (`pokered.gbc`)
- Solus Green (`pokegreen.gbc`)
- Solus Blue (`pokeblue.gbc`)
- Solus Red (`pokesolusred.gbc`)
- Solus Green (`pokesolusgreen.gbc`)
- Solus Blue (`pokesolusblue.gbc`)

_A note about hardware palettes_: Solus Green is inspired by the original Japanese release of Green Version. If played on Game Boy Color, you will see the GBC's mostly-green palette which was specifically intended for the Japanese release of Pokémon Green Version. (The same goes for Red and Blue: you will see their mostly-red or mostly-blue Game Boy Color palettes.) If played on Super Game Boy, the palette used for title screen, SGB border, and Game Corner slots will all be version-specific corresponding to Red, Green, or Blue versions.
_A note about hardware palettes_:
Solus Green is inspired by the original Japanese release of Green Version. If played on Game Boy Color, you will see the GBC's mostly-green palette which was specifically intended for the Japanese release of Pokémon Green Version. (The same goes for Red and Blue: you will see their mostly-red or mostly-blue Game Boy Color palettes.) If played on Super Game Boy, the palette used for title screen, SGB border, and Game Corner slots will all be version-specific corresponding to Red, Green, or Blue versions.

## Description

Expand Down Expand Up @@ -80,17 +81,19 @@ Otherwise, if your environment for compiling the vanilla ROMs is already set up,
- The [pokered wiki][wiki] which has many helpful tutorials on working with the source code, some of which were used for this project
- The [pret Discord server][pretdiscord]
- [Shin Pokémon romhack][shinpokered] (Field Move slot implementation was taken from here)
- [pokeworld][pokeworld]: a very helpful tool for visualizing the entire Kanto map
- [pokeworld][pokeworld] (a very helpful tool for visualizing the entire Kanto map)
- [Polished Map map/tileset editor][polishedmap]

## Credits
Thank you to the entire [pret Discord server][pretdiscord] and these individuals who were very helpful throughout my work on this project:
- [jojobear13][jojobear13]
- [Vortyne][Vortyne]
Thank you to the entire [pret Discord server][pretdiscord], the [pret][pret] team, and these individuals who were very helpful throughout my work on this project:
- [jojobear13][jojobear13], for help with the Field Move slot implementation
- [Vortyne][Vortyne], for a lot of general pokered-related help
- [Tiptup_Tooie][tiptup], for playtesting



[pokered]: https://github.com/pret/pokered
[pret]: https://github.com/pret
[wiki]: https://github.com/pret/pokered/wiki
[pretdiscord]: https://discord.gg/d5dubZ3
[shinpokered]: https://github.com/jojobear13/shinpokered
Expand All @@ -103,4 +106,5 @@ Thank you to the entire [pret Discord server][pretdiscord] and these individuals
[polishedmap]: https://github.com/Rangi42/polished-map
[jojobear13]: https://github.com/jojobear13
[Vortyne]: https://github.com/Vortyne
[tiptup]: https://www.twitch.tv/tiptup_tooie

8 changes: 2 additions & 6 deletions docs/FEATURES.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ The differences between the three versions of this romhack (_Solus Red_, _Solus
2. Title screen Pokémon carousels (matches the original releases' carousels)
3. Game Boy Color "duochrome" palettes (matches the original releases' GBC palettes)
4. Super Game Boy palettes (which affect only title screen, SGB border graphics, and Game Corner slots)
5. End credits text: "RED/GREEN/BLUE VERSION STAFF"
5. End credits text: "RED/GREEN/BLUE VERSION STAFF" (depending on version)

## Changes and fixes
### Palette
Expand Down Expand Up @@ -264,11 +264,7 @@ Porygon | 20 | 9999
<p align="center">
<img src="../screenshots/oak_battle.png">
</p>

2. **Rival victory speeches**
- The Rival's unused battle victory speeches, which are present in the game's code, have been implemented.
- When losing to the Rival, he now has dedicated text which prints at the end of the battle, before the whiteout.
- He isn't very nice.



[titlecarousels]: https://bulbapedia.bulbagarden.net/wiki/Game_intro#Pok%C3%A9mon_Red,_Green,_and_Blue
Expand Down
8 changes: 4 additions & 4 deletions docs/INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

This guide explains how to set up the tools required to build **Pokémon Solus RGB**, including [rgbds](https://github.com/gbdev/rgbds), which assembles the source files into three ROMs:

- `pokered.gbc`
- `pokegreen.gbc`
- `pokeblue.gbc`
- `pokesolusred.gbc`
- `pokesolusgreen.gbc`
- `pokesolusblue.gbc`

### Jump to instructions for
- [Windows 10](#windows-10)
Expand Down Expand Up @@ -154,7 +154,7 @@ git clone https://github.com/Dechrissen/poke-solus-rgb
cd poke-solus-rgb
```

To build `pokered.gbc`, `pokegreen.gbc` and `pokeblue.gbc`:
To build `pokesolusred.gbc`, `pokesolusgreen.gbc` and `pokesolusblue.gbc`:

```bash
make
Expand Down

0 comments on commit c90d6db

Please sign in to comment.