indentlabs / notebook

Notebook.ai is a set of tools for writers, game designers, and roleplayers to create magnificent universes – and everything within them.
http://www.notebook.ai
MIT License
353 stars 72 forks source link

Export for OpenCharacters #1245

Closed drusepth closed 1 year ago

drusepth commented 1 year ago

Based on https://github.com/josephrocca/OpenCharacters/issues/35 it looks like we can export characters in a way that lets users talk to them with the following json form:

{
  name: "Character name",
  avatar: "avatar_url",
  personality: "In just a few words, how would your character describe themselves?",
  description: "In a few sentences, how would your character describe themselves? (Description of personality and other characteristics.)",
  scenario: "A few short sentences describing the starting scenario, circumstances, and context of the dialogue.",
  char_greeting: "The first message the character will say verbatim to start the conversation.",
  example_dialogue: "<START> [...] <START> [...]"
}

Following this character editor/exporter's format, we should probably also include a block of metadata in each export similar to:

    "metadata": {
        "version": 1,
        "created": 1681425505383,
        "modified": 1681425505383,
        "source": null,
        "tool": {
            "name": "AI Character Editor",
            "version": "0.5.0",
            "url": "https://zoltanai.github.io/character-editor/"
        }
    }

I'm gonna use this issue to plan out how to map a character's fields into these expected fields.

drusepth commented 1 year ago

For a given character @character:

Header Header
name @character.name
avatar @character.random_image_including_private.src
personality @character.name is a overview/gender overview/role, age overview/age (also known as overview/aliases).
description @character.name is a social/occupation. Their background is history/background. Their primary motivations are nature/motivations. Their mannerisms are nature/mannerisms. Their flaws are nature/flaws and their prejudices are nature/prejudices. Their talents are nature/talents and their hobbies are nature/hobbies.
scenario TBD (maybe just ask the user what they want the scenario to be?)
char_greeting TBD
example_dialogue TBD

Questions to ponder:

drusepth commented 1 year ago

Done & live.