Skip to content

Commit

Permalink
summary full
Browse files Browse the repository at this point in the history
  • Loading branch information
TomRuisseau committed Jul 17, 2024
1 parent 061fe5e commit 6574786
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 17 deletions.
11 changes: 3 additions & 8 deletions src/Doc/Steps/db.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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.
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.
1 change: 1 addition & 0 deletions src/Doc/roadmap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Roadmap
1 change: 1 addition & 0 deletions src/Doc/testing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Testing
6 changes: 3 additions & 3 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Summary

[Introduction](./intro.md)
[User guide](./intro.md)

# Technical documentation

Expand All @@ -12,6 +12,6 @@
- [Props placement](./Doc/./Steps/props.md)
- [Data recovery](./Doc/./Steps/db.md)

# Testing
- [Testing](./Testing/testing.md)

# Roadmap
- [Roadmap](./Roadmap/roadmap.md)
6 changes: 0 additions & 6 deletions src/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit 6574786

Please sign in to comment.