Skip to content

reading-plans.md

Latest commit

 

History

History
42 lines (29 loc) · 1.65 KB

reading-plans.md

File metadata and controls

42 lines (29 loc) · 1.65 KB

Reading Plans Module

Overview

The reading plan system lets users follow structured daily Bible reading schedules. Multiple plans can be active simultaneously. Progress is tracked per-day and synced via the cloud sync system.

Key Files

  • Alkitab/src/main/java/yuku/alkitab/base/ac/ReadingPlanActivity.java — Main reading plan UI with calendar navigation
  • Alkitab/src/main/java/yuku/alkitab/base/model/ReadingPlan.java — Data model with daily verse arrays
  • Alkitab/src/main/java/yuku/alkitab/base/util/ReadingPlanManager.java — File parsing, DB operations, progress management

RPB Binary Format

Reading plans use a custom binary format (.rpb):

Header: 0x52 0x8a 0x61 0x34 0x00 0xe0 0xea (7 bytes)
Version: 1 (uint8)
Body (Bintex-encoded):
  - name (string)
  - title (string)
  - description (string)
  - duration (int, number of days)
  - url (string, optional)
  - For each day:
    - verse count (int)
    - ARI values (int array)

Progress Tracking

Progress is stored in the ReadingPlanProgress database table. Each reading within a day is identified by a reading code: (dayNumber << 8) | sequenceIndex. This allows tracking completion of individual verse ranges within a single day.

Sync

Reading plan progress syncs via Sync_Rp. The sync protocol handles merging progress from multiple devices — since progress is additive (readings can only be marked complete), conflict resolution is straightforward union merge.

Database Tables

  • ReadingPlan — plan metadata (name, title, description, startDate, duration, data blob)
  • ReadingPlanProgress — per-reading completion records (readingPlanId, readingCode, checkTime)