From 2657b778ce25c9274163351513e38cdfef37b5f5 Mon Sep 17 00:00:00 2001 From: Shavira Azzaria A <149168135+itsvraza@users.noreply.github.com> Date: Tue, 10 Jun 2025 17:50:38 +0700 Subject: [PATCH] Create README.md --- README.md | 73 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 73 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c5245ab --- /dev/null +++ b/README.md @@ -0,0 +1,73 @@ +# ToothyV + +## Deskripsi Proyek +ToothyV adalah sebuah game edukasi interaktif yang dirancang untuk membantu anak usia 6-12 tahun memahami dan mempelajari tentang kesehatan gigi. Dengan antarmuka yang menarik dan fitur pembelajaran yang beragam, ToothyV bertujuan untuk meningkatkan pengetahuan tentang pentingnya menjaga kebersihan dan kesehatan gigi melalui pengalaman belajar yang menyenangkan dan interaktif. + +## Fitur Utama +* **Menu Belajar Interaktif:** Menyediakan modul pembelajaran komprehensif tentang kesehatan dan penyakit gigi umum yang disajikan secara menarik. +* **Pop-up Pre-test dan Post-test:** Fitur evaluasi pengetahuan pengguna melalui kuis interaktif yang mengukur pemahaman sebelum dan sesudah belajar. +* **Menu Bermain Interaktif:** Mode permainan yang memungkinkan pengguna untuk menyerang musuh berupa makanan tidak sehat, memperkuat konsep menjaga kesehatan gigi melalui gameplay yang seru. +* **Navigasi Menu yang Intuitif:** Antarmuka pengguna yang dirancang agar mudah digunakan oleh anak-anak, memudahkan eksplorasi konten pembelajaran dan permainan. + +## Teknologi yang Digunakan +Proyek ini dikembangkan menggunakan: +* **Unity 3D:** Sebagai game engine utama yang powerful untuk pengembangan game 2D/3D. +* **C#:** Bahasa pemrograman utama untuk implementasi logika dan interaktivitas game. +* **ShaderLab & HLSL:** Digunakan untuk menciptakan efek visual dan material kustom yang menarik dalam game. +* **Unity Cloud:** Dimanfaatkan untuk penyimpanan dan pengelolaan database pengguna, memungkinkan data persistensi dan fitur cloud lainnya. + +## Persyaratan Sistem +Untuk menjalankan atau mengembangkan proyek ToothyV, Anda memerlukan: +* **Unity Hub** dan **Unity Editor** (disarankan menggunakan versi yang kompatibel dengan Unity 2022.x/2023.x atau yang digunakan saat pengembangan terakhir). +* **Visual Studio** atau IDE lain yang kompatibel untuk pengembangan C# (misalnya Visual Studio Code dengan ekstensi C#). + +## Cara Menginstal dan Menjalankan Proyek +Ikuti langkah-langkah berikut untuk menginstal dan menjalankan proyek ToothyV di lingkungan pengembangan lokal Anda: + +1. **Kloning Repositori:** + ```bash + git clone https://github.com/itsvraza/ToothyV.git + ``` +2. **Buka Proyek di Unity Editor:** + * Buka **Unity Hub**. + * Klik "Add" atau "Open" dan arahkan ke direktori `ToothyV` yang baru saja Anda kloning. + * Pilih proyek dan buka dengan Unity Editor yang sesuai. Unity akan memuat semua aset dan script yang diperlukan. +3. **Jalankan Aplikasi/Game:** + * Setelah proyek berhasil dimuat di Unity Editor, Anda dapat menekan tombol `Play` (ikon segitiga) untuk menjalankan game dalam mode Editor. + * Untuk membuat build yang dapat dieksekusi (misalnya, untuk Android atau Windows), navigasikan ke `File > Build Settings` di Unity Editor, pilih platform target Anda, dan ikuti instruksi untuk proses build. + +## Kontribusi +Kami sangat menyambut kontribusi untuk pengembangan ToothyV! Jika Anda tertarik untuk berkontribusi, silakan ikuti panduan di bawah ini: + +1. **Fork** repositori ini ke akun GitHub Anda. +2. **Kloning** repositori yang sudah Anda fork ke mesin lokal Anda. + ```bash + git clone https://github.com/itsvraza/ToothyV.git + ``` +3. **Buat cabang baru** untuk fitur atau perbaikan yang ingin Anda kerjakan: + ```bash + git checkout -b fitur/nama-fitur-baru-anda + # Contoh: git checkout -b feat/add-new-quiz-level + ``` +4. **Lakukan perubahan** pada kode Anda. +5. **Tambahkan perubahan** ke staging area dan **komit perubahan** Anda dengan pesan komit yang jelas dan deskriptif: + ```bash + git add . + git commit -m "feat: Menambahkan [deskripsi singkat fitur/perbaikan]" + # Contoh: git commit -m "feat: Menambahkan level kuis baru" + ``` + (Disarankan untuk menggunakan konvensi pesan komit seperti `feat:` untuk fitur baru, `fix:` untuk perbaikan bug, `docs:` untuk dokumentasi, dll.) +6. **Dorong cabang** Anda ke repositori fork Anda di GitHub: + ```bash + git push origin fitur/nama-fitur-baru-anda + ``` +7. **Buat Pull Request (PR)** dari cabang Anda ke cabang `main` di repositori asli (`itsvraza/ToothyV`). Berikan deskripsi yang jelas tentang perubahan Anda. + +## Lisensi +Proyek ini dilisensikan di bawah **MIT License**. +Lihat file [LICENSE](LICENSE) (jika ada) untuk detail lebih lanjut. + +## Kontak +Jika Anda memiliki pertanyaan, saran, atau ingin menghubungi, silakan kirimkan email ke e31222569@student.polije.ac.id atau buka [Issue baru](https://github.com/itsvraza/ToothyV/issues) di repositori ini. + +---