diff --git a/README.md b/README.md index bdb7d3a96dc547c2327614749b7afbd1372c1a3f..2f2494e15f70da293deb88555184467085176ada 100644 --- a/README.md +++ b/README.md @@ -1,92 +1,129 @@ # IF3210-2023-Unity-TTD +### Deskripsi Aplikasi + Aplikasi ini merupakan sebuah permainan __Extended Survival Shooter__ yang dibuat menggunakan Unity yang dibuat untuk memenuhi Tugas Besar 2 Unity - IF3210 Pengembangan Aplikasi pada Platform Khusus. -## Getting started +Adapun aplikasi ini memiliki beberapa spesifikasi , yaitu : -To make it easy for you to get started with GitLab, here's a list of recommended next steps. +- Story Mode + + Alur cerita utama pada permainan ini. Pada mode ini terdapat 4 quest dengan quest terakhir adalah boss fight. Untuk tiap quest yang berhasil diselesaikan, _player_ akan mendapatkan _reward_ berupa sejumlah _coin_. Selain itu, pada mode ini juga terdapat 3 _scene_ untuk mendukung keberjalan alur cerita. -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)! +- Save Game -## Add your files + Fitur ini digunakan untuk menyimpan _state_ dari _player_. _Player_ diberikan pilihan untuk melakukan _save_ setiap kali _player_ berhasil menyelesaikan quest. Pada fitur ini, hanya terdapat 3 _save slot_ yang dapat digunakan oleh _player_. + + Apabila _player_ kalah pada quest, maka _state player_ akan __kembali ke _state player_ yang terakhir kali disimpan__ pada fitur ini (apabila _player_ **belum pernah melakukan _save_**, maka _state player_ akan kembali ke _state player_ saat __seperti baru memulai permainan__). -- [ ] [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: +- Game Over -``` -cd existing_repo -git remote add origin https://gitlab.informatika.org/sumertayoga/if3210-2023-unity-ttd.git -git branch -M main -git push -uf origin main -``` + Fitur ini digunakan untuk mengakhiri permainan. Fitur ini akan dipanggil apabila _player_ kalah atau berhasil memenangkan permainan (menyelasaikan quest terakhir). -## Integrate with your tools + Apabila _player_ kalah, maka _player_ akan diberi pilihan untuk kembali ke _main menu_ atau mengulangi permainan. + - Apabila _player_ memilih untuk mengulangi permainan, maka _state player_ akan kembali sesuai dengan yang sudah dijelaskan pada fitur **_Save Game_**. + + - Apabila _player_ memilih untuk kembali ke _main menu_ atau _player_ tidak memilih selama 5 detik, maka _player_ akan kembali ke **_main menu_**. -- [ ] [Set up project integrations](https://gitlab.informatika.org/sumertayoga/if3210-2023-unity-ttd/-/settings/integrations) + Apabila _player_ menang, maka data permainan dari _player_ akan disimpan ke _scoreboard_ dan _player_ akan dialihkan ke **_local scoreboard_**. -## Collaborate with your team +- Local Scoreboard + + Fitur ini digunakan untuk menampilkan riwayat skor hasil permainan, terurut dari __skor terbaik__, yaitu __waktu untuk menamatkan game__. Yang ditampilkan fitur ini adalah _username_ dan _score_ dari _player_ yang telah __memenangkan__ permainan. _Player_ dapat kembali ke _main menu_ dari fitur ini. -- [ ] [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/) -- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) + Fitur ini dapat diakses melalui _main menu_ atau ketika _player_ __menang__ pada permainan. -## Test and Deploy +- Main Menu + + Pada _main menu_ terdapat beberapa fitur, yaitu : + - **_New Game_** : Memulai permainan baru + - **_Load Game_** : Memulai permainan dengan save game yang disimpan + - **_Scoreboard_** : Menampilkan _local scoreboard_ + - **_Option_** : Memasuki menu _option_ untuk mengatur **_volume_** permainan dan **nama** dari _player_ + - **_Exit_** : Keluar dari permainan -Use the built-in continuous integration in GitLab. +- Weapon -- [ ] [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) + Pada permainan ini, _player_ dapat menggunakan 4 jenis senjata, yaitu : + - Gun (default) + - Shotgun + - Sword + - Bow -*** + Setiap senjata memiliki _damage_ dan mekanisme yang berbeda-beda. Setiap senjata memiliki _slot_ yang berbeda-beda pada _keyboard_ (angka 1-4). + + Selain _default weapon_ yang dapat digunakan secara bebas, _player_ harus **membeli** terlebih dahulu pada **_shop_** untuk menggunakan senjata lainnya. -# Editing this README +- Pet + + Pada permainan ini terdapat 3 jenis _pet_, yaitu : + - Attacker (menyerang dan mengerjar musuh) + - Healer (memberikan heal setiap 10 detik) + - Buff (memberikan heal setiap 10 detik) -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!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template. + _Pet_ harus dibeli pada **_shop_** dan _player_ **hanya dapat memiliki satu _pet_** pada saat yang sama. + + _Pet_ hanya dapat diganti dengan _pet_ yang lain apabila _pet_ yang sebelumnya sudah **__mati__** (dibunuh oleh musuh atau dengan _cheat_). -## Suggestions for a good README -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. +- Shop + + Fitur ini digunakan untuk membeli _item_ yang dapat digunakan pada permainan. _Item_ yang dapat dibeli adalah : + - Senjata + - _Pet_ -## Name -Choose a self-explaining name for your project. + _Shop_ hanya akan muncul selama **30 detik** setelah _player_ **berhasil menyelesaikan quest**. _Player_ dapat membeli _item_ dengan _coin_ yang didapat dari quest yang telah diselesaikan. -## 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. + _Shop_ hanya dapat diakses pada radius tertentu. Apabila _player_ **berada di luar radius** dan _player_ **mencoba untuk membuka _shop_** (menekan _keypress_ B), maka _player_ akan mendapatkan **pesan bahwa _player_ berada di luar area Shop**. -## 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. + Apabila _player_ mencoba untuk **membuka _shop_ saat mengerjakan _quest_**, maka _player_ akan mendapatkan **pesan bahwa _shop_ tidak tersedia**. -## 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. + [BONUS] -## 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. + Pada _shop_ juga terdapat fitur untuk melakukan **_upgrade_** terhadap _weapon_ yang sudah _player_ miliki. + + _Weapon_ yang sudah di-_upgrade_ akan mendapatkan **_damage_ yang bertambah**. + + _Player_ **hanya** dapat melakukan _upgrade_ terhadap _weapon_ yang dimiliki **sebanyak 1x** (untuk tiap _weapon_). -## 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. +- Cheat + + Fitur ini dapat diakses oleh _player_ dengan menekan _keypress_ **` (backtick)** pada _keyboard_ yang akan membawa _player_ ke _menu_ **_cheat_**. -## 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. + Terdapat beberapa _cheat_ yang dapat _player_ gunakan, yaitu : + - **_Restore Player Health_** : Mengembalikan _health_ _player_ menjadi **100%**. + - **_Restore Pet Health_** : Mengembalikan _health_ _pet_ menjadi **100%**. + - **_Immortal Player_** : Membuat _player_ menjadi **imortal** + - **_Immortal Pet_** : Membuat _pet_ menjadi **imortal** + - **_Player Suicide_** : Membunuh _player_. + - _**Kill Pet**_ : Membunuh _pet_ + - _**One hit kill Enemy**_ : _Player_ dapat membunuh musuh dengan _**satu hit**_ + - _**Crazy Rich**_ : _Player_ menjadi sangat kaya dan bisa membeli apa saja + - _**Player Speed Multiplier**_ : **Menambahkan atau mengurangi** _speed_ dari _player_ + - _**Player Damage Multiplier**_ : **Menambahkan atau mengurangi** _damage_ dari _player_ + - _**Player Health Multiplier**_ : **Menambahkan atau mengurangi** _health_ dari _player_ + - _**Reset Score Data**_ : Menghapus data _score_ yang ada + - _**Reset Save**_ : Menghapus semua hasil _save game_ dari _player_ -## Roadmap -If you have ideas for releases in the future, it is a good idea to list them in the README. +### Library Yang Digunakan -## Contributing -State if you are open to contributions and what your requirements are for accepting them. + Seluruh library yang digunakan pada pengerjaan aplikasi Unity ini adalah bawaan dari Unity Engine, seperti : -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. + - UnityEngine.UI + - UnityEngine.Timeline + - TMPro + - UnityEngine.TestTools (Unity Test Framework), dan -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. + package-package untuk integrasi Unity dengan text editor -## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. +### Screenshot aplikasi. -## License -For open source projects, say how it is licensed. +### Pembagian Kerja + +NIM | Nama | Tugas | Jam Persiapan dan Pengerjaan +--- | --- | --- | --- | +13520021 | Gede Sumerta Yoga | inisialisasi game, pet | +13520090 | Rahmat Rafid Akbar | Cheat, Main Menu, Game Over, Local Scoreboard | +13520133 | Jevant Jedidia Augustine | Inisialisasi game, story mode, Save & Load | +13520141 | Yoseph Alexander Siregar | Shop, Bonus Upgrade Weapon | 12 jam +13520143 | Muhammad Gerald Akbar Giffera | Weapon, Bonus Upgrade Weapon | -## 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.