com.rest.meshy

com.rest.Meshy

Klien AI Restful AI yang tidak resmi untuk mesin game Unity.

Semua hak cipta, merek dagang, logo, dan aset adalah milik pemiliknya masing -masing.

Repositori ini tersedia untuk ditransfer ke organisasi Meshy jika mereka memilih untuk menerimanya.

Menginstal

Membutuhkan persatuan 2021.3 LTS atau lebih tinggi.

Metode instalasi yang disarankan adalah meskipun Unity Package Manager dan OpenUpm.

Via Unity Package Manager dan OpenUpm

• Buka Pengaturan Proyek Persatuan Anda
• Pilih Package Manager
• Tambahkan Paket OpenUpm Registry:
  • Nama: OpenUPM
  • URL: https://package.openupm.com
  • Lingkup:
    • com.rest.meshy
• Buka jendela Unity Package Manager
• Ubah registri dari persatuan ke My Registries
• Tambahkan paket Meshy

Via Unity Package Manager dan URL GIT

• Buka Manajer Paket Persatuan Anda
• Tambahkan paket dari URL GIT: https://github.com/RageAgainstThePixel/com.rest.meshy.git#upm

  Catatan: Repo ini memiliki dependensi pada repositori lain! Anda bertanggung jawab untuk menambahkan ini sendiri.

  • com.utilities.async
  • com.utilities.Extensions
  • com.utilities.rest

---

Dokumentasi

Daftar isi

• Otentikasi
• Dasbor
• Teks ke tekstur
  • Daftar teks ke tugas tekstur
  • Buat Tugas Teks ke Tekstur
• Teks ke 3d
  • Daftar teks ke tugas 3D
  • Buat Teks Teks ke 3D
• Gambar ke 3d
  • Daftar gambar ke tugas 3D
  • Buat Tugas Gambar ke 3D

Otentikasi

Ada 4 cara untuk memberikan kunci API Anda, dalam urutan prioritas:

️ Kami merekomendasikan menggunakan variabel lingkungan untuk memuat kunci API alih -alih memiliki kode keras di sumber Anda. Tidak disarankan menggunakan metode ini dalam produksi, tetapi hanya untuk menerima kredensial pengguna, pengujian lokal dan skenario start cepat.

1. Lulus kunci langsung dengan konstruktor ️
2. Objek Unityable Scriptable ️
3. Muat tombol dari file konfigurasi
4. Gunakan variabel lingkungan sistem

Anda menggunakan MeshyAuthentication saat Anda menginisialisasi API seperti yang ditunjukkan:

Lulus kunci langsung dengan konstruktor

️ Kami merekomendasikan menggunakan variabel lingkungan untuk memuat kunci API alih -alih memiliki kode keras di sumber Anda. Tidak disarankan menggunakan metode ini dalam produksi, tetapi hanya untuk menerima kredensial pengguna, pengujian lokal dan skenario start cepat.

 var api = new MeshyClient ( " msy_apikey123 " ) ;

Atau membuat objek MeshyAuthentication secara manual

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

Objek Unityable Scriptable

Anda dapat menyimpan kunci langsung ke objek skrip yang terletak di folder Assets/Resources .

Anda dapat membuat yang baru dengan menggunakan menu konteks panel proyek dan membuat objek skrip MeshyConfiguration baru.

️ Hati -hati memeriksa file ini ke kontrol sumber, karena orang lain akan dapat melihat kunci API Anda.

Muat tombol dari file konfigurasi

Upaya untuk memuat tombol API dari file konfigurasi, secara default .meshy di direktori saat ini, secara opsional melintasi pohon direktori atau di direktori home pengguna.

Untuk membuat file konfigurasi, buat file teks baru bernama .meshy dan berisi baris:

Entri organisasi adalah opsional.

Format JSON

{
  "apiKey" : " msy_apikey123 "
}

Anda juga dapat memuat file konfigurasi secara langsung dengan jalur yang diketahui dengan memanggil metode statis di MeshyAuthentication :

• Memuat konfigurasi .meshy default di direktori yang ditentukan:

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

• Memuat file konfigurasi dari jalur tertentu. File tidak perlu dinamai .meshy selama itu sesuai dengan format JSON:

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

Gunakan variabel lingkungan sistem

Gunakan variabel lingkungan sistem Anda Tentukan kunci API dan organisasi untuk digunakan.

• Gunakan MESHY_API_KEY untuk kunci API Anda.

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

Dasbor

Anda dapat melakukan tugas yang sama di dasbor seperti yang Anda lakukan di Webapp.

Pro-Tip: Anda juga dapat menggunakan jendela konteks untuk mengakses dengan cepat dalam opsi editor untuk prefab dan objek pemandangan!

Akses dasbor melalui Window/Dashboards/Meshy

• Menghasilkan tekstur untuk model 3D yang ada.
• Menghasilkan model 3D dari prompt teks.
• Menghasilkan model 3D dari suatu gambar.

Teks ke tekstur

Hasil tekstur berkualitas tinggi dengan cepat untuk model 3D Anda yang ada menggunakan petunjuk teks dan seni konsep.

Daftar teks ke tugas tekstur

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

Buat Teks Teks Baru untuk Tekstur

Membuat Teks Teks Baru untuk Tekstur, dan Laporan Kemajuan sampai Tugas selesai.

Lulus dalam prefab atau scene GameObject untuk ditekstur ulang:

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

Jika Anda membutuhkan lebih banyak kontrol atas proses ekspor GLB, Anda juga dapat meneruskan objek GLTFast.Export.GameObjectExport Anda sendiri:

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

Anda juga dapat menggunakan URL publik:

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

Teks ke 3d

Hasilkan model 3D yang mengesankan dengan cepat menggunakan prompt teks.

Daftar teks ke tugas 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 } " ) ;
} 

Buat Teks Baru untuk Tugas 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 } " ) ;

Gambar ke 3d

Ubah dengan cepat gambar 2D Anda menjadi model 3D yang menakjubkan dan menghidupkan visual Anda.

Daftar gambar ke tugas 3D

️ Saat ini tidak berfungsi dengan versi API saat ini.

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

Buat gambar baru untuk tugas 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 } " ) ;