Configuration

Language: English · Українська

User-facing settings live in Settings… (Ctrl+P), ui/settings_dialog.py. On-disk: settings.json in the data folder (see Where Picoripi keeps your data; do not commit it). Optional .env is loaded at startup (core/settings_manager.py + python-dotenv) for API key env vars.

This page lists controls as the UI shows them, then the files they persist to.

Settings tabs

Global

Project (only with a project open)

Subtabs:

Changing Rules marks a rescan.

Spelling

Enable spell checking · Dictionary Language · Manage Dictionaries… (download/remove Hunspell dicts; words added via Spellcheck → Add to Dictionary).

AI Translation / AI Glossary

See 11. AI Translation. Keys belong in Settings or .env, never in git.

Default translation config (build_default_translation_config): provider disabled, workers 6, OpenAI env OPENAI_API_KEY, Gemini env GEMINI_API_KEY, OpenAI timeout 60 s, Gemini timeout 120 s.

Companion

Connection to the mobile review backend. See 12. Picoripi Companion.

Console keys

The key file of each console: 3DS, Switch, Wii, the Oodle library and the PlayStation BIOS. The BIOS row gives the font table that Castlevania: Symphony of the Night draws its Shift-JIS menu lines with; Picoripi reads it and ships no BIOS data. Picoripi keeps only the path of each file. It never shows, logs or copies the key contents. Browse... sets a path and Clear forgets it. The state line shows whether the stored file still exists. The Project Manager wizard asks for a missing key file and stores it here. Changes apply at once.

Logging

Categories: general, lifecycle, file_ops, settings, ui_action, ai, scanner, plugins.

Where Picoripi keeps your data

The first time Picoripi starts, it asks where to keep its data. The data folder holds your settings, the Project Manager list, series glossaries, plugin data and caches. Picoripi never picks a folder for you: you confirm it.

• At the top of the dialog, Language chooses the interface language. It starts in the system's language when Picoripi has it, else English, and the dialog switches at once. The choice is saved as ui_language in settings.json of the chosen folder; old settings copied in keep their language unless you change the list. Later, use the Language menu.
• The suggested folder is data, next to the program. It is portable: move the program folder and the data moves with it.
• You can choose another folder. You can also keep using your old profile folder ~/.picoripi. Copying the old data is optional. The old folder is never changed or deleted.
• Change the folder later in Settings → Global → Data folder → Data location…. Picoripi copies the data to the new folder. Restart Picoripi to use it.
• Two explicit overrides exist: the environment variable PICORIPI_HOME, and picoripi_home.json next to the program (the chooser writes it).
• Git: every data folder gets a .gitignore with a * line. Git then skips the folder, even inside a repository. If the chosen folder is in a Git repository that does not ignore it, the chooser asks first. Write .gitignore is the default. Files outside the data folder do not change.

flowchart TD
  A{PICORIPI_HOME set?} -->|yes| U[Use that folder]
  A -->|no| B{picoripi_home.json next to the program, usable?}
  B -->|yes| U
  B -->|no| C[Ask the user: chooser]
  C --> D[User confirms a folder]
  D --> W[Write picoripi_home.json]
  W --> U

The log file app_debug.txt stays next to the program unless Log File Path names another file. Short-lived temporary files use the system temp folder.

Files next to the app

What not to do

• Do not commit settings.json, .env, session files, or API keys.
• Do not switch Active Game Plugin and expect BMG load without restart.
• Do not point External Tool at a build that reads unsaved buffers — Save first.
• Do not put machine-absolute paths in wiki or README examples.

To fill extra interface languages (or to complete Ukrainian): start Gemini Web2API, then run tools/i18n-translate/run.bat. The window selects target languages; Ukrainian is on by default. After a catalog has translations, it appears in Language; the name comes from @language_name in that JSON. Missing strings stay English.