Getting Started with MVF v1

Mappedin Venue Format (MVF) is a GeoJSON based data format that represents a venue, so that it can be used programmatically. MVF contains geometry and location data associated with a venue, as seen in the Mappedin CMS.

Mappedin’s highly accurate indoor map data can be exported as GeoJSON files for a variety of use cases. These GeoJSON based exports provide complete flexibility to build any indoor mapping experience.

Exporting MVF file

You can export the venue's map from Mappedin CMS. This export includes nodes and paths as well, allowing you to easily build wayfinding capabilities.

This format can be used to build 2D mapping experiences or converted with a variety of 3D renderers, including Mappedin's.

Coding with AI

Mappedin provides an llms-mvfv1.txt file that can be used to help with coding when using Large Language Models (LLMs).

Expand for instructions on how to use Mappedin provided llms.txt files with Cursor, Github Copilot, JetBrains AI Assistant and Windsurf.

How to use llms.txt files with LLMs:

Cursor

To use the llms.txt file with Cursor:

1. Download the llms.txt file for this guide.
2. Create a .cursor directory in your project root if it doesn't exist already.
3. Place the llms.txt file in the .cursor directory.
4. Start creating a new Cursor rule using Cursor's instructions.
5. Set the rule type to: Agent Requested.
6. Set the agent description to: Use this rule whenever a question is asked about Mappedin, Mappedin-JS, Mappedin SDK..
7. In the rule body, add the name of the llms.txt file such as: @llms.txt or @llms-mappedin-js.txt
8. Optionally, if using Mappedin JS add : @index.d.ts, referring to the index.d.ts file located in the node_modules/@mappedin/mappedin-js/lib/esm/ directory to add all Mappedin types to the rule.
9. With this configuration, Cursor will automatically use the llms.txt whenever a question is asked about Mappedin, Mappedin-JS or Mappedin SDKs. When starting a new chat be sure to mention Mappedin to trigger the rule.
10. The llms.txt file includes:
    • Detailed explanations of concepts
    • Code examples and their context
    • Related documentation references
    • Source file locations for verification

This helps ensure that Cursor provides assistance that is consistent with Mappedin documentation and best practices, using the same structured information that's available on the Mappedin Developer Portal.

Github Copilot

To use the llms.txt file with GitHub Copilot Chat in VS Code:

1. Download the llms.txt file for this guide.
2. Create a .copilot directory in your project root if it doesn't exist already.
3. Place the llms.txt file in the .copilot directory.
4. When using Copilot Chat, you can reference the file by saying "Please use the context from the llms.txt file in the .copilot directory".
5. The llms.txt file includes:
   • Detailed explanations of concepts
   • Code examples and their context
   • Related documentation references
   • Source file locations for verification

This helps ensure that Copilot provides assistance that is consistent with documentation and best practices, using the same structured information that's available on the Mappedin Developer Portal.

JetBrains AI Assistant

To use the llms.txt file with JetBrains AI Assistant:

1. Download the llms.txt file for this guide.
2. Create a .idea/ai directory in your project root if it doesn't exist already.
3. Place the llms.txt file in the .idea/ai directory.
4. When using the AI Assistant, you can reference the file by saying "Please use the context from the llms.txt file in the .idea/ai directory".
5. The llms.txt file includes:
   • Detailed explanations of concepts
   • Code examples and their context
   • Related documentation references
   • Source file locations for verification

This helps ensure that the AI Assistant provides assistance that is consistent with documentation and best practices, using the same structured information that's available on the Mappedin Developer Portal.

Windsurf

To use the llms.txt file with Windsurf in VS Code:

1. Download the llms.txt file for this guide.
2. Create a .windsurf directory in your project root if it doesn't exist already.
3. Place the llms.txt file in the .windsurf directory.
4. When using Windsurf Chat, you can reference the file by saying "Please use the context from the llms.txt file in the .windsurf directory".
5. The llms.txt file includes:
   • Detailed explanations of concepts
   • Code examples and their context
   • Related documentation references
   • Source file locations for verification

This helps ensure that Windsurf provides assistance that is consistent with documentation and best practices, using the same structured information that's available on the Mappedin Developer Portal.

Sample MVF

Here's how an MVF export looks for one of the indoor venues:

{
    "type": "FeatureCollection",
    "features": [
        {
            "type": "Feature",
            "geometry": {
                "type": "Polygon",
                "coordinates": [
                    [
                        [-80.5315920413582, 43.52407304453391],
                        [-80.53157331246412, 43.524069388237464]
                    ]
                ]
            },
            "properties": {
                "id": "5a8c81503e7e180413000000",
                "venue": "58347b71031d9c158b000001",
                "name": "Default"
            }
        }
    ]
}

To play more and explore other venues' MVF exports, download a sample package: MVF Demo Files.