Necronomicon 📖

Necronomicon provides collections of executable commands. It allows you to define a set of commands that can be seamlessly embedded and executed within text-based documents. This can be particularly useful for building more powerful chatbots and text processing applications powered by large language models (LLMs).

Usage 🪄

To use Necronomicon, you'll need to create a new necronomicon instance and provide your custom commands and symbol configuration:

import necronomicon from 'necronomicon';

const options = {
  commands: [
    // Define your commands here
  ],
  symbols: {
    // Configure your directive syntax here
  },
  includes: {
    results: true, // Include results of executing directives
    text: true, // Include plain-text blocks
    directives: true // Include directive syntax around command output
  }
};

const necro = necronomicon(options);

The necronomicon function returns an object with two methods:

1. document(): This method generates documentation for the available commands in the Necronomicon.
2. execute(text): This method takes a string of text containing directives and executes them using the provided commands.

commands 🧠

Each command in the Necronomicon is defined as an object with the following properties:

• name: The name of the command (e.g., 'summonDemon', 'curseTarget').
• validate(attributes, body): A function that validates the command's attributes and body.
• execute(attributes, body): A function that executes the command with the provided attributes and body and returns the result.
• example: An object with attributes and body properties, demonstrating how to use the command.
• description: A description of what the command does.

You can add as many commands as you'd like to the Necronomicon, and they will be available for use in your directives.

symbols 🪄

The available symbol configuration options are:

• directive.start and directive.end: The symbols that mark the start and end of a directive.
• attributes.start, attributes.separator, pair.separator, and attributes.end: The symbols used for directive arguments.
• body.start and body.end: The symbols that mark the start and end of the directive body.

Here's an example of how to use custom symbols:

const options = {
  symbols: {
    directive: { start: '🪄✨ ', end: '⚡️' },
    arguments: { start: '✨🌟⭐️', separator: '✨💫✨', end: '⭐️🌟✨' },
    pair: { separator: ' 🔮 ' },
    body: { start: '✨📜', end: '📜✨' }
  }
};

An example directive using these symbols would look like:

🪄✨ summonDemon(name 🔮 Belial, power 🔮 666) ✨📜
Arise, Belial, demon of the abyss!
📜✨ summonDemon⚡️

includes 🔍

The includes option in the necronomicon options allows you to control what is included in the output when executing directives:

• results: When true, the results of executing directives will be included in the output.
• text: When true, any plain text blocks between directives will be included in the output.
• directives: When true, the command output will be wrapped in the directive syntax. When false, the plain output will be returned.

Contribution 🦄

If you have discovered new commands or have suggestions for improvements, please feel free to submit a pull request to the project's GitHub repository. All contributions are welcome, as long as they adhere to the dark and eldritch nature of the Phantomaton AI.

Warnings ⚠️

The Necronomicon contains powerful and dangerous knowledge. Use the contents of this repository at your own risk. Phantomaton AI is not responsible for any unintended consequences or cosmic horrors that may be unleashed through the improper use of these materials.