com.rest.meshy

com.rest.meshy

ไคลเอนต์ AI RESTFUL ที่ไม่เป็นทางการที่ไม่เป็นทางการสำหรับเอ็นจิ้นเกม Unity

ลิขสิทธิ์เครื่องหมายการค้าโลโก้และสินทรัพย์ทั้งหมดเป็นทรัพย์สินของเจ้าของที่เกี่ยวข้อง

พื้นที่เก็บข้อมูลนี้สามารถถ่ายโอนไปยังองค์กร Meshy ได้หากพวกเขาเลือกที่จะยอมรับ

การติดตั้ง

ต้องใช้เอกภาพ 2021.3 LTS หรือสูงกว่า

วิธีการติดตั้งที่แนะนำคือแม้ว่า Unity Package Manager และ OpenUPM

ผ่าน Unity Package Manager และ OpenUPM

• เปิดการตั้งค่าโครงการ Unity ของคุณ
• เลือก Package Manager
• เพิ่ม OpenUPM Package Registry:
  • ชื่อ: OpenUPM
  • URL: https://package.openupm.com
  • ขอบเขต:
    • com.rest.meshy
• เปิดหน้าต่าง Unity Package Manager
• เปลี่ยนรีจิสทรีจากเอกภาพเป็น My Registries
• เพิ่มแพ็คเกจ Meshy

ผ่าน Unity Package Manager และ Git URL

• เปิดตัวจัดการแพ็คเกจ Unity ของคุณ
• เพิ่มแพ็คเกจจาก GIT URL: https://github.com/RageAgainstThePixel/com.rest.meshy.git#upm

  หมายเหตุ: repo นี้มีการพึ่งพาที่เก็บอื่น ๆ ! คุณต้องรับผิดชอบในการเพิ่มสิ่งเหล่านี้ด้วยตัวคุณเอง

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

---

เอกสาร

สารบัญ

• การรับรองความถูกต้อง
• แผงหน้าปัด
• ส่งข้อความถึงพื้นผิว
  • รายการข้อความไปยังงานพื้นผิว
  • สร้างข้อความเป็นงานพื้นผิว
• ส่งข้อความถึง 3D
  • รายการข้อความเป็นงาน 3D
  • สร้างข้อความเป็นงาน 3D
• ภาพเป็น 3D
  • รายการรูปภาพเป็นงาน 3D
  • สร้างภาพเป็นงาน 3D

การรับรองความถูกต้อง

มี 4 วิธีในการจัดหาคีย์ API ของคุณตามลำดับความสำคัญ:

เราแนะนำให้ใช้ตัวแปรสภาพแวดล้อมเพื่อโหลดคีย์ API แทนที่จะให้รหัสยากในแหล่งที่มาของคุณ ไม่แนะนำให้ใช้วิธีนี้ในการผลิต แต่สำหรับการยอมรับข้อมูลรับรองผู้ใช้การทดสอบในท้องถิ่นและสถานการณ์เริ่มต้นอย่างรวดเร็ว

1. ผ่านปุ่มโดยตรงกับตัวสร้าง
2. วัตถุที่เป็นเอกภาพ
3. โหลดคีย์จากไฟล์กำหนดค่า
4. ใช้ตัวแปรสภาพแวดล้อมระบบ

คุณใช้ MeshyAuthentication เมื่อคุณเริ่มต้น API ดังที่แสดง:

ผ่านปุ่มโดยตรงกับตัวสร้าง

เราแนะนำให้ใช้ตัวแปรสภาพแวดล้อมเพื่อโหลดคีย์ API แทนที่จะให้รหัสยากในแหล่งที่มาของคุณ ไม่แนะนำให้ใช้วิธีนี้ในการผลิต แต่สำหรับการยอมรับข้อมูลรับรองผู้ใช้การทดสอบในท้องถิ่นและสถานการณ์เริ่มต้นอย่างรวดเร็ว

 var api = new MeshyClient ( " msy_apikey123 " ) ;

หรือสร้างวัตถุ MeshyAuthentication ด้วยตนเอง

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

วัตถุที่เป็นเอกภาพ

คุณสามารถบันทึกคีย์ได้โดยตรงลงในวัตถุสคริปต์ที่อยู่ในโฟลเดอร์ Assets/Resources

คุณสามารถสร้างใหม่ได้โดยใช้เมนูบริบทของบานหน้าต่างโครงการและสร้างวัตถุสคริปต์ MeshyConfiguration ใหม่

