> For the complete documentation index, see [llms.txt](https://oasis-web4.gitbook.io/oasis-web4-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://oasis-web4.gitbook.io/oasis-web4-docs/oasis-architecture/nextgensoftware.oasis.api.contracts.md).

# OASIS API Contracts

## Overview

The OASIS API Contracts project contains shared interfaces, enums, and contracts that can be referenced by both OASIS.API.Core and Unity projects. This ensures a single source of truth for all OASIS contracts.

## Features

* **Unity Compatible**: Built with .NET Standard 2.1 for Unity compatibility
* **Single Source of Truth**: All interfaces defined once and shared
* **Clean Architecture**: Separates contracts from implementation
* **Cross-Platform**: Can be referenced by .NET 8/9 and Unity projects

## Contents

* **IOASISMapProvider**: Map provider interface for OASIS ecosystem
* **Future Interfaces**: Will contain all OASIS interfaces and enums
* **Shared Contracts**: Common data structures and enums

## Usage

```csharp
// Reference this project from OASIS.API.Core
using NextGenSoftware.OASIS.API.Contracts.Interfaces;

// Reference this project from Unity
using NextGenSoftware.OASIS.API.Contracts.Interfaces;

// Reference this project from Providers
using NextGenSoftware.OASIS.API.Contracts.Interfaces;
```

## Architecture Benefits

* ✅ **Single Source of Truth** for all interfaces
* ✅ **Unity Compatibility** without .NET version conflicts
* ✅ **Clean Separation** of contracts from implementation
* ✅ **Easy Maintenance** - update interface once, affects all projects
* ✅ **SOLID Principles** maintained

## Future Plans

This project will eventually contain:

* All OASIS interfaces (IHolon, IAvatar, etc.)
* All OASIS enums (MapProviderType, etc.)
* All OASIS contracts and data structures
* Shared utility classes

## License

MIT License - See LICENSE file for details


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://oasis-web4.gitbook.io/oasis-web4-docs/oasis-architecture/nextgensoftware.oasis.api.contracts.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.