update documentation for new release v1.1

README.md

@@ -6,7 +6,7 @@
 <img src="screenshots/solusblue.bmp">
 </p>
 
-A romhack of Pokémon Red/Blue for Game Boy, based on the Pokémon Reverse Engineering Team's [disassembly of Pokémon Red and Blue][pokered].
+A near-vanilla "purist" romhack of Pokémon Red/Blue for Game Boy, with a focus on an enhanced **solo gameplay experience**. It is based on the Pokémon Reverse Engineering Team's [disassembly of Pokémon Red and Blue][pokered].
 
 For a detailed summary of all the changes in this romhack, check out the [feature log][featurelog].
 
@@ -20,9 +20,9 @@ Just want the patch? Go [here][releases].
 
 ## Versions
 
-There are three versions of this romhack: _Solus Red_, _Solus Green_, and _Solus Blue_. The differences between versions are solely cosmetic (palettes, title screen text, etc.), as this project consolidates any of the meaningful version-specific differences that existed across versions, such as Pokémon availability. For a complete list of version differences, check the ["Version differences" section of the feature log][versiondifferences].
+There are three versions of this romhack: _Solus Red_, _Solus Green_, and _Solus Blue_. The differences between versions are solely cosmetic (palettes, title screen text, etc.), as this project consolidates any of the meaningful version-specific differences that existed across versions, such as Pokémon availability. For a complete list of version differences, check the ['Version differences' section of the feature log][versiondifferences].
 
