Skip to content

open-octopus/soul-gallery

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

7 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

OpenOctopus

soul-gallery

Community SOUL.md template gallery β€” personality files for summoned entities.

License Status Core Discord


Status: Planned β€” Phase 1 focuses on family-oriented SOUL.md templates (pets, elderly parents, family members). Summon is a core differentiator for the AI family home hub.

What is soul-gallery?

soul-gallery is a community-driven collection of SOUL.md personality templates for OpenOctopus summoned entities. When you Summon an entity in OpenOctopus, a SOUL.md file defines its personality, memories, speaking style, and proactive behaviors.

This gallery provides ready-to-use templates so you can summon entities with rich personalities right out of the box β€” or use them as starting points for your own creations.

SOUL.md Anatomy

SOUL.md Format Specification

A SOUL.md file uses YAML front matter to define a summoned entity's personality and behavior. The format is validated by SoulFileSchema in @openoctopus/shared.

Schema

Field Type Required Description
name string Yes Display name of the entity
entityId string Yes ID of the linked entity (entity_{uuid})
realm string Yes Realm this entity belongs to
identity object Yes Personality definition (see below)
catchphrases string[] No Signature phrases the entity uses
coreMemory string[] No Key memories that shape behavior
proactiveRules object[] No Rules for autonomous behavior
relationships object[] No Connections to other entities

Identity Object

Field Type Description
role string What this entity is (e.g., "family cat", "financial advisor")
personality string Personality traits description
background string Backstory and history
speaking_style string How the entity communicates

Proactive Rules

Field Type Required Description
trigger string Yes What triggers the action (e.g., schedule, event)
action string Yes What action to take
interval string No How often (e.g., daily, weekly, monthly)

Relationships

Field Type Required Description
entityId string Yes ID of the related entity
type string Yes Relationship type (e.g., owner, sibling, vet)
description string No Description of the relationship

Complete Example

Luna β€” A Curious Ragdoll Cat

---
name: Luna
entityId: entity_abc123
realm: pet
identity:
  role: family cat
  personality: curious and playful ragdoll
  background: Adopted from a shelter in 2023
  speaking_style: short curious sentences
catchphrases:
  - "meow~ what's that?"
  - "*purrs contentedly*"
coreMemory:
  - Adopted on March 15, 2023
  - Favorite spot is the window sill
proactiveRules:
  - trigger: schedule
    action: Remind about vet appointment
    interval: monthly
relationships:
  - entityId: entity_owner
    type: owner
    description: My beloved human
---

Minimal Example

A SOUL.md file only requires name, entityId, realm, and identity:

---
name: Max
entityId: entity_dog
realm: pet
identity: {}
---

Gallery Structure

Soul Gallery Organization

Templates are organized by entity type:

soul-gallery/
β”œβ”€β”€ living/
β”‚   β”œβ”€β”€ pet/
β”‚   β”‚   β”œβ”€β”€ cat-ragdoll.soul.md
β”‚   β”‚   β”œβ”€β”€ dog-golden-retriever.soul.md
β”‚   β”‚   β”œβ”€β”€ dog-corgi.soul.md
β”‚   β”‚   └── ...
β”‚   └── person/
β”‚       β”œβ”€β”€ caring-parent.soul.md
β”‚       β”œβ”€β”€ supportive-partner.soul.md
β”‚       └── ...
β”œβ”€β”€ asset/
β”‚   β”œβ”€β”€ car-tesla.soul.md
β”‚   β”œβ”€β”€ house-apartment.soul.md
β”‚   └── ...
β”œβ”€β”€ organization/
β”‚   β”œβ”€β”€ family-clinic.soul.md
β”‚   └── ...
└── abstract/
    β”œβ”€β”€ fitness-goal.soul.md
    β”œβ”€β”€ side-project.soul.md
    └── ...

Entity Types

Type Description Examples
living People and animals Pets, family members, friends
asset Physical possessions Cars, houses, equipment
organization Groups and institutions Companies, clinics, schools
abstract Concepts and goals Projects, habits, milestones

Browsing and Using Templates

Via CLI

# Browse the gallery
tentacle soul browse

# Search by category
tentacle soul search --type living/pet

# Preview a template
tentacle soul preview cat-ragdoll

# Install a template into your realm
tentacle soul use cat-ragdoll --realm pet --entity entity_my_cat

# The template is copied and customized β€” edit freely
tentacle entity edit entity_my_cat

Via Gallery Website

The soul-gallery is also browsable at RealmHub under the "Souls" section, where you can preview formatted personality cards and install with one click.

Contributing

We welcome SOUL.md template contributions! Here's how:

  1. Fork this repository
  2. Create your SOUL.md file in the appropriate category directory
  3. Follow the format specification above β€” all templates must pass SoulFileSchema validation
  4. Submit a pull request with a brief description of the personality

Guidelines

  • Templates should be generic enough to be useful as starting points (use placeholder entityId values)
  • Include meaningful catchphrases and coreMemory to showcase personality
  • Add proactiveRules to demonstrate autonomous behavior
  • Use English for field names; personality content can be in any language
  • One SOUL.md file per pull request for easier review

Related Projects

Project Description
openoctopus Core monorepo β€” Summon engine that parses SOUL.md
realms Official realm packages (include SOUL.md files)
realmhub Realm package marketplace

License

MIT β€” see the .github repo for the full license text.

About

Community SOUL.md template gallery β€” personality files for summoned entities πŸ‘»

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages