diff --git a/README.md b/README.md index cee7c99ac3..0dde7185fb 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,8 @@ There are several branches, each with one main feature (and sometimes some extra * PID (but not legitimacy) preserving Pokémon nature-changing function * Function to detect modern emulators/GBA hardware. +> Note: Unless you have a specific need for it, you should probably use `followers-expanded-id` over this. + **icons** branch: * Everything from the **followers** branch. * All pokemon icons updated to Gen 6, based on [this repo](https://github.com/msikma/pokesprite/tree/master/icons/pokemon/regular) @@ -32,13 +34,48 @@ There are several branches, each with one main feature (and sometimes some extra * `lighting-expanded-id` but with following pokémon code & assets completely removed. (This allows for more than 255 OW graphics) * Saves with following pokémon can safely be loaded. -Additional branches to mention: +**followers-expanded-id** branch: +* Like `followers`, but includes expands OW graphicsIds to 16-bits +in a backwards compatible way +* Includes support for compressed OW graphics + +Additional branches to mention: -* `followers-expanded-id` - like `followers`, but includes backwards-compatible 16-bit graphics IDs for object events. * `lighting-expanded-id` - like the above but for `lighting`. To set up the repository, see [INSTALL.md](INSTALL.md). +## FAQ +### `(followers*)` Q: Where are the config settings? +A: Configuration for the follower system is mostly in [event_objects.h](include/constants/event_objects.h): +```c +// If true, follower pokemon will bob up and down +// during their idle & walking animations +#define OW_MON_BOBBING TRUE + +// If true, adds a small amount of overhead +// to OW code so that large (48x48, 64x64) OWs +// will display correctly under bridges, etc. +#define LARGE_OW_SUPPORT TRUE +``` + +### `(lighting)` Q: How do I mark certain colors in a palette as light-blended? +A: Create a `.pla` file in the same folder as the `.pal` with the same name. + +In this file you can enter color indices [0,15] +on separate lines to mark those colors as being light-blended, i.e: + +`06.pla:` +``` +# A comment +0 # if color 0 is listed, uses it to blend with instead of the default! +1 +9 +10 +``` + +You might have to `make mostlyclean` or change the `.pal` file to pick up the changes. + ## See also For contacts and other pret projects, see [pret.github.io](https://pret.github.io/).