Community Guide

Notice: This wiki itself has now become a community-driven guide! Page splitting and refactoring are under way.

↪️ Top page

---

This page lists various things from studies by Polished Crystal players.

Disclaimers

• Since this is a community-driven guide, it does NOT guarantee up-to-date or 100%-accurate information.
• The master is always the official source code in this repository with commented-out documentations. You'll want to delve into it with the searching functions described below.
• The official documents such as README and FAQ help you a lot as well, which are now being updated.
  • That update campaign is also summing up the differences between Polished and "Faithful" Polished but hasn't finished it yet; see the full list of conditionals for Faithful (via GitHub's search function) instead, as shown in FAQ.
  • The changelog document needs more updates with summaries as well; see the commit history instead.
• The game assumes that you're familiar with the main series games (MSGs), so you'll also want to learn about the game mechanics of the MSGs somewhere else.

General notice

Main article: FAQ § Which file do I need to play?

• Be sure to play the latest build, namely v3.0.0-beta (as of Mar. 2021). You can run a full playthrough there, with some WIP elements for additional side quests and features.
• Do NOT play the debug build unless you're going to work for the devs.
• v2.2.0 was fixed in Sept. 2016—it's obsolete and out of support.
• An upgrade of your save file from v2.2.0 to v3.0.0-beta is NOT available.
• Cheating is NOT officially supported. See the .sym file guide for details.

Contents

• Searching on GitHub

Searching on GitHub

FAQ lists most of the data you'll want to know, but you might as well want to look something up in the source code by yourself, e.g. items, trainers, flags, and procedures such as ifs and thens. GitHub's search functions come in handy for that purpose in your browser. Note that mobile browsers might put them in the toggle menu.

To search through the source code with…

• Code strings: Go to the search box, which performs a case-insensitive search. You might also want to add extension:asm qualifier to narrow the results.
• File names: Press the "Go to file" button to open the file finder. You can also use filename: qualifier in the search box.

The search-box results will only show you snippets. (See also GitHub's help page on searching.) You might as well open the link to have the page display the code lines for you to read through.

Polished follows pokecrystal's style guide for coding, e.g. constants in SCREAMING_SNAKE_CASE and labels in PascalCase.

Command line users can grep (or git grep), of course.

Search examples

• The search box: ice_stone (or ice stone, a space in-between) ➡️ maps with the item(s), etc.
• The file finder: ice_stone (or icestone, no other symbols in-between) ➡️ ice_stone.png, etc.