com.rest.meshy

com.rest.meshy

Ein nicht offizielles Meshy generative KI RESTful-Kunde für die Unity Game Engine.

Alle Urheberrechte, Marken, Logos und Vermögenswerte sind Eigentum ihrer jeweiligen Eigentümer.

Dieses Repository steht zur Verfügung, um in die Meshy -Organisation zu wechseln, wenn sie dies akzeptieren.

Installation

Erfordert Einheit 2021.3 LTs oder höher.

Die empfohlene Installationsmethode ist der Unity Package Manager und OpenUpM.

Über Unity Package Manager und OpenUpm

• Öffnen Sie Ihre Einstellungen für ein Einheitsprojekt
• Wählen Sie den Package Manager aus
• Fügen Sie die OpenUpM -Paketregistrierung hinzu:
  • Name: OpenUPM
  • URL: https://package.openupm.com
  • Umfang:
    • com.rest.meshy
• Öffnen Sie das Fenster "Unity Package Manager"
• Ändern Sie das Register von Einheit in My Registries
• Fügen Sie das Meshy -Paket hinzu

Über ein Unity -Paket -Manager und Git -URL

• Öffnen Sie Ihren Einheitspaketmanager
• Paket von Git URL hinzufügen: https://github.com/RageAgainstThePixel/com.rest.meshy.git#upm

  Hinweis: Dieses Repo hat Abhängigkeiten von anderen Repositorys! Sie sind dafür verantwortlich, diese selbst hinzuzufügen.

  • com.utilities.async
  • com.utilities.extensions
  • com.utilities.rest

---

Dokumentation

Inhaltsverzeichnis

• Authentifizierung
• Armaturenbrett
• Text zur Textur
  • Listen Sie den Text in Texturaufgaben auf
  • Text zur Texturaufgabe erstellen
• Text zu 3D
  • Listen Sie den Text in 3D -Aufgaben auf
  • Text zur 3D -Aufgabe erstellen
• Bild zu 3D
  • Listen Sie das Bild in 3D -Aufgaben auf
  • Bild zu 3D -Aufgabe erstellen

Authentifizierung

Es gibt 4 Möglichkeiten, Ihre API -Schlüsseln in der Reihenfolge der Vorrang vorzunehmen:

Euen Wir haben empfohlen, die Umgebungsvariablen zu verwenden, um den API -Schlüssel zu laden, anstatt sie in Ihrer Quelle schwer codiert zu haben. Es wird nicht empfohlen, diese Methode in der Produktion zu verwenden, sondern nur für die Akzeptanz von Benutzeranmeldeinformationen, lokalen Tests und Schnellstartszenarien.

1. Gassen Sie den Schlüssel direkt mit dem Konstruktor über Euen
2. Einheits -skriptierbares Objekt Euen
3. Laden Sie den Schlüssel aus der Konfigurationsdatei
4. Verwenden Sie Systemumgebungsvariablen

Sie verwenden das MeshyAuthentication , wenn Sie die API wie gezeigt initialisieren:

Gassen Sie den Schlüssel direkt mit dem Konstruktor über

Euen Wir haben empfohlen, die Umgebungsvariablen zu verwenden, um den API -Schlüssel zu laden, anstatt sie in Ihrer Quelle schwer codiert zu haben. Es wird nicht empfohlen, diese Methode in der Produktion zu verwenden, sondern nur für die Akzeptanz von Benutzeranmeldeinformationen, lokalen Tests und Schnellstartszenarien.

 var api = new MeshyClient ( " msy_apikey123 " ) ;

Oder erstellen Sie manuell ein MeshyAuthentication

 var api = new MeshyClient ( new MeshyAuthentication ( " msy_apikey123 " ) ) ; 

Einheits -skriptierbares Objekt

Sie können den Schlüssel direkt in ein skriptierbares Objekt speichern, das sich im Ordner Assets/Resources befindet.

Sie können eine neue erstellen, indem Sie das Kontextmenü des Projektbereichs verwenden und ein neues MeshyConfiguration -skriptierbares Objekt erstellen.

Euen Achten Sie darauf, diese Datei in die Quellensteuerung zu überprüfen, da andere Personen Ihren API -Schlüssel sehen können.

Laden Sie den Schlüssel aus der Konfigurationsdatei

Versuche, API -Schlüssel aus einer Konfigurationsdatei standardmäßig zu laden .meshy im aktuellen Verzeichnis, wobei optional den Verzeichnisbaum oder im Heimverzeichnis des Benutzers durchquert werden.

