inkOS/DOCUMENTATION.md

📱 App Documentation

---

🔧 Home Features

Layout & Positioning

Gap between apps
Controls the gap between home app items. Font family and size can affect this spacing, so it's recommended to adjust it for better visibility.

Home Apps Y Offset
Adjusts the vertical position of home apps on the screen (makes them off-centre).

Top Widget Margin
Adjusts the top margin for the clock/date widget.

Bottom Widget Margin
Adjusts the bottom margin for the media/quote widget.

Home Alignment
Sets the horizontal alignment of home apps (Left, Center, Right).

Home Apps

Apps on Home Screen
Sets how many apps in total are featured on the home screen.

Pages on Home Screen
Determines the total number of pages. Apps will be auto-divided across pages.

Enable Page Indicator
Displays dots on the right side to indicate the current page.

Home Page Reset
When enabled, pressing the home button will reset to the 1st page (by default, it remembers your last page).

Extend Home Apps Area
Makes the full horizontal area of app names clickable.
E.g., [Calendar] → [ Calendar ]

Top Widgets

Show Clock
Enables the clock widget at the top of the home screen.

Clock Format
Choose between System, 24-hour, or 12-hour format.

Show AM/PM
Displays AM/PM indicator for 12-hour format.

Dual Clocks
Enables a second clock display.

Second Clock Offset
Sets the timezone offset for the second clock (when dual clocks is enabled).

Show Date
Displays the date widget on the home screen.

Show Battery
Enables the battery widget at the bottom of the home screen (shown with date).

Show Notification Count
Displays the count of notifications in the top widget area.

Bottom Widgets

Show Audio Widget
Widget appears when audio is playing, remains even if paused, and can be dismissed by clicking stop.

Show Quote
Enables a custom quote text widget at the bottom of the home screen.

Quote Text
Sets the custom quote text to display (only shown when quote widget is enabled).

---

🅰 Fonts

Universal Custom Font
Sets a single font family for all font-selectable items. When enabled, only text size can be modified.
Tip: Set a universal font, then disable it to customize specific fonts (e.g., a display font for the clock).

Settings Font
Controls font family for all settings menus (disabled when universal font is enabled).

Settings Text Size
Controls text size for all settings menus.

Home Fonts

Apps Font
Controls font family for home menu apps, app drawer, and hidden apps (disabled when universal font is enabled).

App Text Size
Controls text size for home menu apps.

App Name Mode
Choose between Normal, Small Caps, or All Caps for app names.

Clock Font
Controls font family for the Clock widget (disabled when universal font is enabled).

Clock Text Size
Controls text size for the Clock widget.

Date Font
Controls font family for the Date widget (disabled when universal font is enabled).

Date Text Size
Controls text size for the Date widget.

Quote Font
Controls font family for the Quote widget (disabled when universal font is enabled).

Quote Text Size
Controls text size for the Quote widget.

Label Notifications

Label Notifications Font
Controls font family for notification previews under app names (disabled when universal font is enabled).

Notifications Window

Window Title
Sets the title string for the notification window (opened by swiping left).

Title Font
Controls font family for the notification window title (disabled when universal font is enabled).

Title Size
Controls text size for the notification window title.

Body Font
Controls font family for the body text in the notification window (disabled when universal font is enabled).

Body Text Size
Controls text size for the body text in the notification window.

---

🎨 Look & Feel

Visibility & Display

Theme Mode
Switch between Light and Dark themes.

Vibration Feedback
Enables vibration feedback for gestures, apps, widgets, and interactions.

Show Status Bar
Displays the top status bar (carrier, clock, battery, Wi-Fi, Bluetooth).

Show Navigation Bar
Option to show/hide the navigation bar for fullscreen look.

Element Colors

Set Wallpaper
Opens the wallpaper selection screen to set a custom background image.

Background Opacity
Adjusts the opacity of the background color (0-255), which in turn controls how visible the background image is. Lower values make the background color more transparent, allowing the image to show through more clearly. Higher values make the background color more opaque, obscuring the image.

Background Color
Allows setting a custom background color.
Recommended only for AMOLED displays. Not suitable for e-ink screens.

Text Color
Allows setting a custom text color.
Recommended only for AMOLED displays. Not suitable for e-ink screens.

Reset
Resets all element colors to default (black/white based on theme).

Text Islands

Enable Text Islands
Enables rounded/pill-shaped backgrounds behind text elements.

Invert Islands
Inverts the colors of text islands (white text on black background becomes black text on white background).

Icons & Buttons

Show Icons
Display text app icons next to app names.

Corners
Choose the corner style for text islands and buttons: Pill, Rounded, or Square.

---

✋ Gestures

Tap & Click Actions

Double Tap (2)
Customize double tap to open an app or perform an action.

Click on Clock (6)
Customize clock tap to open an app or perform an action.

Click on Date (7)
Customize date tap to open an app or perform an action.

Click on Quote (8)
Customize quote widget tap to open an app or perform an action.

Swipe Gestures

Swipe Left (>)
Customize left swipe to open an app or perform an action.

Swipe Right (<)
Customize right swipe to open an app or perform an action.

