Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
PolinaSavelyeva committed Jan 5, 2024
1 parent 9c163eb commit 380f724
Show file tree
Hide file tree
Showing 5 changed files with 4 additions and 159 deletions.
77 changes: 0 additions & 77 deletions docs/content/navbar-fixed-left.css

This file was deleted.

78 changes: 0 additions & 78 deletions docs/content/navbar-fixed-right.css

This file was deleted.

2 changes: 1 addition & 1 deletion docsSrc/Explanations/Structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ Encapsulates a room using its width, height, floor number as seed for random gen

Take a look at the UML class diagram:

![image](https://github.com/raw/PolinaSavelyeva/RoomInteriorGenerator/docsSrc/resources/uml.png)
![image](https://github.com/raw/PolinaSavelyeva/RoomInteriorGenerator/main/docsSrc/resources/uml.png)
2 changes: 1 addition & 1 deletion docsSrc/How_Tos/Making_A_Code.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,6 @@ room.GenerateInterior maximumAmountOfObjects placementFunction

After the visualising of the array, we have the following result, where tables are green and blue, chairs are black, white and orange and couches are red:

![Plot](https://github.com/PolinaSavelyeva/RoomInteriorGenerator/blob/sample/Samples/withoutcorners.png)
![Plot](https://raw.githubusercontent.com/PolinaSavelyeva/RoomInteriorGenerator/sample/Samples/withoutcorners.png)


4 changes: 2 additions & 2 deletions docsSrc/Tutorials/Getting_Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Download package via [NuGet](https://www.nuget.org/packages/RoomInteriorGenerato

First, add the RoomInteriorGenerator package to your Unity project when you can open it in your desired script. I fill the data table in the inspector and add the current script to the new GameObject. GameObject should be in the top left corner of your room. GameObject will be the coordinate origin for all furniture placement, so make sure you set the x and z axis directions correctly. Also, all the prefabs you want to place should have (0,0,0) position and 0 degrees y-rotation (depending on your GameObject directions this may be different). Be sure to check the object's pivot point, usually it should be in the centre of your object. This will help you to get the most expected result.

![Inspector](https://github.com/PolinaSavelyeva/RoomInteriorGenerator/blob/sample/Samples/Inspector.png)
![Inspector](https://raw.githubusercontent.com/PolinaSavelyeva/RoomInteriorGenerator/sample/Samples/Inspector.png)

The main body of my script looks like this:

Expand All @@ -51,7 +51,7 @@ private void Start()

The final result:

![Room](https://github.com/PolinaSavelyeva/RoomInteriorGenerator/blob/sample/Samples/Room.png)
![Room](https://raw.githubusercontent.com/PolinaSavelyeva/RoomInteriorGenerator/sample/Samples/Room.png)

Take a look at the [Time-Reactor-Game](https://github.com/RuslanBeresnev/Time-Reactor-Game) to see all the steps of package implementation.

0 comments on commit 380f724

Please sign in to comment.