Skip to content

Latest commit

 

History

History
159 lines (119 loc) · 7.85 KB

README.md

File metadata and controls

159 lines (119 loc) · 7.85 KB
Raw

Magic: The Gathering Card Generator

https://www.mtgcardgenerator.com

The Magic: The Gathering Card Generator is a project that uses AI (particuarlly, OpenAI's offerings) to generate realistic Magic: The Gathering cards. Generated cards are beautifully rendered using CSS.

Users can enter a prompt describing the type of Magic card they would like to generate, and the response will be a be a rendered image of a realistic card that matches the prompt. Here is an example card generation:

Chat GPT Integration

The MTG Card Generator is now available as an OpenAI GPT. Check it out here.

Features

  • Users supply an open ended prompt describing the Magic card they would like to generate. Users may:

    • Choose the language model (current only gpt-4o-mini is supported)
    • Choose the image model (dall-e 2, dall-e 3 etc.) or supply their own image prompt.
    • Select a number of other fun options such as asking the AI explain itself or asking for extra creative cards.
    • Resize, download, or share generated card links.

  • Generated cards are rendered beautifully using CSS and look like real Magic cards. Realistic card background and symbols are used, and card text is scaled appropriately to fill the content.

  • Users may optionally login to have their card generation history stored for viewing later.

  • A rating page is available to score and view top cards.

API

You can use the public API to generate cards, but you will need to supply your own OpenAI API key.

The API is located at https://mtgcardgenerator.azurewebsites.net/api/GenerateMagicCard.

Parameters

Name Type Description
prompt string The prompt to use to generate the card.
model string The OpenAI language model to use. Use gpt-4o-mini.
imageModel string The OpenAI model to use for generating the card image. Use dall-e-3 or dall-e-2.
includeExplanation bool Whether to include the AI's reasoning in the card text. If true, explanation and funnyExplanation will be included in the response.
extraCreative bool If true, uses a different prompt and higher temperature to generate more creative cards with more interesting usage of keywords and mechanics.
generateImagePrompt bool If true, use an intelligently generated image prompt to produce more unique and interesting art.
openAIApiKey string Your OpenAI API key.

Sample Response

{
   "cards":[
      {
         "id": "969f10c2-66f4-40e4-be96-8dd0341fd0c4",
         "name": "Djurge, the Timebender",
         "manaCost": "{3}{U}{U}{U}",
         "type": "Creature",
         "typeLine": "Legendary Creature - Human Wizard",
         "oracleText": "When Djurge, the Timebender enters the battlefield, you may exile target nonland permanent. Its controller puts it into their library second from the top.\nAt the beginning of your upkeep, you may exile the top card of your library. If you do, you may cast it without paying its mana cost.",
         "flavorText": "Time is but a mere thread for Djurge, the weaver of history.",
         "colorIdentity": "Blue",
         "rarity": "Mythic Rare",
         "pt": "4/4",
         "explanation": null,
         "funnyExplanation": null,
         "userPrompt": "A card from the Dominaria plane.",
         "imageUrl": "<link>",
         "temporaryImageUrl": "<link>",
         "url":"https://www.mtgcardgenerator.com/Card?id=969f10c2-66f4-40e4-be96-8dd0341fd0c4"
      }
   ]
}

Development Guide

This section gives an overview for how to contribute to this project.

Components

There are two components to this project:

  1. An Azure, C# back end which is an Azure function API built on top of other Azure resources (Cosmos DB, Blob storage).
    • The backend API generates cards based on a prompt and an image based on the card text. A simple, stupid, rules engine is implemented to fix common problems on generated cards.
    • Azure B2C is used as the SSO provider for the login experience.
    • If the user is logged on, a history is stored for the user so generated cards can be viewed later.
  2. A React, Typescript single-page application (SPA). The front end allows the user to login, enter a prompt and then renders the generated card on the page once the API response is received.

Build & Run the Backend

  1. Open api\MTG.CardGenerator.sln in Visual Studio 2022 and build the solution.

  2. Add a local.settings.json inside the MTG.CardGenerator project:

{
  "IsEncrypted": false,
  "Host": {
    "CORS": "http://localhost:8080",
    "CORSCredentials": true
  },
  "Values": {
    "AzureWebJobsStorage": "UseDevelopmentStorage=true",
    "FUNCTIONS_WORKER_RUNTIME": "dotnet",
    // OpenAI settings.
    "OPENAI_API_KEY": "",
    // Bearer token validation settings.
    "ValidateBearerToken": false,
    "ValidJWTAuthority": "https://mtgcardgenerator.b2clogin.com/mtgcardgenerator.onmicrosoft.com/B2C_1_signup_signin",
    "ValidJWTAudience": "1cc495e4-bd18-4bed-9c18-857689172c50",
    "ValidJWTIssuer": "https://mtgcardgenerator.b2clogin.com/e856e196-1342-4533-b8a6-0e5a50bf6a67/v2.0/",
    // Database settings.
    "CosmosDBEndpointUrl": "",
    "CosmosDBAccessKey": "",
    "CosmosDBDatabaseId": "",
    // Blob storage settings.
    "BlobStorageName": "",
    "BlobStorageEndpoint": "",
    "BlobStorageContainerName": "card-images",
    "BlobStorageAccessKey": ""
  }
}

You will need to fill in the missing values which include supplying an Open AI API key, an Azure Cosmos DB, and an Azure Blob storage. Set ValidateBearerToken to false to skip any API authentication when running the Azure function emulator locally (per function authorization is implemented). Or, you may utilize the Azure B2C instance that has been set up for this website with the values provided above to test the login experience.

  1. Start the MTG.CardGenerator project to launch the Azure function emulator over local host.

Build & Run the Frontend

From the root of the repository, install depenencies and start the local web server:

npm install
npm run dev

Navigate to http://localhost:8080/ in your browser. VS Code launch configurations are provided to easily enable debugging.

Deployment

This application is deployed entirely within a personal Azure subscription. Pushing to the main or development branch will trigger GitHub actions which perform deployments into Azure updating the resources shown below:

Branch Azure Static Web App SPA Azure Function
main https://www.mtgcardgenerator.com/
https://ambitious-meadow-0e2e9ce0f.3.azurestaticapps.net/		 https://mtgcardgenerator.azurewebsites.net
development https://ambitious-meadow-0e2e9ce0f-development.eastus2.3.azurestaticapps.net/ https://mtgcardgenerator-development.azurewebsites.net

All other resources required to make the website work are already deployed and configured in Azure.

Deployments should take only a few minutes.

If you are serious about helping with development, we can discuss gaining limited access to the underlying Azure resources for better testing, but most development and testing has been designed to happen locally.

Links