Skip to main content

A new package lets users type plain text descriptions of imaginary worlds—defining rules, ecosystems, and events—and, using LLM7 and llmatch-messages, returns a structured, step‑by‑step simulation nar

Project description

Worldcraft-Sim

PyPI version License: MIT Downloads LinkedIn

Overview

Worldcraft-Sim is a Python package that allows users to type plain text descriptions of imaginary worlds, defining rules, ecosystems, and events. Using LLM7 and llmatch-messages, the package returns a structured, step-by-step simulation narrative that responds to those inputs. The system interprets the user's creative prompts, verifies them with regex patterns, and generates a formatted output that can be parsed back into a programmatic representation of the evolving world, enabling playful exploration of alternate realities without processing raw documents or media.

Installation

You can install the package using pip:

pip install worldcraft_sim

Usage

Here is an example of how to use the worldcraft_sim function:

from worldcraft_sim import worldcraft_sim

# Example usage with default LLM7
response = worldcraft_sim(user_input="Describe a fantasy world with magical creatures and ancient ruins.")
print(response)

Input Parameters

  • user_input: str : The user input text to process.
  • llm: Optional[BaseChatModel] : The LangChain LLM instance to use. If not provided, the default ChatLLM7 will be used.
  • api_key: Optional[str] : The API key for LLM7. If not provided, it will be fetched from the environment variable LLM7_API_KEY.

Using a Custom LLM

You can use a custom LLM by passing an instance of BaseChatModel. For example, to use OpenAI, Anthropic, or Google's Generative AI:

OpenAI

from langchain_openai import ChatOpenAI
from worldcraft_sim import worldcraft_sim

llm = ChatOpenAI()
response = worldcraft_sim(user_input="Describe a fantasy world with magical creatures and ancient ruins.", llm=llm)
print(response)

Anthropic

from langchain_anthropic import ChatAnthropic
from worldcraft_sim import worldcraft_sim

llm = ChatAnthropic()
response = worldcraft_sim(user_input="Describe a fantasy world with magical creatures and ancient ruins.", llm=llm)
print(response)

Google Generative AI

from langchain_google_genai import ChatGoogleGenerativeAI
from worldcraft_sim import worldcraft_sim

llm = ChatGoogleGenerativeAI()
response = worldcraft_sim(user_input="Describe a fantasy world with magical creatures and ancient ruins.", llm=llm)
print(response)

API Key

The default rate limits for LLM7's free tier are sufficient for most use cases of this package. If you need higher rate limits, you can pass your own API key via the environment variable LLM7_API_KEY or directly in the function call:

response = worldcraft_sim(user_input="Describe a fantasy world with magical creatures and ancient ruins.", api_key="your_api_key")

You can get a free API key by registering at LLM7 Token.

Contributing

Contributions are welcome! Please open an issue or submit a pull request on GitHub.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Author

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

worldcraft_sim-2025.12.20202326.tar.gz (4.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

worldcraft_sim-2025.12.20202326-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

Details for the file worldcraft_sim-2025.12.20202326.tar.gz.

File metadata

File hashes

Hashes for worldcraft_sim-2025.12.20202326.tar.gz
Algorithm Hash digest
SHA256 f4739714f0e8cbd3f3fa26148a5b029213a54ed6f7876963cfa1567253fcfbb5
MD5 2f0b811c85bad1e9ea7ac36e62310445
BLAKE2b-256 a822a6d03f7a414455120a52a16caca2d3e78c746b0b3fae28eae66be4252579

See more details on using hashes here.

File details

Details for the file worldcraft_sim-2025.12.20202326-py3-none-any.whl.

File metadata

File hashes

Hashes for worldcraft_sim-2025.12.20202326-py3-none-any.whl
Algorithm Hash digest
SHA256 3ab12aa9228750806fdf616540a7fd12c02659065d30c675488ade8d5b6ab3c4
MD5 f8f2b14c8427e874744575ef4564c4bd
BLAKE2b-256 84950b7ab807fff45754c22a6de52afe59e851bb7b864a160ecdfbde8696eac5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page