nako-mascot 0.0.0-stage → 1.0.0

package/LICENSE.txt

@@ -0,0 +1,13 @@
+Nako. — Ketentuan Penggunaan Khusus Proyek Pemilik
+Versi 1.0 — 22 Oktober 2026
+SPDX: LicenseRef-Nako-Private
+
+Karakter Nako., nama, logo, ilustrasi, animasi, aset, dan kode integrasi pada paket ini disediakan untuk proyek milik pemilik Nako. dan tim yang mendapat wewenang darinya. Izin internal mencakup pemasangan, integrasi, serta penyesuaian ukuran dan penempatan dalam proyek pemilik, termasuk nanaaja, pbox, renaaja, dan proyek lain yang disetujui pemilik. Izin ini tidak dapat dialihkan ke pihak lain.
+
+Pihak lain memerlukan izin tertulis sebelum memakai, menyalin, memodifikasi, menjual, mendistribusikan ulang, atau menjadikan Nako. identitas proyek, produk, maupun materi promosi. Atribusi bukan pengganti izin. Dilarang mengklaim kepemilikan atau afiliasi yang tidak disetujui.
+
+Akses publik ke demo atau URL CDN tidak memberikan izin penggunaan untuk proyek lain. Ketentuan ini bukan pernyataan pendaftaran merek atau jaminan perlindungan eksklusif atas setiap unsur visual. Hak pihak ketiga tetap berlaku. Aset visual dibuat dengan bantuan AI dan penyuntingan teknis.
+
+Komponen pihak ketiga tetap mengikuti lisensinya masing-masing. Font Fredoka dan Manrope menggunakan SIL Open Font License.
+
+Ketentuan lengkap: https://nako.nanaaja.web.id/license

package/README.md

@@ -1,3 +1,105 @@
-# Temporary Holding Version
+# Nako.
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Komponen web `nako-mascot` dengan 26 animasi semi-3D. Paket ESM ini hanya untuk proyek milik pemilik Nako. atau pihak yang diberi izin tertulis. Paket disiapkan untuk publikasi sebagai `nako-mascot`; panduan registry berikut berlaku setelah versi tersebut terbit.
+
+## Pasang melalui npm atau Bun
+
+Setelah `nako-mascot@1.0.0` tersedia di registry npm:
+
+```sh
+npm install nako-mascot@1.0.0
+npx --no-install nako-assets
+```
+
+Dengan Bun:
+
+```sh
+bun add nako-mascot@1.0.0
+bunx --no-install nako-assets
+```
+
+Keduanya mengambil paket dari registry npm yang sama. `nako-assets` menyalin aset ke `public/nako/`; sertakan folder hasil salinan saat deployment aplikasi.
+
+## Pasang dari arsip lokal
+
+Salin `nako-mascot-1.0.0.tgz` ke folder `vendor/` di proyek pemakai. Sertakan arsip dan lockfile saat build/deploy agar pemasangan tidak bergantung pada path laptop pengembang.
+
+```sh
+npm install ./vendor/nako-mascot-1.0.0.tgz
+npx --no-install nako-assets
+```
+
+Dengan Bun:
+
+```sh
+bun add ./vendor/nako-mascot-1.0.0.tgz
+bunx --no-install nako-assets
+```
+
+Perintah kedua menyalin manifest, sprite, dan poster ke `public/nako/`. Sertakan folder itu saat build/deploy aplikasi. Tidak ada script instalasi otomatis, akses layanan Tripo, atau dependency Three.js di paket runtime. Browser hanya mengambil atlas aktif dan berikutnya.
+
+Di entry JavaScript aplikasi:
+
+```js
+import 'nako-mascot/register';
+```
+
+Di HTML/template:
+
+```html
+<nako-mascot mode="loading" style="--nako-size:160px"></nako-mascot>
+```
+
+Folder `public/nako` harus tersedia pada URL `/nako/`. Misalnya Vite, Next.js, Nuxt, SvelteKit, atau Laravel dengan konfigurasi public standarnya. Jika folder statis proyek berbeda, jalankan `nako-assets static/nako` (SvelteKit), atau arahkan ke folder yang dipakai proyekmu.
+
+URL aset alternatif memakai atribut `assets-base`, contohnya `<nako-mascot assets-base="/app/nako/" mode="idle"></nako-mascot>`. Jika aset di domain lain, aktifkan CORS untuk manifest dan gambar.
+
+## SSR dan Next.js
+
+Entry `nako-mascot` aman diimpor pada server. Registrasi elemen dilakukan di browser:
+
+```js
+import {defineNakoMascot} from 'nako-mascot';
+await defineNakoMascot(); // null saat SSR; constructor setelah registrasi di browser
+```
+
+Contoh komponen Next.js (JavaScript):
+
+```jsx
+'use client';
+import {createElement, useEffect} from 'react';
+
+export default function Nako() {
+  useEffect(() => { void import('nako-mascot/register'); }, []);
+  return createElement('nako-mascot', {
+    mode: 'loading',
+    style: {'--nako-size': '160px'},
+  });
+}
+```
+
+Vue perlu mengenali tag sebagai custom element melalui `compilerOptions.isCustomElement`. Laravel/Blade dapat memakai modul bundler Vite atau integrasi URL langsung.
+
+## Kontrol
+
+```js
+import {defineNakoMascot} from 'nako-mascot';
+await defineNakoMascot();
+const nako = document.querySelector('nako-mascot');
+await nako.ready;
+await nako.play('assistant-wave');
+await nako.playMode('loading');
+await nako.playAll();
+nako.pause();
+nako.resume();
+```
+
+Mode: `idle`, `loading`, `transaction`, `arcade`, `assistant`. `animation` memilih satu gerakan; `showcase` memutar katalog. Atribut `animation` lebih diprioritaskan daripada mode/showcase.
+
+Pause, reduced motion, tab tersembunyi, serta keluar viewport ditangani oleh komponen. Mode transaksi tidak menampilkan sukses otomatis; `transaction-success` hanya dipicu setelah aplikasi memastikan transaksi sukses.
+
+## Aset dan lisensi
+
+26 atlas 512 px / 805 frame, total sekitar 14.63 MiB. Arsip mengandung semua aset untuk disalin saat build, tetapi browser tidak mengunduh semuanya sekaligus. Dua atlas yang sudah didekode membutuhkan sekitar 64 MiB. Paket tidak membawa model hero 3D, audio, atau logo.
+
+Paket dikonfigurasi untuk akses publik melalui registry npm. Akses publik memungkinkan pengunduhan paket; izin penggunaan Nako. tetap mengikuti lisensi khusus di `LICENSE.txt`.