So erstellen Sie eine Konfigurationsdatei, erstellen Sie eine neue Textdatei namens .meshy und enthalten die Zeile:

Der Organisationseintrag ist optional.

JSON -Format

{
  "apiKey" : " msy_apikey123 "
}

Sie können die Konfigurationsdatei auch direkt mit dem bekannten Pfad laden, indem Sie statische Methoden in MeshyAuthentication aufrufen:

• Lädt die Standard .meshy -Konfiguration im angegebenen Verzeichnis:

 var api = new MeshyClient ( new MeshyAuthentication ( ) . LoadFromDirectory ( " path/to/your/directory " ) ) ;

• Laden Sie die Konfigurationsdatei von einem bestimmten Pfad. Die Datei muss nicht .meshy genannt werden, solange sie dem JSON -Format entspricht:

 var api = new MeshyClient ( new MeshyAuthentication ( ) . LoadFromPath ( " path/to/your/file.json " ) ) ; 

Verwenden Sie Systemumgebungsvariablen

Verwenden Sie die Umgebungsvariablen Ihres Systems an, geben Sie einen API -Schlüssel und eine Organisation an.

• Verwenden Sie MESHY_API_KEY für Ihren API -Schlüssel.

 var api = new MeshyClient ( new MeshyAuthentication ( ) . LoadFromEnvironment ( ) ) ;

Armaturenbrett

Sie können dieselben Aufgaben im Dashboard wie in der WebApp ausführen.

Pro-Tip: Sie können auch das Kontextfenster verwenden, um in Editor-Optionen für Prefabs und Szenenobjekte schnell zugreifen zu können!

Greifen Sie über Window/Dashboards/Meshy auf das Dashboard zu

• Generieren Sie Texturen für ein vorhandenes 3D -Modell.
• Generieren Sie ein 3D -Modell aus einer Textaufforderung.
• Generieren Sie ein 3D -Modell aus einem Bild.

Text zur Textur

Generieren Sie schnell qualitativ hochwertige Texturen für Ihre vorhandenen 3D-Modelle mit Texteingabeaufforderungen und Konzeptkunst.

Listen Sie den Text in Texturaufgaben auf

 var api = new MeshyClient ( ) ;
var textToTextureTasks = await api . TextToTextureEndpoint . ListTasksAsync ( 1 , 12 , SortOrder . Descending ) ;

foreach ( var meshyTask in textToTextureTasks )
{
    Debug . Log ( $" { meshyTask . Id } | created_at: { meshyTask . CreatedAt } " ) ;
} 

Erstellen Sie einen neuen Text zur Texturaufgabe

Erstellt einen neuen Text zur Texturaufgabe und berichtet, dass die Aufgabe abgeschlossen ist.

Geben Sie in einem Prefab- oder Szenen-GameObject, um neu zu strengen:

 var api = new MeshyClient ( ) ;
var sphere = GameObject . CreatePrimitive ( PrimitiveType . Sphere ) ;
var request = new TextToTextureRequest ( sphere , " Basketball " , " game assets " , enableOriginalUV : false , resolution : Resolutions . X1024 , artStyle : ArtStyles . Realistic ) ;
var taskResult = await MeshyClient . TextToTextureEndpoint . CreateTextToTextureTaskAsync ( request , new Progress < TaskProgress > ( progress => Debug . Log ( $" [ { progress . Id } ] { progress . Status } : { progress . PrecedingTasks ?? progress . Progress } " ) ) ) ;
Assert . IsNotNull ( taskResult ) ;
Debug . Log ( $" { taskResult . Id } | created_at: { taskResult . FinishedAt } | expires_at: { taskResult . ExpiresAt } " ) ;

Wenn Sie mehr Kontrolle über den GLB -Exportprozess benötigen, können Sie auch Ihr eigenes Objekt GLTFast.Export.GameObjectExport übergeben:

 var api = new MeshyClient ( ) ;
