openstranded-map-tool 0.1.0

Convert Stranded II .s2 map files to .osmap (OpenStranded MAP) format
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

# openstranded-map-tool

**Convert Stranded II `.s2` map files to `.osmap` (OpenStranded MAP) format.**

Part of the [OpenStranded](https://github.com/OpenStranded) toolchain.

[Documentation](https://docs.rs/openstranded-map-tool) |
[Crate](https://crates.io/crates/openstranded-map-tool)

## Usage

### CLI

```text
openstranded-map-tool convert <input.s2> [output.osmap]
openstranded-map-tool info <input.s2|.osmap>
```

#### Examples

```sh
# Convert a map
openstranded-map-tool convert map.s2 map.osmap

# Auto-output name (map.osmap)
openstranded-map-tool convert map.s2

# Inspect a .s2 or .osmap file
openstranded-map-tool info map.osmap
openstranded-map-tool info map.s2
```

### Library

```toml
[dependencies]
openstranded-map-tool = "0.1"
```

```rust
use openstranded_map_tool::{parse_s2_file, s2_to_osmap, save_osmap_ron};

let s2 = parse_s2_file("map.s2").unwrap();
let osmap = s2_to_osmap(s2, "map.s2");
save_osmap_ron(&osmap, "map.osmap").unwrap();
```

## Format

`.osmap` is a human-readable RON format. See [`docs/osmap-format.md`](../docs/osmap-format.md)
for the full specification.

## License

GPL-3.0-or-later