diff --git a/src/Doc/Steps/db.md b/src/Doc/Steps/db.md index a1b1b38..9f83db3 100644 --- a/src/Doc/Steps/db.md +++ b/src/Doc/Steps/db.md @@ -139,16 +139,10 @@ The visibility ratio is the ratio of the visibility bounding box area over the f ## Save data -The screenshot is then saved, along with a matching JSON file containing the collected data about openings, the seed and the camera information. The JSON file is structured as follows: +The screenshot is then saved, along with a matching JSON file containing the collected data about each visible openings and the camera information. The JSON file is structured as follows: ```json { - "SeedsData": { - "DatabaseSeed": 522732214, - "RoomsSeed": -320021519, - "OpeningsSeed": 723920686, - "ObjectsSeed": 1119647337 - }, "CameraData": { "FieldOfView": 52.2338448, "NearClipPlane": 0.3, @@ -210,4 +204,5 @@ The screenshot is then saved, along with a matching JSON file containing the col } ``` -A JSON is also created for each room, containing the seeds, the room's dimensions, the generation's time and the placement data. \ No newline at end of file +A JSON is also created for each room, containing the seeds, the room's dimensions, the generation's time and the placement data. +The seeds can be used to reproduce random generation. \ No newline at end of file diff --git a/src/Doc/roadmap.md b/src/Doc/roadmap.md new file mode 100644 index 0000000..437766d --- /dev/null +++ b/src/Doc/roadmap.md @@ -0,0 +1 @@ +# Roadmap diff --git a/src/Doc/testing.md b/src/Doc/testing.md new file mode 100644 index 0000000..94cfd7d --- /dev/null +++ b/src/Doc/testing.md @@ -0,0 +1 @@ +# Testing \ No newline at end of file diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 6767838..8a2b182 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -1,6 +1,6 @@ # Summary -[Introduction](./intro.md) +[User guide](./intro.md) # Technical documentation @@ -12,6 +12,6 @@ - [Props placement](./Doc/./Steps/props.md) - [Data recovery](./Doc/./Steps/db.md) -# Testing +- [Testing](./Testing/testing.md) -# Roadmap \ No newline at end of file +- [Roadmap](./Roadmap/roadmap.md) \ No newline at end of file diff --git a/src/intro.md b/src/intro.md index 2352ce5..a95513d 100644 --- a/src/intro.md +++ b/src/intro.md @@ -47,12 +47,6 @@ When applying new settings, a preset file is created and can then be selected to Each screenshot is matched with a Json containing info about the room, the seeds, the camera settings and about each opening in the image, namely doors and windows. Here is an example : ```js { - "SeedsData": { - "DatabaseSeed": 522732214, - "RoomsSeed": -320021519, - "OpeningsSeed": 723920686, - "ObjectsSeed": 1119647337 - }, "CameraData": { "FieldOfView": 52.2338448, "NearClipPlane": 0.3,