Hello everyone,
I'm excited to announce the release of the Pokémon Reborn Access (PRA) project, a collection of mods designed to significantly enhance the experience for blind and visually impaired players using the "blindstep" password.
This project was inspired by the amazing Pokémon Access scripts for the GBA games and aims to bring a similar level of navigation and information access to the rich, complex world of Pokémon Reborn.
## Contents
The project is modular. You can choose to install the features you want.
- **Pathfinding Mod (`pra-pathfind.rb`)**: Provides a scanner to find and get pathfinding directions to events on the map. Includes a category filtering system and the ability to find paths across water (Surf and Waterfall).
- **Accessible Summary Mod (`pra-accessible-summary.rb`)**: Adds an accessible, text-based summary screen to the Pokémon party and PC storage menus.
- **Gone Fishing Mod (`pra-gone-fishing.rb`)**: Automates the fishing mini-game by removing the need to press a button when a Pokémon bites.
- **Terra Readability Mod ('Terra Translation Files > blindstep.dat & Settings.rb'): Replaces all instances of Terra's leet speech with English for improved readability and text-to-speech compatibility
## Controls
### Map Controls
- **F5**: Refresh the scanner's list of events on the current map.
- **O and I**: Cycle forward and backward through event filters. The available filters are: All, Connections, NPCs, Items, Merchants, Signs, and Hidden Items.
- **J, K and L**: Announce previous, current, and next event in the events list.
- **Shift + P**: Announce the X and Y coordinates of the selected event, as well as a description, if any exists.
- **P**: Announce the path for the selected event.
- **H**: Cycle through HM pathfinding modes. The available modes are: `Off`, `Surf Only`, and `Surf & Waterfall`.
- **Shift + H**: Toggle distance sorting of events on or off.
- **Shift + K**: Rename the selected event.
### Pokémon Party Menu Controls
When you open the menu for a Pokémon in your party, a new option is available:
- **Accessible Summary**: Selecting this opens a sub-menu with three choices:
- **Display BST**: Reads the Pokémon's species, form, typing, base stats, and abilities.
- **Pokemon Details**: Reads more in-depth information, including level, held item, nature, IVs, EVs, and moves.
- **Export Team**: Exports your party to a file in pokepaste format.
### Pokémon PC Menu Controls
The "Accessible Summary" option is also available when you select a Pokémon in a PC box. It provides the "Display BST" and "Pokemon Details" sub-options.
## Installation
### Download the Game
1. [Download the game here](https://www.rebornevo.com/pr/index.html/).
2. Extract the ZIP folder and run the game.
3. If prompted, apply updates. If updates break the mod, please [submit an issue](https://github.com/fclorenzo/pkreborn-access/issues).
4. When asked for special instructions, choose “Yes” and enter the password "blindstep" to enable in-game accessibility features.
### Install the Mods
1. Download the mod files by going to [the latest release page](https://github.com/fclorenzo/pkreborn-access/releases/latest).
2. Locate the "assets" section.
3. Under that section, you will find the mod files: "pra-pathfind.rb" and "pra-accessible-summary.rb". Download the files for the features you wish to use. You can install one or both.
4. Finally, create a folder called "Mods" inside the "patch" folder of your game, usually something like "Reborn-xxx-windows>patch" (where "xxx" corresponds to your game version), and paste the file(s) you just downloaded there.
5. For Terra Readability mod, you will need to place the blindstep.dat file in your 'Data' folder. Specifically the root folder, this will not work in a 'patch > Data' folder. The Settings.rb file needs to replace the Settings.rb file in your 'Scripts' root folder. If you are using other mods that influence or replace the Settings.rb file, you can also manually make the change needed by copying:
'LANGUAGES = [
["Default", "default.dat"],
["Blindstep", "blindstep.dat"]
]'
and replacing the existing language Array found on line 327 then saving the file. On start-up the game will prompt you to pick either Default or Blindstep as a language.
## Custom Event Naming (Community Project)
**The Problem:** As many players know, the scanner often announces generic event names like "ev12" or "Interactable object." This makes it difficult to know what you are navigating to.
**The Solution:** This feature allows the mod to read from a simple text file, `pra-custom-names.txt`, to replace those generic names with meaningful, human-readable ones (e.g., "Rival Battle 1" or "Hidden Moon Stone"). This file is a collaborative community effort, and your contributions are what will make it great.
### How to Use the Community Names File
1. **Download the File:**
- **a.** Open the link to the community file: **[Custom community file](https://docs.google.com/document/d/1OCNpQe4GQEQAycn-1AK4IINBfW09BkNd49YbTn7hiv0/edit?usp=sharing)**
- **b.** In the menu bar at the top of the page, select **File**.
- **c.** From the File menu, move your cursor down to **Download**.
- **d.** A new sub-menu will appear. From this list, select **Plain Text (.txt)**.
- **e.** Your browser will now download the file.
2. **Place and Rename the File:**
- Find the file you just downloaded.
- Make sure the file is named exactly **`pra-custom-names.txt`**.
- Place this renamed file into your main Pokémon Reborn game folder (the same folder that contains `Game.exe`). The mod will automatically detect and load it the next time you start the game.
### How to Find Event Information
If you want to find an event in the file or manually add a new one, you first need to get its unique identifiers. The mod makes this easy:
1. Use the **J** and **L** keys to select the event with the scanner.
2. Press **Shift + P** to hear the event's coordinates (e.g., "Coordinates: X 36, Y 29").
3. Press the **D** key to hear the map information (e.g., "Map 586, Azurine Island").
You now have all the information (`map_id`, `coord_x`, and `coord_y`) you need to find or add that specific event in the `pra-custom-names.txt` file.
### File Format Explained
The `pra-custom-names.txt` file is a simple text file that uses a semicolon (`;`) to separate its columns. Each line represents a single event.
| Column | Name | Required? | Description |
| :--- | :--- | :--- | :--- |
| 1 | `map_id` | **Yes** | The unique ID number of the map the event is on. |
| 2 | `optional_map_name` | No | The name of the map (for human readability). The mod doesn't use this. |
| 3 | `coord_x` | **Yes** | The event's X coordinate on the map. |
| 4 | `coord_y` | **Yes** | The event's Y coordinate on the map. |
| 5 | `event_name` | **Yes** | The new, meaningful name you want the mod to announce. |
| 6 | `optional_description`| No | An optional description. This is announced when you press `Shift+P`. |
**Example:**
``` plaintext
# map_id;optional_map_name;coord_x;coord_y;event_name;optional_description
586;Azurine Island;36;29;Pokemon Trainer;Battle, mandatory.
```
### Naming Events & Contributing to the Community File
This feature allows you to replace generic event names like "ev12" with meaningful ones. You can create your own personal names for events, and we highly encourage you to contribute these names to the community file so everyone can benefit.
#### How to Create Your Own Custom Names
This is the primary method for both personal use and for contributing.
1. While in-game, find an event you want to name and select it with the scanner using the **J** and **L** keys.
2. Press **Shift + K**.
3. A text box will appear, prompting you for a new name.
4. A second text box will then appear, prompting for an optional but highly recommended description.
After you're done, the mod automatically gathers the Map ID, Map Name, and coordinates, and saves a perfectly formatted entry to your local `pra-custom-names.txt` file, located in your main Pokémon Reborn folder.
#### How to Contribute to the Community File
The easiest and best way to contribute is to use the in-game renaming feature first. This prevents any typos in the map or coordinate data.
1. **Rename an Event In-Game:** Follow the steps above to give a meaningful name to a generic event.
2. **Find Your Local File:** Open the `pra-custom-names.txt` file located in your main Pokémon Reborn game folder.
3. **Copy the New Line:** Find the new line that was just added for the event you renamed. It will look something like this:
`586;Azurine Island;36;29;Pokemon trainer;Battle, mandatory.`
4. **Paste into the Community Doc:** Copy that entire line and paste it into a new line in the community Google Doc.
- **Link to the Community Google Doc:** **[Custom community file](https://docs.google.com/document/d/1OCNpQe4GQEQAycn-1AK4IINBfW09BkNd49YbTn7hiv0/edit?usp=sharing)**
**Important Rule:** Please do not use semicolons (`;`) in the names or descriptions you create, as this character is used to separate the data fields.
For those new to using Google Docs with a screen reader, this guide is a fantastic resource: [Google Docs and NVDA Guide](https://docs.google.com/document/d/1J1oXAtwC7h8FpEY52TQWBwthTeAvdSv93RacuxkM0Rs/pub)
Also, do note that, while the document can be publicly viewed, only allowed people have editing permissions. If you are a new contributor and would like to be able to edit the document, just request editing access via the Docs menu and message me on Discord so I can know you are not a random person who requested that.
## Report a Problem or Suggest a Feature
If you find a bug or documentation issue, or just want to suggest a feature, your contribution is appreciated! Please use the [issues page](https://github.com/fclorenzo/pkreborn-access/issues) after checking for duplicates,
Or post in [the mod's forum thread](https://www.rebornevo.com/forums/topic/79433-pokemon-reborn-access-pra-mods-to-enhance-accessibility-in-pokemon-reborn/).
You can also join the [Reborn server](https://www.rebornevo.com/discord/invite/rebornevo/) on Discord, and post in the `#zero-vision-reborn-blindstep` channel, or even dm me there.
## Known Bugs
- Pathfinding may fail on complex routes that require multiple land/water transitions or other complex situations (e.g., island hopping, or platform jumping).
- Pathfinder is not able to find routes inside Nightclub.
- Event cycling in wasteland makes the game music break.
## Contributing
Contributions from other developers are welcome and greatly appreciated\! If you have an idea for a new feature or a bug fix, here's how you can help.
1. **Fork the Repository**: Start by creating your own copy (a "fork") of the project on GitHub.
2. **Create a New Branch**: Make all your changes on a dedicated branch in your fork, not on the `main` branch. This makes it easier to review and merge your changes.
3. **Make Your Changes**: Implement your new feature or bug fix in the code.
4. **Submit a Pull Request**: When your changes are ready, submit a "Pull Request" from your branch to the main project. Please provide a clear description of the changes you've made.
For simple bug reports and feature suggestions, please continue to use the [issues page](https://www.google.com/search?q=%23report-a-bug-or-suggest-a-feature).
## Credits
- [Aironfaar's Mod Box](https://www.rebornevo.com/forums/topic/40480-aironfaars-mod-box-e19updated-2022-05-22/) — for the original Gone Fishing mod.
- [Torre's Decat](https://www.rebornevo.com/forums/topic/59095-torres-madness-modpacks-debug-rogue-mod-stat-display-qol-bug-patching/) — for the accessible displaying of pokémon stats and team exporting.
- [Malta10's pathfinding mod](https://www.rebornevo.com/forums/topic/55210-accessibility-mod-pack-reborn/) — for the original pathfinding mod implementation.
- [The Pokémon Access Project](https://github.com/nuive/pokemon-access) — for inspiring the idea to build something similar for Reborn.
- [Enu](https://www.rebornevo.com/forums/profile/55272-enu/) — for helping me to understand Reborn's codebase.
- [KilehKa] — for translating Terra's dialogue.
- The blindstep channel in the [reborn Discord server](https://www.rebornevo.com/discord/invite/rebornevo/) — for beta testing, suggesting features, and valuable feedback.
---
Happy gaming!
Hello everyone, I'm excited to announce the release of the Pokémon Reborn Access (PRA) project, a collection of mods designed to significantly enhance the experience for blind and visually impaired players using the "blindstep" password. This project was inspired by the amazing Pokémon Access scripts for the GBA games and aims to bring a similar level of navigation and information access to the rich, complex world of Pokémon Reborn. ## Contents The project is modular. You can choose to install the features you want. - **Pathfinding Mod (`pra-pathfind.rb`)**: Provides a scanner to find and get pathfinding directions to events on the map. Includes a category filtering system and the ability to find paths across water (Surf and Waterfall). - **Accessible Summary Mod (`pra-accessible-summary.rb`)**: Adds an accessible, text-based summary screen to the Pokémon party and PC storage menus. - **Gone Fishing Mod (`pra-gone-fishing.rb`)**: Automates the fishing mini-game by removing the need to press a button when a Pokémon bites. - **Terra Readability Mod ('Terra Translation Files > blindstep.dat & Settings.rb'): Replaces all instances of Terra's leet speech with English for improved readability and text-to-speech compatibility ## Controls ### Map Controls - **F5**: Refresh the scanner's list of events on the current map. - **O and I**: Cycle forward and backward through event filters. The available filters are: All, Connections, NPCs, Items, Merchants, Signs, and Hidden Items. - **J, K and L**: Announce previous, current, and next event in the events list. - **Shift + P**: Announce the X and Y coordinates of the selected event, as well as a description, if any exists. - **P**: Announce the path for the selected event. - **H**: Cycle through HM pathfinding modes. The available modes are: `Off`, `Surf Only`, and `Surf & Waterfall`. - **Shift + H**: Toggle distance sorting of events on or off. - **Shift + K**: Rename the selected event. ### Pokémon Party Menu Controls When you open the menu for a Pokémon in your party, a new option is available: - **Accessible Summary**: Selecting this opens a sub-menu with three choices: - **Display BST**: Reads the Pokémon's species, form, typing, base stats, and abilities. - **Pokemon Details**: Reads more in-depth information, including level, held item, nature, IVs, EVs, and moves. - **Export Team**: Exports your party to a file in pokepaste format. ### Pokémon PC Menu Controls The "Accessible Summary" option is also available when you select a Pokémon in a PC box. It provides the "Display BST" and "Pokemon Details" sub-options. ## Installation ### Download the Game 1. [Download the game here](https://www.rebornevo.com/pr/index.html/). 2. Extract the ZIP folder and run the game. 3. If prompted, apply updates. If updates break the mod, please [submit an issue](https://github.com/fclorenzo/pkreborn-access/issues). 4. When asked for special instructions, choose “Yes” and enter the password "blindstep" to enable in-game accessibility features. ### Install the Mods 1. Download the mod files by going to [the latest release page](https://github.com/fclorenzo/pkreborn-access/releases/latest). 2. Locate the "assets" section. 3. Under that section, you will find the mod files: "pra-pathfind.rb" and "pra-accessible-summary.rb". Download the files for the features you wish to use. You can install one or both. 4. Finally, create a folder called "Mods" inside the "patch" folder of your game, usually something like "Reborn-xxx-windows>patch" (where "xxx" corresponds to your game version), and paste the file(s) you just downloaded there. 5. For Terra Readability mod, you will need to place the blindstep.dat file in your 'Data' folder. Specifically the root folder, this will not work in a 'patch > Data' folder. The Settings.rb file needs to replace the Settings.rb file in your 'Scripts' root folder. If you are using other mods that influence or replace the Settings.rb file, you can also manually make the change needed by copying: 'LANGUAGES = [ ["Default", "default.dat"], ["Blindstep", "blindstep.dat"] ]' and replacing the existing language Array found on line 327 then saving the file. On start-up the game will prompt you to pick either Default or Blindstep as a language. ## Custom Event Naming (Community Project) **The Problem:** As many players know, the scanner often announces generic event names like "ev12" or "Interactable object." This makes it difficult to know what you are navigating to. **The Solution:** This feature allows the mod to read from a simple text file, `pra-custom-names.txt`, to replace those generic names with meaningful, human-readable ones (e.g., "Rival Battle 1" or "Hidden Moon Stone"). This file is a collaborative community effort, and your contributions are what will make it great. ### How to Use the Community Names File 1. **Download the File:** - **a.** Open the link to the community file: **[Custom community file](https://docs.google.com/document/d/1OCNpQe4GQEQAycn-1AK4IINBfW09BkNd49YbTn7hiv0/edit?usp=sharing)** - **b.** In the menu bar at the top of the page, select **File**. - **c.** From the File menu, move your cursor down to **Download**. - **d.** A new sub-menu will appear. From this list, select **Plain Text (.txt)**. - **e.** Your browser will now download the file. 2. **Place and Rename the File:** - Find the file you just downloaded. - Make sure the file is named exactly **`pra-custom-names.txt`**. - Place this renamed file into your main Pokémon Reborn game folder (the same folder that contains `Game.exe`). The mod will automatically detect and load it the next time you start the game. ### How to Find Event Information If you want to find an event in the file or manually add a new one, you first need to get its unique identifiers. The mod makes this easy: 1. Use the **J** and **L** keys to select the event with the scanner. 2. Press **Shift + P** to hear the event's coordinates (e.g., "Coordinates: X 36, Y 29"). 3. Press the **D** key to hear the map information (e.g., "Map 586, Azurine Island"). You now have all the information (`map_id`, `coord_x`, and `coord_y`) you need to find or add that specific event in the `pra-custom-names.txt` file. ### File Format Explained The `pra-custom-names.txt` file is a simple text file that uses a semicolon (`;`) to separate its columns. Each line represents a single event. | Column | Name | Required? | Description | | :--- | :--- | :--- | :--- | | 1 | `map_id` | **Yes** | The unique ID number of the map the event is on. | | 2 | `optional_map_name` | No | The name of the map (for human readability). The mod doesn't use this. | | 3 | `coord_x` | **Yes** | The event's X coordinate on the map. | | 4 | `coord_y` | **Yes** | The event's Y coordinate on the map. | | 5 | `event_name` | **Yes** | The new, meaningful name you want the mod to announce. | | 6 | `optional_description`| No | An optional description. This is announced when you press `Shift+P`. | **Example:** ``` plaintext # map_id;optional_map_name;coord_x;coord_y;event_name;optional_description 586;Azurine Island;36;29;Pokemon Trainer;Battle, mandatory. ``` ### Naming Events & Contributing to the Community File This feature allows you to replace generic event names like "ev12" with meaningful ones. You can create your own personal names for events, and we highly encourage you to contribute these names to the community file so everyone can benefit. #### How to Create Your Own Custom Names This is the primary method for both personal use and for contributing. 1. While in-game, find an event you want to name and select it with the scanner using the **J** and **L** keys. 2. Press **Shift + K**. 3. A text box will appear, prompting you for a new name. 4. A second text box will then appear, prompting for an optional but highly recommended description. After you're done, the mod automatically gathers the Map ID, Map Name, and coordinates, and saves a perfectly formatted entry to your local `pra-custom-names.txt` file, located in your main Pokémon Reborn folder. #### How to Contribute to the Community File The easiest and best way to contribute is to use the in-game renaming feature first. This prevents any typos in the map or coordinate data. 1. **Rename an Event In-Game:** Follow the steps above to give a meaningful name to a generic event. 2. **Find Your Local File:** Open the `pra-custom-names.txt` file located in your main Pokémon Reborn game folder. 3. **Copy the New Line:** Find the new line that was just added for the event you renamed. It will look something like this: `586;Azurine Island;36;29;Pokemon trainer;Battle, mandatory.` 4. **Paste into the Community Doc:** Copy that entire line and paste it into a new line in the community Google Doc. - **Link to the Community Google Doc:** **[Custom community file](https://docs.google.com/document/d/1OCNpQe4GQEQAycn-1AK4IINBfW09BkNd49YbTn7hiv0/edit?usp=sharing)** **Important Rule:** Please do not use semicolons (`;`) in the names or descriptions you create, as this character is used to separate the data fields. For those new to using Google Docs with a screen reader, this guide is a fantastic resource: [Google Docs and NVDA Guide](https://docs.google.com/document/d/1J1oXAtwC7h8FpEY52TQWBwthTeAvdSv93RacuxkM0Rs/pub) Also, do note that, while the document can be publicly viewed, only allowed people have editing permissions. If you are a new contributor and would like to be able to edit the document, just request editing access via the Docs menu and message me on Discord so I can know you are not a random person who requested that. ## Report a Problem or Suggest a Feature If you find a bug or documentation issue, or just want to suggest a feature, your contribution is appreciated! Please use the [issues page](https://github.com/fclorenzo/pkreborn-access/issues) after checking for duplicates, Or post in [the mod's forum thread](https://www.rebornevo.com/forums/topic/79433-pokemon-reborn-access-pra-mods-to-enhance-accessibility-in-pokemon-reborn/). You can also join the [Reborn server](https://www.rebornevo.com/discord/invite/rebornevo/) on Discord, and post in the `#zero-vision-reborn-blindstep` channel, or even dm me there. ## Known Bugs - Pathfinding may fail on complex routes that require multiple land/water transitions or other complex situations (e.g., island hopping, or platform jumping). - Pathfinder is not able to find routes inside Nightclub. - Event cycling in wasteland makes the game music break. ## Contributing Contributions from other developers are welcome and greatly appreciated\! If you have an idea for a new feature or a bug fix, here's how you can help. 1. **Fork the Repository**: Start by creating your own copy (a "fork") of the project on GitHub. 2. **Create a New Branch**: Make all your changes on a dedicated branch in your fork, not on the `main` branch. This makes it easier to review and merge your changes. 3. **Make Your Changes**: Implement your new feature or bug fix in the code. 4. **Submit a Pull Request**: When your changes are ready, submit a "Pull Request" from your branch to the main project. Please provide a clear description of the changes you've made. For simple bug reports and feature suggestions, please continue to use the [issues page](https://www.google.com/search?q=%23report-a-bug-or-suggest-a-feature). ## Credits - [Aironfaar's Mod Box](https://www.rebornevo.com/forums/topic/40480-aironfaars-mod-box-e19updated-2022-05-22/) — for the original Gone Fishing mod. - [Torre's Decat](https://www.rebornevo.com/forums/topic/59095-torres-madness-modpacks-debug-rogue-mod-stat-display-qol-bug-patching/) — for the accessible displaying of pokémon stats and team exporting. - [Malta10's pathfinding mod](https://www.rebornevo.com/forums/topic/55210-accessibility-mod-pack-reborn/) — for the original pathfinding mod implementation. - [The Pokémon Access Project](https://github.com/nuive/pokemon-access) — for inspiring the idea to build something similar for Reborn. - [Enu](https://www.rebornevo.com/forums/profile/55272-enu/) — for helping me to understand Reborn's codebase. - [KilehKa] — for translating Terra's dialogue. - The blindstep channel in the [reborn Discord server](https://www.rebornevo.com/discord/invite/rebornevo/) — for beta testing, suggesting features, and valuable feedback. --- Happy gaming!