## Files
HV creates three types of files, all of which are relatively simple:
- .hv is the regular map file;
```
-------------------------------
| Header (4 usize)            |
| brushes amount              |
| things amount               |
| animations amount           |
| props amount                |
-------------------------------
| Brushes default properties  |
-------------------------------
| Things default properties   |
-------------------------------
| Animations                  |
-------------------------------
| Brushes                     |
-------------------------------
| Things                      |
-------------------------------
| Props                       |
-------------------------------
| Grid settings (skew, angle) |
-------------------------------
```
- .anms is the "animations only" file, which can be used to exchange animations between maps;
```
-------------------------------
| animations amount (usize)   |
-------------------------------
| Animations                  |
-------------------------------
```
- .prps is the "props only" file, which can be used to exchange props between maps.
```
-------------------------------
| props amount (usize)        |
-------------------------------
| Props                       |
-------------------------------
```

## Getting started
HV can be compiled as a standalone executable simply compiling the source code (Linux distributions may require the installation of extra libraries).
```sh
cargo run
```

Otherwise it can be integrated in your own project as such:
```rust
fn main()
{
    bevy::prelude::App::new()
        .add_plugins(hill_vacuum::HillVacuumPlugin)
        .run();
}
```

Map files can be read through the Exporter struct that will return lists of all the brushes and things, which can then be exported as desired.
Assuming the path of the map file was passed as an argument to the exporting executable the code will look something like this:
```rust
fn main()
{
    let exporter = hill_vacuum::Exporter::new(&std::env::args().collect::<Vec<_>>()[0]);
    // Your code.
}
```
The map being edited can be exported through such an executable through the File->Export command in the editor.
The executable can be picked through Options->Exporter.

## Features
- `debug`: enables dynamic linking for faster compile times and some debug lines of the editor;
- `arena_alloc`: enables the usage of an arena allocator for fast allocation times. Requires nightly compiler.

## !! WARNING
[The only thing I know for real](https://youtu.be/T928kJvqTlo?si=2_YnB2pEuFSKKq-j), there will be bugs.  
HV has been thoroughly tested but is still in its early releases, so there might be issues that lead to crashes due to unrecoverable errors. It is strongly recommended to save often.

## Known issues
On Windows, the things and props gallery of the Thing and Paint tools are incorretly drawn. This does not occur on Linux.

## Misc
In order to close the in-editor windows through the keyboard the F4 key needs to be pressed (similar to pressing Alt+F4 to close OS windows).