Contributing
Issues and pull requests are welcome at github.com/iDentitY4/TetsuOS.
Before a pull request
cargo testandcargo clippy --all-targetspass insrc/launcher/.- Kernel and package patches apply with Buildroot's
support/scripts/apply-patches.sh. - Say what was tested on a real device and what wasn't. Sound, feel and anything physical, like the lid, need a person holding the device.
- Add the feature's details to Feature notes (how it works, what was measured, how it was tested) and update the user guide here.
Translations
The launcher and in-game menu are translated through src/launcher/lang/. A language is:
- a file such as
lang/fr.txt, in lines ofENGLISH = TRANSLATION, with the same[max N]sections asde.txt - a variant in
settings::Language - a line in
i18n::table
Everything is in capitals in a fixed-width font, so keep within each section's length. The font has A–Z, digits, common symbols and Ä, Ö, Ü and ß; other accented capitals need glyphs in ui/font.rs. cargo test i18n reports what is missing, unused or too long. The WI-FI TRANSFER page has its own small table in transfer_page.html.
Adding a console
- A Buildroot package in
package/libretro-<core>/built from a pinned commit, added toexternal.mk,Config.inandconfigs/common.config. - An entry in
SYSTEMSinsrc/launcher/src/library/systems.rs: its key, name, extensions, core, persistence, aspect, libretro-thumbnails folder, cheat folder and RetroAchievements console ID. The order ofSYSTEMSis the order of the tiles. - A pictogram in
ui/icons.rs, and a bezel colour inlibretro/border.rsfor a handheld. - Check
launcher --core-optionsfor the core's options, and whether it needs anyFRONTEND_DEFAULTS. - Test on the device: speed (
/var/log/launcher.loghas fps and underruns), save states, resume and its save files.
Avoid extensions another console already uses (such as .bin): the launcher decides the console by extension alone.
Adding a setting
- A field in
Settings, withchoices!for fixed choices, and lines inparseandformat. - A row in the group's
Group::settingsinlauncher.rs, withinMAX_GROUP_SETTINGS. - Its labels through
i18n::tr, with German lines. - If an init script reads it, use
/usr/libexec/setting KEY DEFAULT, which falls back tosettings-backup.txt. - Decide whether RESET SETTINGS resets it.
Documentation
This site is VitePress. Pages are Markdown in docs/:
npm install
npm run docs:dev # live preview at http://localhost:5173/TetsuOS/
npm run docs:build # static site in docs/.vitepress/distThe sidebar is in docs/.vitepress/config.mts. Screenshots in docs/public/screenshots/ are made with the launcher's --preview* flags and converted to PNG:
cd src/launcher
cargo run --release -- --preview-list /tmp/list.ppm
magick /tmp/list.ppm ../../docs/public/screenshots/list.pngPushes to main that change docs/ publish the site to GitHub Pages through .github/workflows/docs.yml.
