Skip to main content

A new package would help users analyze and interpret game narratives or story structures, specifically focusing on the METR (Mechanics, Esthetics, Technology, and Rhetoric) plot framework used in game

Project description

game-metr-analyzer

PyPI version License: MIT Downloads LinkedIn

A Python package to analyze and interpret game narratives or story structures, focusing on the METR (Mechanics, Esthetics, Technology, and Rhetoric) plot framework used in game design. It processes textual descriptions of game plots, mechanics, or player experiences and returns a structured breakdown of these elements. This helps game developers, critics, and educators systematically evaluate and enhance game narratives without subjective bias.

Installation

Install the package via pip:

pip install game_metr_analyzer

Usage

Import and use the main function as shown:

from game_metr_analyzer import game_metr_analyzer

response = game_metr_analyzer(
    user_input="Your game plot description here",
    # Optional: specify a custom LLM instance
    # llm=your_llm_instance,
    # Optional: specify API key for LLM7
    # api_key="your_api_key"
)

Parameters

  • user_input (str): The textual description of the game plot, mechanics, or player experience to analyze.
  • llm (Optional[BaseChatModel]): An instance of a language model (e.g., from langchain). If not provided, the default ChatLLM7 will be used.
  • api_key (Optional[str]): The API key for ChatLLM7. If not provided, it will be read from the environment variable LLM7_API_KEY.

Supported Language Models

This package uses ChatLLM7 from langchain_llm7 by default. You can pass your own language model instance to utilize other services such as:

  • OpenAI's models:

    from langchain_openai import ChatOpenAI
    
    llm = ChatOpenAI()
    response = game_metr_analyzer(user_input, llm=llm)
    
  • Anthropic:

    from langchain_anthropic import ChatAnthropic
    
    llm = ChatAnthropic()
    response = game_metr_analyzer(user_input, llm=llm)
    
  • Google Generative AI:

    from langchain_google_genai import ChatGoogleGenerativeAI
    
    llm = ChatGoogleGenerativeAI()
    response = game_metr_analyzer(user_input, llm=llm)
    

API Key Management

The default rate limits for ChatLLM7 are sufficient for most use cases. To access higher limits:

  • Set the LLM7_API_KEY environment variable:
    export LLM7_API_KEY="your_api_key"
    
  • Or pass it directly:
    response = game_metr_analyzer(user_input, api_key="your_api_key")
    

You can obtain a free API key by registering at https://token.llm7.io/.

License

This project is licensed under the MIT License.

Author

GitHub

Issues

For bugs or feature requests, please use the GitHub issues page: https://github.com/...

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

game_metr_analyzer-2025.12.21162154.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

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

game_metr_analyzer-2025.12.21162154-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

Details for the file game_metr_analyzer-2025.12.21162154.tar.gz.

File metadata

File hashes

Hashes for game_metr_analyzer-2025.12.21162154.tar.gz
Algorithm Hash digest
SHA256 84b2b0a8b5b8a84613acd1447da38db4d0780560bc79a2608d90c6bab26e4c47
MD5 4de7cc5773bd48754de77e3f4aca68ea
BLAKE2b-256 981c65d03b1f0f942af31302b7e9f6cf2272029c745ef64d4d19d828e443676d

See more details on using hashes here.

File details

Details for the file game_metr_analyzer-2025.12.21162154-py3-none-any.whl.

File metadata

File hashes

Hashes for game_metr_analyzer-2025.12.21162154-py3-none-any.whl
Algorithm Hash digest
SHA256 6e819c6e152eca2791b48541c46468436357d0fda63e5bb92df54ca092f38520
MD5 609cfb114dd75d49131d585de6b38051
BLAKE2b-256 dbc83058dcaa2b3dc9db58b8e21717a7f4eb66d4d554a366f2d717f3ef9db40a

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