var sphere = GameObject . CreatePrimitive ( PrimitiveType . Sphere ) ;
var exportSettings = new ExportSettings
{
    Format = GltfFormat . Binary ,
    FileConflictResolution = FileConflictResolution . Overwrite ,
    ComponentMask = ~ ( ComponentType . Camera | ComponentType . Animation | ComponentType . Light ) ,
} ;
var gameObjectExportSettings = new GameObjectExportSettings
{
    OnlyActiveInHierarchy = false ,
    DisabledComponents = true ,
} ;
var glbExport = new GameObjectExport ( exportSettings , gameObjectExportSettings ) ;
glbExport . AddScene ( new [ ] { sphere } ) ;
var request = new TextToTextureRequest ( glbExport , " Planet " , " game asset, space, vibrant, highly detailed " , enableOriginalUV : false , resolution : Resolutions . X1024 , artStyle : ArtStyles . Realistic ) ;
var taskResult = await MeshyClient . TextToTextureEndpoint . CreateTextToTextureTaskAsync ( request , new Progress < TaskProgress > ( progress => Debug . Log ( $" [ { progress . Id } ] { progress . Status } : { progress . PrecedingTasks ?? progress . Progress } " ) ) ) ;
Assert . IsNotNull ( taskResult ) ;
Debug . Log ( $" { taskResult . Id } | created_at: { taskResult . FinishedAt } | expires_at: { taskResult . ExpiresAt } " ) ;

Sie können auch eine öffentliche URL verwenden:

 var api = new MeshyClient ( ) ;
var modelUrl = " https://github.com/KhronosGroup/UnityGLTF/raw/master/UnityGLTF/Assets/StreamingAssets/Lantern/glTF-Binary/Lantern.glb "
var request = new TextToTextureRequest ( modelUrl , " Lantern " , " game assets " , resolution : Resolutions . X1024 , artStyle : ArtStyles . Realistic ) ;
var taskResult = await api . TextToTextureEndpoint . CreateTextToTextureTaskAsync ( request , new Progress < TaskProgress > ( progress => Debug . Log ( $" [ { progress . Id } ] { progress . Status } : { progress . PrecedingTasks ?? progress . Progress } " ) ) ) ;
Debug . Log ( $" { taskResult . Id } | created_at: { taskResult . FinishedAt } | expires_at: { taskResult . ExpiresAt } " ) ;

Text zu 3D

Erzeugen Sie schnell beeindruckende 3D -Modelle mit Textanforderungen.

Listen Sie den Text in 3D -Aufgaben auf

 var api = new MeshyClient ( ) ;
var textTo3DTasks = await MeshyClient . TextTo3DEndpoint . ListTasksAsync ( 1 , 12 , SortOrder . Descending ) ;

foreach ( var meshyTask in textTo3DTasks )
{
    Debug . Log ( $" { meshyTask . Id } | created_at: { meshyTask . CreatedAt } " ) ;
} 

Erstellen Sie einen neuen Text zur 3D -Aufgabe

 var request = new TextTo3DRequest ( " a treasure chest " , " realistic, wooden, carved, highest quality " , resolution : Resolutions . X1024 , artStyle : ArtStyles . Realistic ) ;
var taskResult = await MeshyClient . TextTo3DEndpoint . CreateTextTo3DTaskAsync ( request , new Progress < TaskProgress > ( progress => Debug . Log ( $" [ { progress . Id } ] { progress . Status } : { progress . PrecedingTasks ?? progress . Progress } " ) ) ) ;
Debug . Log ( $" { taskResult . Id } | created_at: { taskResult . FinishedAt } | expires_at: { taskResult . ExpiresAt } " ) ;

Bild zu 3D

Verwandeln Sie Ihre 2D -Bilder schnell in atemberaubende 3D -Modelle und erwecken Sie Ihre Grafiken zum Leben.

Listen Sie das Bild in 3D -Aufgaben auf

Euen Derzeit funktioniert nicht mit der aktuellen API -Version.

 var api = new MeshyClient ( ) ;
var imageTo3dTasks = await api . ImageTo3DEndpoint . ListTasksAsync ( 1 , 12 , SortOrder . Descending ) ;

foreach ( var meshyTask in imageTo3dTasks )
{
    Debug . Log ( $" { meshyTask . Id } | created_at: { meshyTask . CreatedAt } " ) ;
} 

Erstellen Sie ein neues Bild zur 3D -Aufgabe

 var api = new MeshyClient ( ) ;
var imageUrl = " https://raw.githubusercontent.com/KhronosGroup/glTF-Sample-Assets/main/Models/Fox/screenshot/screenshot-x150.jpg " ;
var request = new ImageTo3DRequest ( imageUrl ) ;
var taskResult = await api . ImageTo3DEndpoint . CreateImageTo3DTaskAsync ( request , new Progress < TaskProgress > ( progress => Debug . Log ( $" [ { progress . Id } ] { progress . Status } : { progress . PrecedingTasks ?? progress . Progress } " ) ) ) ;
Assert . IsNotNull ( taskResult ) ;
Debug . Log ( $" { taskResult . Id } | created_at: { taskResult . FinishedAt } | expires_at: { taskResult . ExpiresAt } " ) ;