Skip to content

GUIDE.md

Latest commit

 

History

History
109 lines (87 loc) · 4.11 KB

GUIDE.md

File metadata and controls

109 lines (87 loc) · 4.11 KB

Notepad Inc. - Miyoo Mini Plus Edition

A high-performance, specialized note-taking application designed for the Miyoo Mini Plus (ARMv7/Linux).

Features

  • Linear QWERTY Ribbon: High-speed text entry with physics-based inertia.
  • Prediction Crank: Vertical predictive text engine with 50,000+ word capacity.
  • State Machine Architecture: Browser, Editor, Canvas, Settings, and Decoy modes.
  • Security Vault: Hidden directory protected by Konami Code and 1-byte XOR encryption.
  • Panic Switch: Instantly swap to a fake "System Update" screen.
  • Canvas Mode: Free-form mind mapping with sticky arrows and shape manipulation.
  • Satisfaction System: Dopamine-driven task completion effects.
  • Undo/Redo: 100+ step history stack for both Text and Canvas modes.
  • Global Settings: Configure Input, Visuals, and Security preferences.

Controls

Global

  • Konami Code: UP, UP, DOWN, DOWN, LEFT, RIGHT, LEFT, RIGHT, B, A (Unlocks /.sys_cache/ Vault in Browser)
  • Panic Switch: L2 + R2 + SELECT + START (Triggers Decoy Mode)

File Browser

  • D-pad: Navigate files
  • A: Open File / Enter Directory
  • B: Back / Exit
  • X: New File
  • Y: Privatize File (Encrypts, renames to hex, moves to Vault)
  • SELECT: Open Settings

Settings Menu

  • D-pad Up/Down: Select Option
  • D-pad Left/Right: Adjust Slider / Toggle Selector
  • A / RETURN: Toggle Switch
  • B / ESCAPE: Save & Exit

Editor (Text Mode)

  • D-pad Left/Right: Spin Character Ribbon
  • L1 / R1: Jump 5 characters in Ribbon
  • SELECT: Toggle focus between Ribbon (Bottom) and Prediction Crank (Right)
  • START: Auto-complete selected word
  • A: Insert character / New Line
  • B: Backspace
  • Y: Cycle Bullet Type (• Task -> O Event -> — Note -> ! Priority -> ? Research)
  • D-pad Right (on Task line): Mark Done (Strike-through + Pop animation)
  • Z: Undo
  • R: Redo

Canvas (Mind Map Mode)

  • 1 / 2 / 3: Add Square / Circle / Triangle
  • TAB: Cycle selection through shapes
  • D-pad: Move selected shape
  • L1 (Hold) + D-pad: Resize selected shape (Stretch/Scale)
  • X: Copy (First press) / Paste (Second press)
  • A (mapped to 'C' key for PC testing): Connect Arrow from Root (Shape 0) to Selected Shape
  • Z: Undo
  • R: Redo

Technical & Compilation

Requirements

  • Hardware: Miyoo Mini Plus (ARMv7 Cortex-A7)
  • OS: Onion OS (Linux)
  • Libraries: SDL2, SDL2_ttf
  • Language: C++17

Building for Local Testing (macOS/Linux)

Ensure SDL2 and SDL2_ttf are installed (e.g., brew install sdl2 sdl2_ttf).

make
./notepad_inc

Cloud Build (GitHub Actions)

If you don't have a local Linux environment or Docker, you can use the included GitHub Actions workflow.

  1. Push to GitHub: Upload this repository to your GitHub account.
  2. Wait for Build: Go to the "Actions" tab in your repository. You will see a workflow named "Build for Miyoo Mini Plus" running.
  3. Download Artifact: Once completed (green checkmark), click on the run and scroll down to "Artifacts". Download the NotepadInc-Miyoo zip file.
  4. Install: Extract the zip contents to /App/ on your SD card.

Cross-Compilation for Miyoo Mini Plus (Manual)

To compile for the device locally, you need the Miyoo Mini toolchain (often provided via Docker or specific GCC binaries like arm-linux-gnueabihf-gcc).

  1. Set up Toolchain: Ensure arm-linux-gnueabihf-g++ is in your PATH.

  2. Build: Use the provided Makefile with the CROSS_COMPILE flag (you may need to adjust paths in Makefile if using a specific SDK):

    # Example manual build command
arm-linux-gnueabihf-g++ -o notepad_inc_arm \
  src/*.cpp src/States/*.cpp src/Utils/*.cpp \
  -I/path/to/arm-sdl2/include \
  -L/path/to/arm-sdl2/lib \
  -lSDL2 -lSDL2_ttf -std=c++17 -O3

    Note: The included Makefile defaults to local g++. Modify CXX variable for cross-compilation.

File System

  • Notes: Saved in ./notes/
  • Vault: Saved in ./.sys_cache/ (Hidden)
  • Config: ./settings.cfg (Auto-generated)

Generated by Notepad Inc. Dev Team