diff --git a/README.md b/README.md index 125e551421d2091db589859676ee1a0ca08f28b2..5679558f9892f1cf38eb2f811dfb3ea8e928aa7a 100644 --- a/README.md +++ b/README.md @@ -1,93 +1,215 @@ # IF3210-2024-Unity-AFK +## Deskripsi Aplikasi +Aplikasi ini merupakan desktop game yang berbasis Unity. Game ini merupakan first-person game dengan tema survival shooter dan bertipe open world. Latar belakang permainan berada di suatu desa yang terletak di dekat hutan. Desa tersebut diserang oleh bandit yang memiliki tingkatan-tingkatan berikut. -## Getting started +1. Keroco (Bandit) -To make it easy for you to get started with GitLab, here's a list of recommended next steps. + Keroco memiliki senjata berupa sword. Keroco ini hanya dapat menyerang dari jarak dekat, sehingga keroco diprogram untuk selalu mengejar player. -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! +2. Kepala Keroco (Bandit Leader) -## Add your files + Kepala keroco memiliki senjata berupa shotgun. Kepala keroco dapat menyerang dari jarak jauh. -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: +3. Jendral (General) -``` -cd existing_repo -git remote add origin https://gitlab.informatika.org/NerbFox/if3210-2024-unity-afk.git -git branch -M main -git push -uf origin main -``` + Jendral memiliki senjata berupa sword dengan damage yang lebih besar dibanding Keroco. -## Integrate with your tools +4. Raja (King) -- [ ] [Set up project integrations](https://gitlab.informatika.org/NerbFox/if3210-2024-unity-afk/-/settings/integrations) + Raja memiliki senjata berupa shotgun. Raja memiliki kemampuan khusus, yaitu setiap ada pemain yang mendekatinya dalam jarak tertentu, pemain tersebut akan mengalami perlambatan gerak, penurunan nilai serangan, dan pengurangan health tiap detik. Tidak hanya itu, raja dapat mengeluarkan 1 keroco setiap 15 detik. Raja dapat menyerang dari jarak jauh menggunakan shotgun. Raja memiliki 2 buah pet yang tidak dapat hidup kembali. -## Collaborate with your team +Tujuan utama game ini adalah menyelesaikan seluruh quest dan mengalahkan seluruh musuh dengan senjata yang tersedia. Terdapat tiga jenis senjata, yaitu: -- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) -- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) -- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) +1. Sword -## Test and Deploy + Merupakan senjata jarak dekat. -Use the built-in continuous integration in GitLab. +2. Pistol -- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) -- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) -- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) -- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) -- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) + Merupakan senjata jarak jauh. -*** +3. Shotgun -# Editing this README + Merupakan senjata jarak jauh yang dapat menembakkan beberapa peluru dalam satu tembakan dengan arah yang berbeda-beda. -When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template. +Apabila pemain membunuh musuh, terdapat orb yang dapat muncul secara random, yaitu -## Suggestions for a good README +1. Orb Increase Damage -Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. + Orb ini meningkatkan damage pemain sebesar 10 persen dari base damage. Efek dari orb ini berlaku secara permanen. -## Name -Choose a self-explaining name for your project. +2. Orb Restore Health -## Description -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. + Orb ini mengisi ulang health pemain sebesar 20 persen. Jika health pemain 85 persen dan mengambil orb ini, health pemain menjadi 100 persen. -## Badges -On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. +3. Orb Increase Speed -## Visuals -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. + Orb ini meningkatkan speed pemain sebesar 20 persen selama 15 detik. Jika pemain mengambil orb ini sebelum power up habis, maka waktu sisa power up akan menjadi 15 detik lagi dan power up speed pemain tetap 20 persen dari base speed. -## Installation -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. +Terdapat pula pet yang dapat membantu pemain/musuh dalam permainan. Healer Pet dan Attacker Pet dapat dibeli player dari Shop Keeper dengan menekan tombol `B`. Sedangkan Increaser Pet hanya dapat dimiliki jenderal/raja. -## Usage -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. +1. Healer Pet -## Support -Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. + Pet ini dapat dimiliki oleh pemain. Karakteristik pet ini akan selalu mengikuti kemana pemain pergi. Setiap 2 detik, pet akan menambahkan HP dari pemain sesuai dengan konfigurasi awal. -## Roadmap -If you have ideas for releases in the future, it is a good idea to list them in the README. +2. Attacker Pet -## Contributing -State if you are open to contributions and what your requirements are for accepting them. + Pet ini dapat dimiliki oleh pemain. Karakteristik pet ini akan selalu mendekati musuh terdekat dan menyerangnya. Nilai damage dari pet ini sesuai dengan konfigurasi awal. -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. +3. Increaser Pet -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. + Pet ini dapat dimiliki oleh Jenderal dan Raja. Pet ini akan meningkatkan nilai serangan tembak Jenderal dan Raja. Pertambahan untuk tiap pet adalah 20% dari nilai awal. Pada kasus Raja, jika ada 2 pet, maka pertambahan nilai serangan tembak Raja menjadi 40% dari semula. Pet ini memiliki karakteristik untuk menghindar dari pemain, akan tetapi kecepatan gerak pet ini < kecepatan gerak pemain. -## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. +Terdapat 4 quest yang harus diselesaikan pemain untuk menyelesaikan game ini. Setiap pemain berhasil menyelesaikan quest, maka terdapat lokasi pada map yang dapat di-unlock untuk quest berikutnya. -## License -For open source projects, say how it is licensed. +1. Quest 1: Pemain perlu bertahan selama 1 menit +2. Quest 2: Pemain perlu mengalahkan 5 Keroco dan 2 Kepala Keroco +3. Quest 3: Pemain perlu mengalahkan 10 Keroco, 3 Kepala Keroco, dan 1 Jenderal dalam 2 menit +4. Quest 4: Pemain perlu mengalahkan Raja -## Project status -If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. +Berikut adalah penjelasan lebih lanjut mengenai cerita dan dialog pada game ini. +[Game Story](https://docs.google.com/document/d/17tYUr0Ce9P1ver0CgX6k3-eqpedhpb6FgJm7ce3wwZI/edit?usp=sharing) + +Berikut adalah fitur lainnya yang terdapat pada game ini. + +1. Main Menu + Main menu merupakan scene pertama yang diload ketika membuka permainan. Berikut adalah fitur yang terdapat pada main menu. + + - Memulai game baru (new game). + - Memulai gim dengan permainan yang pernah disimpan (load game). + - Membuka Statistik Game. + - Membuka menu pengaturan untuk mengatur beberapa hal berikut: + - Menentukan nama pemain. + - Mengatur volume sfx/musik. + - Mengubah tingkat kesulitan (difficulty) permainan + - Mengakhiri game (exit). + +2. Load dan Save + + Pemain dapat menyimpan permainan. Terdapat tiga slots untuk save game. Save hanya dapat dilakukan di dekat lokasi tertentu, yaitu batu menhir dengan huruf R. Save dilakukan dengan menekan tombol `E`. Permainan yang telah di-save dapat di-load kembali setelah pemain keluar dari game. + +3. Game Over + + Apabila health pemain habis, halaman Game Over akan muncul dan terdapat tombol untuk kembali ke main menu. + +4. Statistik Game + + Terdapat statistik yang disimpan pada permainan, yaitu: + + - Shot accuracy: jumlah tembakan yang masuk ke musuh + - Distance traveled: jarak yang sudah ditempuh oleh pemain dalam satuan kilometer + - Playtime: lama pemain bermain game dengan format HH:mm:ss + - Kill Count: jumlah musuh yang telah dibunuh + - Death Count: berapa kali player telah terbunuh + - Spend count: uang yang telah dihabiskan pemain + +5. Cheat + + Cheat dapat diakses dengan menekan tombol backtick (`) yang akan memunculkan console, kemudian memasukkan salah satu cheat code berikut. Cheat bersifat toggle, artinya saat pertama kali memasukkan cheat code, maka cheat akan aktif. Jika kita memasukkan cheat code yang sama kembali, maka cheat akan non aktif. + + - `godmode`: HP player tidak dapat berkurang + - `motherlode`: Player mendapatkan tambahan uang sebesar 999999 + - `agent47`: One hit kill + - `flash`: 2x speed + - `superpet`: HP pet tidak dapat berkurang + - `callpeta`: Membunuh pet secara instan + - `powerup <int>`: Mendapatkan random orb effect. Parameter integer memiliki range (0..2) yang merupakan ID dari orb (0: speed, 1: damage: 2: health) + - `skipper` + +## Library yang Digunakan + +Library yang digunakan hanyalah library bawaan dari UnityEngine dan C# + +## Screenshot Aplikasi + +## Pembagian Kerja Anggota Kelompok + +<table> + <tr> + <th>NIM</th> + <th>Nama</th> + <th>Pembagian Kerja</th> + </tr> + <tr> + <td>13521043</td> + <td>Nigel Sahl</td> + <td> + Setup unity, environment, AI Navigation agent dan NavMesh Modifier Pet, ShortWeapon Behaviour (untuk enemy dan pet), Main Player Behavior, Sword weapon untuk main player, Orbs, Enemy Keroco Behaviour dan controller untuk spawn mobs dan orbs + </td> + </tr> + <tr> + <td>13521057</td> + <td>Hosea Nathanael Abetnego</td> + <td> + Senjata, save, settings, statistik, map (terrain) + </td> + </tr> + <tr> + <td>13521149</td> + <td>Rava Maulana Azzikri</td> + <td> + Quest, main menu, base class orb, sword, load dan save + </td> + </tr> + <tr> + <td>13521157</td> + <td>Hanif Muhammad Zhafran</td> + <td> + Game Design (story, game mechanic), mobs (assets, behaviour scripts): kepala keroco, jendral, raja, map (terrain) + </td> + </tr> + <tr> + <td>13521170</td> + <td>Haziq Abiyyu Mahdy</td> + <td> + Keroco (AI NavMesh agent, asset, behaviour script, sword script, animation), save game, pause game, shopkeeper (asset, UI), audio manager, controller untuk spawn mobs + </td> + </tr> +</table> + +## Jumlah Jam Kerja + +<table> + <tr> + <th>NIM</th> + <th>Nama</th> + <th>Jam Kerja</th> + </tr> + <tr> + <td>13521043</td> + <td>Nigel Sahl</td> + <td> + 120 + </td> + </tr> + <tr> + <td>13521057</td> + <td>Hosea Nathanael Abetnego</td> + <td> + 120 + </td> + </tr> + <tr> + <td>13521149</td> + <td>Rava Maulana Azzikri</td> + <td> + 120 + </td> + </tr> + <tr> + <td>13521157</td> + <td>Hanif Muhammad Zhafran</td> + <td> + 120 + </td> + </tr> + <tr> + <td>13521170</td> + <td>Haziq Abiyyu Mahdy</td> + <td> + 120 + </td> + </tr> +</table>