Skip to content
This repository has been archived by the owner on Jun 13, 2024. It is now read-only.

Documentation Changes in README_dev (EN) and COMPILE (EN) #53

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions COMPILE_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,20 @@

## How to open and compile project in Unity?

After downloading repository master branch, launch Unity. Use 2018.3.12f1 64x version if possible. In the user panel press Open which was marked on the image below.
Download <a href="https://learn.unity.com/tutorial/install-the-unity-hub-and-editor">Unity Hub<a> to manage Unity and it's different versions.

After downloading/cloning repository master branch, launch Unity. Use 2018.3.12f1 64x version if possible, which can be found on the <a href="https://unity.com/releases/editor/archive">Unity Archive Releases<a>. In the user panel, press Open which was marked on the image below.

Open the project and select the proper version if you have any other versions installed.

<img src="https://github.com/trolit/projectZero/blob/storage/photos/howToCompile/howToCompile0.PNG" width="850"/>

Select unzipped directory Project Zero and press 'Choose directory'.
Select unzipped/cloned directory Project Zero and press 'Choose directory'.

<img src="https://github.com/trolit/projectZero/blob/storage/photos/howToCompile/howToCompile1.PNG" height="250"/>

If you have any issues, make sure your Unity Hub launcher has the correct editor selected and the proper version is installed.

The loading status will start. It can take some time. When it's finished you will see Unity with blank scene. If you want to build the project by yourself choose from ```File``` tab ```Build Settings``` option.

<img src="https://github.com/trolit/projectZero/blob/storage/photos/howToCompile/howToCompile2.png" width="900"/>
Expand All @@ -27,10 +33,21 @@ You will see the panel in which you can make decision about project compilation.

<p align="justify">
Make sure that the platform is set to Windows, type x86 and that conversion method is set on LZ4HC. Then press one of the buttons pladced in the bottom edge of the window, Build or Build and Run. In both cases you will be asked to fill directory in which game will be built. After successful built game can be also launched by using ProjectZero executable.

If the option to build is not available, make sure PC, Mac & Linux standalone is selected, and click the switch button to switch versions prior to building.
</p>

<br/>

Reminder<br/>

If you dont want to play with Unity you can download game installer from the documentation page.

## Viewing changes to the codebase

- Utilizing GitHub Desktop and cloning the repo allows changes made in unity to be viewed in the GitHub desktop application.
- All changes made and saved in the project directory will be reflected in GitHub Desktop.
- For a more in depth look into how to use GitHub Desktop, check out <a href="https://www.simplilearn.com/how-to-use-github-desktop-tutorial-article">this link<a>

## Resources
Learn Unity: https://learn.unity.com/
49 changes: 29 additions & 20 deletions README_dev_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,26 +9,33 @@

## Documentation

### Cloning Repository
- Download GitHub Desktop: https://desktop.github.com/
- Fork the repository.
- Open GitHub Desktop and Clone repository.
- View information on compiling the project via <a href="https://github.com/trolit/projectZero/blob/master/COMPILE_en.md">this link<a>
- To make a pull request, changes can be made on a forked repository, or a new branch in the repo.

### Curiosities
- time passed between start and end date(including free days), 162 days(5 months and 9 days), thats 44,38% of the 2019 year,
- source lines of code equals +/- 6000 (value without empty lines),
- Scripts dir contains 101 files,
- 42 music tracks were used, to hear them all you would need 2 hours and 23 minutes,
- the longest thing to do was evironment designing for each minigame level,
- the most tiring work to do for us was projecting minigames with trees (especially for PHP lang),
- adding developer console was the best idea to faster testing times,
- prizes for medals, medals, ProjectZero map overview and additional character were not planned from the start,
- we wanted C# land to be lived by humans but we did not find any interesting asset,
- the most advanced script is NPCHandler,
- most problems were with setting up Pickup script for Puzzle minigame but was edited and now it looks solid,
- thanks to starting project early we managed to finish it in 100%,
- project reached 45 discussions over GitHub, 3 of them were marked as bugs,
- time to ring Project Zero map using the shortest path and fastest character(Slime Rabbit) - 1min 47sec,
- time to ring all paths of Project Zero map with Slime Rabbit character - 4min 30sec,
- project includes 92 graphics, 30 Unity assets,
- HUD inspiraction was from TC: Rainbow Six Siege game,
- playable version contains 52 scenes, project also contains additionat scenes for game cover,
- we wanted to make backpack work like box in which books are stored but due to time limit we took lighter variant and created panel with all books.
- Time passed between start and end date(including free days): 162 days(5 months and 9 days), thats 44,38% of the 2019 year
- Source lines of code equals +/- 6000 (value without empty lines)
- Scripts dir contains 101 files
- 42 music tracks were used, to hear them all you would need 2 hours and 23 minutes
- The longest thing to do was environment designing for each minigame level
- The most tiring work to do for us was projecting minigames with trees (especially for PHP lang)
- Adding developer console was the best idea to faster testing times
- Prizes for medals, ProjectZero map overview and additional character were not planned from the start
- We wanted C# land to be lived by humans, but we did not find any interesting asset
- The most advanced script is NPCHandler
- Most problems were with setting up Pickup script for Puzzle minigame but was edited and now it looks solid
- Thanks to starting the project early, we managed to finish it
- Project reached 45 discussions over GitHub, 3 of them were marked as bugs
- Time to ring Project Zero map using the shortest path and fastest character(Slime Rabbit) - 1min 47sec
- Time to ring all paths of Project Zero map with Slime Rabbit character - 4min 30sec
- Project includes 92 graphics, 30 Unity assets
- HUD inspiraction was from TC: Rainbow Six Siege game
- Playable version contains 52 scenes, project also contains additionat scenes for game cover
- We wanted to make backpack work like box in which books are stored but due to time limit, we took lighter variant and created panel with all books.

### Mechanic
<p align="justify">
Expand Down Expand Up @@ -124,7 +131,7 @@ In maze minigame player must collect proper code fragments and evade bugs. Colle
| HTML | magenta | magenta | ![#ff00ff](https://placehold.it/25/ff00ff/000000?text=+) |
| PHP | orange | orange | ![#FFA500](https://placehold.it/25/FFA500/000000?text=+) |

### Keylogic
### Controls
Keys might differ depending on minigame that is played or current location <br/>
W - forward <br/>
A - left <br/>
Expand All @@ -141,6 +148,8 @@ In CREDITS_en.md file you will find references to the elements that were used in
### Editor configuration
**Warning!** To get correct view of 'Game' window in Unity, create profile with 1920x1080 resolution. Set it and then change Scale parameter to minimum assignable value.

If using Unity Hub, the <a href="https://unity.com/releases/editor/archive">Unity download archive<a> has a direct link for installing the Unity version.

### Unity tool version
2018.3.12f1

Expand Down