-[Building from source](#installation) will yield three ROMs:
+[Building from source](#building-all-three-roms-from-source) will yield three ROMs:
 
 - Solus Red (`pokesolusred.gbc`)
 - Solus Green (`pokesolusgreen.gbc`)
@@ -48,15 +48,12 @@ Solus Green is inspired by the original Japanese release of Green Version. If pl
 > - the Pokémon can be purchased
 > - the Pokémon can be restored from a fossil
 
-
-
 #### 2. HMs can be taught to party Pokémon without using up one of their move slots
 
 > HMs, as well as TM28 (Dig), TM30 (Teleport), and TM41 (Softboiled), can be taught to a party Pokémon in a separate "Field Move" slot. When teaching one of these moves to a Pokémon, you will be prompted to choose whether it should be taught as its temporary Field Move (only one can be known at a time per Pokémon). Field Moves can be used like other HMs as normal, from a Pokémon's party sub-menu.
 
 > When a Pokémon with a temporary Field Move is deposited into the PC, its Field Move will be erased. Those three TMs which act as Field Moves (Dig, Teleport, and Softboiled) are now sold on the 2nd floor of Celadon Dept. Store, because they might be lost more easily if taught as a Field Move and then erased via PC deposit.
 
-
 #### 3. Some new content is added, and some visual content is changed
 
 > A _very small amount_ of new battles/signs/houses/NPCs were added. They are either added to restore cut content, or to support a newly implemented feature. To see them all, please check the ['New content' section of the feature log][newcontent].  
@@ -65,7 +62,7 @@ Solus Green is inspired by the original Japanese release of Green Version. If pl
 
 #### 4. Some bugs/oversights are fixed
 
-> A small subset of the bugs/oversights from the vanilla games are fixed. Visit the [feature log][featurelog] for details.
+> A small subset of the bugs/oversights from the vanilla games are fixed. Check the [feature log][featurelog] for details.
 
 ## Installation
 
@@ -82,10 +79,14 @@ If you're new to the [`pokered`][pokered] disassembly, learn how to install prer
 
 Otherwise, if your environment for building the vanilla ROMs is already set up, the procedure here is the same. Just clone this repository, `cd` into it, and run `make`.
 
+#### Modifying this romhack
+If you want to make some tweaks to this romhack before building the ROMs, or if you want to use this romhack as a starting point for your own, read [this document][howtomod] that I've written.
+
 ## Links
 
-- The original [pokered][pokered] disassembly which this romhack is based on
 - Detailed [feature log][featurelog] containing all of the changes this romhack makes to the vanilla game
+- [Changelog][changelog] for an overview of the changes introduced in each Solus RGB release
+- The original [pokered][pokered] disassembly which this romhack is based on
 - 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)
@@ -121,7 +122,9 @@ I'd greatly appreciate any form of support!
 [newcontent]: docs/FEATURES.md#new-content
 [versiondifferences]: docs/FEATURES.md#version-differences
 [installation]: docs/INSTALL.md
+[howtomod]: docs/HOW-TO-MOD.md
 [patches]: /patches
+[changelog]: docs/CHANGELOG.md
 [releases]: https://github.com/Dechrissen/poke-solus-rgb/releases
 [pokeworld]: https://www.extratricky.com/pokeworld/rb/1
 [polishedmap]: https://github.com/Rangi42/polished-map
@@ -130,5 +133,4 @@ I'd greatly appreciate any form of support!
 [tiptup]: https://www.twitch.tv/tiptup_tooie
 [blogpost]: https://derekandersen.net/blog/pokemon-solus-rgb
 [kofi]: https://ko-fi.com/dechrissen
-[romhackplaza]: https://romhackplaza.org/romhacks/pokemon-solus-rgb-game-boy/
-
+[romhackplaza]: https://romhackplaza.org/romhacks/pokemon-solus-rgb-game-boy/

docs/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Pokémon Solus RGB: Changelog
+
+This document provides an overview of the changes made in each release.
+
+## v1.1
+- Pokémon learnsets, catch rates, and Level 1 moves have been updated to match those in Yellow Version
+
+## v1.0
+- Custom title screens for each of the 3 versions
+- Green version-specific GBC and SGB palette changes for Solus Green
+- All 151 Pokémon are obtainable
+- Mew as a static battle
+- An in-game trader NPC who will help you evolve the 4 trade evolutions lives in Celadon City
+- HMs can be taught to party Pokémon in separate Field Move slots
+- Battle sprites have been updated
+    - Back sprites are now 48x48
+    - Some front sprites have been updated to ones from other releases of the Gen 1 games
+- Post-game Professor Oak battle
+- Battle theme changes for some Elite Four members
+- A few vanilla bugfixes

docs/FEATURES.md

@@ -1,16 +1,18 @@
 # Pokémon Solus RGB: Feature Log
-This file details all the changes the Pokémon Solus RGB romhack makes to the vanilla Pokémon Red/Blue games.
+This file details all the changes the Pokémon Solus RGB romhack makes to the vanilla Pokémon Red/Blue games. To compare previous releases, check the [changelog](CHANGELOG.md).
 
 **SPOILER WARNING**: While this romhack takes minimal creative liberties and doesn't add _too many_ new things, the entirety of this document could be considered a spoiler. If you don't want to be spoiled to any of the changes, then don't read this document.
 
 ## Table of Contents
+- [Motivation](#motivation)
 - [Justifications](#justifications)
 - [Version differences](#version-differences)
 - [Changes and fixes](#changes-and-fixes)
     - [Palette](#palette)
     - [Title screen](#title-screen)
     - [Battle sprites](#battle-sprites)
     - [Wild encounters](#wild-encounters)
+    - [Learnsets](#learnsets)
     - [Game Corner](#game-corner)
     - [Music](#music)
     - [Text](#text)
@@ -20,9 +22,23 @@ This file details all the changes the Pokémon Solus RGB romhack makes to the va
     - [New features](#new-features-that-were-not-in-the-vanilla-games)
     - [Restored cut content](#cut-content-that-has-been-restored)
 
+## Motivation
+
+This romhack is very much a "my version" of Gen 1. You could also consider it a "purist's version". The decisions made were inspired by _my idea_ of what an "enhanced" version of Gen 1 would look like. I wanted to make this romhack so that I could actually use it for my own personal routine playthroughs of Gen 1 every few months.
+
+The modifications mostly consist of logical changes to address some problems which most people would agree _are_ problems, with a sprinkling of my personal preferences on top (such as changing some battle sprites to ones from other Gen 1 games). I also didn't want to go overboard fixing bugs. A lot of the vanilla bugs can be seen as contributing to what makes Gen 1 special. All of this to say: you might not agree with some of my decisions!
+
+Q: What is this romhack trying to solve?
+
+> This romhack hopes to solve the following general "issue" categories in vanilla Gen 1:
+> 1. All 151 Pokémon are not obtainable in one game
+> 2. Pokémon with the "trade" evolution method cannot be evolved except with a friend's help, or by using two cartridges
+> 3. HMs compromise a Pokémon's potential by occupying its battle move slots
+> 4. Some bugs exist which arguably detract from the developers' original vision for the games (those bugs in the codebase which change some gameplay element from what is very likely the intended behavior) 
+
 ## Justifications
 
-This romhack is very much a "my version" of Gen 1. The decisions made were inspired by _my idea_ of what an "enhanced" version of Gen 1 would look like. It's mostly logical changes, with a sprinkling of my personal preferences on top (such as changing some battle sprites to ones from other Gen 1 games). I also didn't want to go overboard fixing bugs. A lot of the vanilla bugs can be seen as contributing to what makes Gen 1 special. All of this to say: you might not agree with some of my decisions!
+Here are some questions which might be asked about the decisions made for this romhack.
 
 Q: Why is it called Solus?
 > The definition of 'solus' is something like: 'By oneself; alone. Used as a stage direction to a male character.'
@@ -179,6 +195,20 @@ Porygon | Red/Green (JPN)
 - The number of wild encounters slots per route has been increased from 10 to 12, in order to make room for those maps which needed an extra slot to accommodate the opposite version's exclusive Pokémon. For the maps which didn't need any adjusting for version exclusives, I simply took the 3rd slot (previously 15%, but dropped by 5% to 10%) and copied that Pokémon into the new 2nd-to-last and 3rd-to-last slots
 (4% and 1% respectively). This means the distributions are almost identical to the originals, +/- a fraction of a %.
 
+### Learnsets
+Learnsets (level-up moves and teachable TMs/HMs) and catch rates for all Pokémon have been updated to match those used in Yellow version. For a look at the full diff for this change, check [this commit](https://github.com/Dechrissen/poke-solus-rgb/commit/99459edfa1d797d72a273c8a412545fe85f08594).
+
+The updated learnsets are not _too_ signifiant. Some changes are nice, however. Notable updates are:
+- Charizard can learn HM Fly
+- Diglett and Dugtrio can learn HM Cut
+- Kabutops can learn HM Cut
+- Venonat, Venomoth, and Butterfree can learn HM Flash
+- Nidoran learns Double Kick at Level 12 instead of 43 (Nidorino/Nidorina as well)
+- Mankey learns Low Kick at Level 9
+- Venonat learns Confusion at Level 19
+- Pikachu has an expanded learnset including Thunderbolt at Level 26
+- The Eevee-lutions learn their damaging STAB moves at earlier levels
+
 ### Game Corner
 The Game Corner prize windows have been changed. The tables below reflect these changes.
 #### Prize window 1
@@ -196,10 +226,10 @@ Eevee | 15 | 6666
 Porygon | 20 | 9999
 
 ### Music
-- The Elite Four now all use the Gym Leader battle theme instead of using the default battle theme for the first three members (Lorelei, Bruno, Agatha).
+The Elite Four now all use the Gym Leader battle theme instead of using the default battle theme for the first three members (Lorelei, Bruno, Agatha).
 
 ### Text
-- There is a game-related poster on 3F of Celadon Dept. Store which now reads "Red, Green, and Blue! All are Pokémon!" instead of "Red and Blue! Both are Pokémon!" to be consistent with the triad of versions.
+There is a game-related poster on 3F of Celadon Dept. Store which now reads "Red, Green, and Blue! All are Pokémon!" instead of "Red and Blue! Both are Pokémon!" to be consistent with the triad of versions.
 
 ### Names
 The default set of names for the player and the rival have been changed. These are based on some of the original names used in the Japanese Red & Green versions, mixed with the English names Ash and Gary. (If you're curious to read more about the default names, check [this Bulbapedia article](https://bulbapedia.bulbagarden.net/wiki/Red_(game)#Optional_names).)