ระวังการตรวจสอบไฟล์นี้ลงในการควบคุมแหล่งที่มาเนื่องจากคนอื่น ๆ จะสามารถดูคีย์ API ของคุณได้

โหลดคีย์จากไฟล์กำหนดค่า

ความพยายามในการโหลดคีย์ API จากไฟล์การกำหนดค่าโดยค่าเริ่มต้น .meshy ในไดเรกทอรีปัจจุบันโดยทางเลือกข้ามแผนผังไดเรกทอรีหรือในไดเรกทอรีบ้านของผู้ใช้

ในการสร้างไฟล์กำหนดค่าให้สร้างไฟล์ข้อความใหม่ชื่อ .meshy และมีบรรทัด:

รายการองค์กรเป็นทางเลือก

รูปแบบ JSON

{
  "apiKey" : " msy_apikey123 "
}

นอกจากนี้คุณยังสามารถโหลดไฟล์กำหนดค่าได้โดยตรงด้วยเส้นทางที่รู้จักโดยเรียกวิธีการคงที่ใน MeshyAuthentication :

• โหลดค่าเริ่มต้น .meshy config ในไดเรกทอรีที่ระบุ:

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

• โหลดไฟล์การกำหนดค่าจากพา ธ เฉพาะ ไฟล์ไม่จำเป็นต้องตั้งชื่อ .meshy ตราบเท่าที่มันสอดคล้องกับรูปแบบ JSON:

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

ใช้ตัวแปรสภาพแวดล้อมระบบ

ใช้ตัวแปรสภาพแวดล้อมของระบบของคุณระบุคีย์ API และองค์กรที่จะใช้

• ใช้ MESHY_API_KEY สำหรับคีย์ API ของคุณ

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

แผงหน้าปัด

คุณสามารถทำงานเดียวกันในแผงควบคุมได้เช่นเดียวกับใน WebApp

Pro-Tip: คุณสามารถใช้หน้าต่างบริบทเพื่อเข้าถึงตัวเลือกตัวแก้ไขได้อย่างรวดเร็วสำหรับ prefabs และวัตถุฉาก!

เข้าถึงแดชบอร์ดผ่าน Window/Dashboards/Meshy

• สร้างพื้นผิวสำหรับรุ่น 3D ที่มีอยู่
• สร้างโมเดล 3 มิติจากพรอมต์ข้อความ
• สร้างโมเดล 3 มิติจากภาพ

ส่งข้อความถึงพื้นผิว

สร้างพื้นผิวที่มีคุณภาพสูงอย่างรวดเร็วสำหรับรุ่น 3 มิติที่มีอยู่ของคุณโดยใช้ข้อความแจ้งข้อความและแนวคิดศิลปะ

รายการข้อความไปยังงานพื้นผิว

 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 } " ) ;
} 

สร้างข้อความใหม่เป็นงานพื้นผิว

สร้างข้อความใหม่ไปยังงานพื้นผิวและรายงานความคืบหน้าจนกว่างานจะเสร็จสมบูรณ์

ผ่าน prefab หรือ scene gameObject ที่จะได้รับการปรับปรุงใหม่:

 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 } " ) ;

หากคุณต้องการควบคุมกระบวนการส่งออก GLB มากขึ้นคุณสามารถส่งผ่าน GLTFast.Export.GameObjectExport ของคุณเอง: วัตถุ:

 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 } " ) ;

คุณยังสามารถใช้ URL สาธารณะ:

 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 } " ) ;

ส่งข้อความถึง 3D

สร้างรุ่น 3 มิติที่น่าประทับใจอย่างรวดเร็วโดยใช้ข้อความแจ้ง

รายการข้อความเป็นงาน 3D

 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 } " ) ;
} 

สร้างข้อความใหม่เป็นงาน 3D

 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 } " ) ;

ภาพเป็น 3D

เปลี่ยนภาพ 2D ของคุณอย่างรวดเร็วให้เป็นรุ่น 3 มิติที่น่าทึ่งและทำให้ภาพของคุณมีชีวิตชีวา

รายการรูปภาพเป็นงาน 3D

ปัจจุบันไม่ทำงานกับเวอร์ชัน API ปัจจุบัน

 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 } " ) ;
} 

สร้างภาพใหม่เป็นงาน 3D

 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 } " ) ;