# Logs

This directory contains example logs generated by the custom path-planning environment.

The environment can produce logs that store:

- generated world configuration
- start and goal positions
- asset/obstacle information
- drone position traces during training, evaluation, or rendering

These logs are useful for inspecting environment behavior, reloading saved environments, and rendering previously generated paths.

## Example Logs

The example logs included in this repository are curated outputs used to demonstrate the environment logging format.

Typical files include:

| File Type | Description |
|---|---|
| `example_env_log_*.txt` | Stores environment configuration, including world size, start position, goal position, and asset data |
| `example_position_log_*.txt` | Stores drone position traces recorded during an episode or mission run |

## Runtime Logs

When the project is run locally, new logs may be generated in this directory.

Generated runtime logs are usually not intended to be committed unless they are selected as examples for documentation or demonstration purposes.

## Relationship to Rendering

Path rendering depends on position logs. When rendering is enabled, the environment writes the drone's path to a position log and then uses that log to display the path in the simulated 3D environment.

For rendering, use an environment verbosity level of `2`.