Skip to content

Commit fe3785f

Browse files
Clean up doc homepage
1 parent bb043d6 commit fe3785f

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

Sources/MCMap/MCMap.docc/MCMap.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# ``MCMap``
2+
3+
Read and store information about a Minecraft world and player-generated
4+
content.
5+
6+
## Overview
7+
8+
The **Minecraft map package (.mcmap)** is a file package format designed
9+
to store basic information about a Minecraft world and player-created
10+
content.
11+
12+
This Swift package provides the interfaces for interacting with the
13+
package format, allowing developers to read from and write to the format
14+
easily in their apps. It is primary designed to be compatible with SwiftUI
15+
based applications, and it is one of the tenet packages that makes the
16+
Alidade app possible.
17+
18+
> Important:
19+
> The file format is undergoing a refactor, and it currently uses the
20+
> experimental v2 of the format. The format may change over time and is
21+
> not representative of the final version of the v2 format.
22+
23+
## Topics
24+
25+
### Manifest Versions
26+
27+
- ``MCMapManifest``
28+
- ``MCMapManifest_PreVersioning``
29+
- ``MCMapManifest_v1``
30+
- ``MCMapManifest_v2``
31+
32+
### Migration and Versioning
33+
34+
- ``CartographyMapVersionSpec``
35+
36+
### Service Integrations
37+
38+
- ``MCMapIntegration``
39+
- ``MCMapBluemapIntegration``

0 commit comments

Comments
 (0)