Olam

High-performance CLI for worldbuilders and storytellers to manage complex timelines and chronologies. Built in Rust with high-speed memory-mapping and powered by the Tequel cryptographic engine.

by Gabriel "dotxav" Xavier

---

📖 Summary

• Olam
  • 📖 Summary
  • What's Olam?
  • ✨ Features
  • 📃 Documentation
  • 🏃 Quick Start
    • 1. Evoke your Space and Immerse
    • 2. Create a Timeline and Immerse
    • 3. Anchor a Year
    • 4. Define an Age
    • 5. Add Events
    • 6. Preview your Creation
  • 📥 Installation
    • Cargo (Cross-platform)
    • Scoop (Windows)
  • ⚖️ License

---

What's Olam?

Olam was born from a storyteller's need for a professional tool to organize vast fictional universes. Unlike general-purpose note-taking apps, Olam is a dedicated Chronology Engine. It allows you to "immerse" yourself in specific spaces and timelines, managing eras, ages, and events with surgical precision and sovereign data security.

✨ Features

• 🔐 Secure by Default: All your data is encrypted locally using the Tequel engine.
• ⚡ Built for Speed: Uses mmap (memory-mapped files) and SIMD-optimized logic for near-instant execution.
• ⚓ Contextual Navigation: Immerse into your spaces and timelines with immerse and emerge commands.
• 🛠️ Fully Customizable: Create your own calendar units (Years, Eras, etc.).
• 📦 Zero Cloud: 100% offline. Your space, your data, your privacy.

📃 Documentation

• Full Reference: Olam Documentation on Docs.rs
• ⚓ Navigation Guide
• 🌌 Managing Spaces
• ⏳ Timeline Logic

---

🏃 Quick Start

1. Evoke your Space and Immerse

olam evoke "My Space" -i

2. Create a Timeline and Immerse

olam add "Main Timeline" -i

3. Anchor a Year

olam year 0 "Genesis"

4. Define an Age

olam age "First Age" -d 100

5. Add Events

# Add a note in < Between >
olam age "Fire Age" -b "Discovery of roasted meat"

# Add a year in < Events >
olam year -a "Fire Age" 45 "The Great Volcano Eruption"

6. Preview your Creation

olam tl

Output Preview

(olam) ~MySpace.MainTimeline
——?—— 100 Year(s)
——?—— 1 Age(s)
——?—— Max 1000 Year(s)

-< Year 0 >-
    
    Genesis

-< Fire Age - Year 1 >-
    
    < Between >
        
        • Discovery of roasted meat

    < Events >
        
        -< Year 45 >- 
            
            • The Great Volcano Eruption

-< Fire Age Dissolved - Year 100 >-

📥 Installation

Cargo (Cross-platform)

cargo install olam

Scoop (Windows)

If you don't have Scoop installed yet, run this in your PowerShell:

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
irm get.scoop.sh | iex

Then, add the dotxav bucket and install Olam:

scoop bucket add dotxav https://github.com/G4brielXavier/scoop-bucket
scoop install olam

⚖️ License

Olam is a gift to the worldbuilding and storytelling community, licensed under the BSD 3-Clause License. See the LICENSE file for details.