Swipe Up (^)
Customize up swipe to open an app or perform an action.

Swipe Down (v)
Customize down swipe to open an app or perform an action.

Gesture Options

• Open App (not available for double tap)
• Open App Drawer
• Open Notifications Screen
• Open Recents Screen
• Open Simple Tray
• Manual E-Ink Refresh
• Brightness on/off
• Lock Screen
• Show Recents
• Open Quick Settings
• Open Power Dialog
• Restart Launcher
• Exit inkOS (switch between launchers)
• Toggle Private Space (if supported)
• Disabled

Swipe Threshold Ratios

Short Swipe Ratio
Adjusts the sensitivity threshold for short swipes (0.01 to 1.0). Lower values make swipes more sensitive.

Long Swipe Ratio
Adjusts the sensitivity threshold for long swipes (1.1 to 5.0). Higher values require longer swipes to trigger.

Edge Swipe Back
Enables edge swipe back gesture functionality.

---

🔔 Notifications

Push Notifications
Enable or disable notifications system-wide.
System permission dialog will guide you to enable notification listener access.

Notification Home

Asterisk Notification
Adds a * next to app names with pending notifications.

Label Notifications*
Shows actual notification content below app names.
Great for chat/media apps.

Media Playing Asterisk
Displays a * beside apps currently playing media.

Media Playing Name
Displays the name of currently playing media (e.g., song, podcast, audio file).

Home Notifications Allowlist
Choose which apps can show label notifications on the home screen.
Highly recommended for focus and clarity.

Badge Character Limit
Sets the maximum number of characters to display in notification previews (5-50).
Important for layout stability—depends on font and size.

Chat Notifications

Show Sender Name
Displays the sender's name in notification previews.

Show Conversation/Group Name
Displays the conversation or group name in notification previews.

Show Message
Displays the message preview in notification previews.

Notifications Window

Enable Notifications
Enables the dedicated notification window to read full messages.

Clear Conversation on App Open
Automatically clears notifications when you open the app.

Notification Allowlist
Choose which apps can show notifications in the notification window.
Has a separate allowlist from home notifications.

Keypad shortcuts: 1 to dismiss notifications, 3 to open notifications (for keypad phones)

Simple Tray

Notifications Per Page
Sets how many notifications to display per page in Simple Tray (1, 2, or 3).

Enable Bottom Navigation
Shows navigation controls at the bottom of Simple Tray.

Simple Tray Allowlist
Choose which apps can show notifications in Simple Tray.

---

⚙️ Advanced

Lock Home Apps
Prevents app changes on the home screen via long press.

Long Press for App Info
Opens the system dialog to uninstall or force stop apps when long-pressing apps (only available when home apps are locked).
Especially useful for phones with no recents menu.

Lock Settings
Lock the Settings menu with fingerprint or PIN to avoid accidental changes.

Backup / Restore

• Backup: Save current settings for future restoration (e.g., factory reset or new device).
• Restore: Load saved settings.
• Clear All Data: Clears all settings and data for inkOS, so you can start from scratch.
  Note: Custom fonts are not backed up.

Change Default Launcher
Opens system settings to set inkOS as the default launcher.

Restart Launcher
Restarts the inkOS launcher.

Exit inkOS
Opens the launcher chooser to switch to another launcher.

---

🗂️ App Drawer

Displays a scrollable list of all installed apps.

Long Press Options:

1. Delete: Uninstalls the app
2. Rename: Change app name/alias (affects home too)
3. Hide: Moves the app to the hidden apps list
4. Lock: Requires fingerprint/PIN to open
5. Info: Opens the system info dialog

App Drawer as an App
App Drawer can be added as an app in the app list.

Customizations

App Size
Controls the size of app items in the app drawer.

App Padding Size
Controls the gap between app items in the app drawer.

App Drawer Alignment
Sets the horizontal alignment of apps in the drawer (Left, Center, Right).

Filtering

AZ Filter
Enables alphabetical filtering/sorting of apps in the drawer.

Hide Home Apps
Hides apps that are already on the home screen from the app drawer.

System Shortcuts
Select which system shortcuts (e.g., Settings, Phone, Messages) to show in the app drawer.

Search

Enable Search
Enables the search functionality in the app drawer.

Auto Show Keyboard
Automatically shows the keyboard when opening the app drawer search (requires search to be enabled).

Auto-launch result
Automatically launches the first search result when typing in the app drawer search.

---

🔧 Extras

E-Ink Features

E-Ink Auto Mode (Mudita Kompakt only)
Taps in E-ink auto mode for Mudita Kompakt devices.

Auto E-Ink Refresh
Optimized for e-ink devices. Flashes the screen after exiting apps to clean ghosting artifacts.
Note: Doesn't apply to overlays like quick settings; press the home button to exit.

Auto Refresh Only in Home
When enabled, auto refresh only occurs when returning to the home screen (requires Auto E-Ink Refresh to be enabled).

E-Ink Refresh Delay
Sets the delay in milliseconds before the e-ink refresh occurs (adjustable in 25ms increments).

Use Volume Keys for Pages
Navigate between pages using the volume keys.

---