Intersect

https://docs.freemmorpgmaker.com/
Admin
Intersect is a free and modern 2D MMORPG Maker designed to revive classic online role-playing game...
Tokens:30,321
Snippets:134
Trust Score:8.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Enable Freemmorpgmaker API (JSON)

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/introduction/setup

Modify the API configuration to enable API access. This involves setting the 'Api.Enabled' field to true in the 'server/appsettings.Production.json' file. The 'Hosts' field can also be optionally modified to specify network ports.

```json
{
  "Api": {
    "Enabled": true,
    "Hosts": ["http://localhost:5000", "https://localhost:5001"]
  }
}
```

--------------------------------

### Grant API Access (Command Line)

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/introduction/setup

Grant API access to a game account using the server console. The 'api [name] true' command is used to allow a specific user account to authenticate with the API.

```bash
api [name] true
```

--------------------------------

### Example CORS Configuration

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/introduction/configuration/cors

This is an example of a complete CORS configuration for a specific website, 'myintersectgame.com'. It specifies the allowed origin, headers, and methods for cross-origin resource sharing. Note that this configuration is illustrative and may not be exhaustive for all use cases.

```json
{
  "Origin": "myintersectgame.com",
  "Headers": [
    "Accepts",
    "Authorization",
    "Content-Length"
    "Content-Type"
  ],
  "Methods": [
    "*"
  ]
}
```

--------------------------------

### Example Migration Command in PowerShell

Source: https://docs.freemmorpgmaker.com/en-US/developer/advanced/database

An example of the `Add-Migration` command used in the Entity Framework Core Package Manager Console to create a migration for adding a 'LastUsedIp' field to the 'Users' table within the 'PlayerContext'.

```powershell
Add-Migration -Context PlayerContext AddingLastUsedIpToUsers
```

--------------------------------

### 200 OK Response for /api/v1/users - Example Body

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/users

This snippet provides an example of a successful (200 OK) response body for the POST /api/v1/users endpoint. It includes total user count, pagination details, and a list of user entries, each with their details and power settings.

```json
{
	"total": 162,
	"Page": 32,
	"count": 2,
	"entries": [
		{
			"Id": "f71a2f48-ce7b-4420-ae37-8802b8c4fb60",
			"Name": "tester",
			"Email": "testr@testr.com",
			"Power": {
				"Editor": false,
				"Ban": false,
				"Kick": false,
				"Mute": false,
				"Api": false,
				"PersonalInformation": false
			},
			"PasswordResetCode": null,
			"IsMuted": false,
			"MuteReason": null
		},
		{
			"Id": "fb19a81b-000f-4679-b30d-778dc8895594",
			"Name": "jcsnider",
			"Email": "test@test.com",
			"Power": {
				"Editor": false,
				"Ban": false,
				"Kick": false,
				"Mute": false,
				"Api": false,
				"PersonalInformation": false
			},
			"PasswordResetCode": null,
			"IsMuted": false,
			"MuteReason": null
		}
	]
}
```

--------------------------------

### POST /api/v1/users - Example Request Body

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/users

This snippet shows an example JSON request body for the POST /api/v1/users endpoint. It demonstrates how to specify the page and count of users to retrieve. This endpoint requires authentication.

```json
{
	"page": 32,
	"count": 5
}
```

--------------------------------

### Register User API Request Body Example

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/users

Example JSON body for registering a new user. Requires username, password (SHA256 hash), and email address. The password must be a SHA256 hash with hyphens removed.

```JSON
{
	"username": "jcsnider",
	"password": "5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8",
	"email": "jcsnider@ascensiongamedev.com"
}
```

--------------------------------

### GET /api/v1/players/[lookupKey]/items

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/players

Retrieves all inventory and bank items for a given player.

```APIDOC
## GET /api/v1/players/[lookupKey]/items

### Description
Retrieves inventory and bank items for a player.

### Method
GET

### Endpoint
`/api/v1/players/[lookupKey]/items`

### Parameters
#### Path Parameters
- **lookupKey** (string) - Required - Character's name or id.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **inventory** (array) - An array of item objects in the player's inventory.
  - **Slot** (integer) - The inventory slot number.
  - **BagId** (string or null) - The ID of the bag if the item is in a bag.
  - **ItemId** (string) - The ID of the item.
  - **Quantity** (integer) - The number of items in the slot.
  - **StatBuffs** (array) - An array of stat buffs applied to the item.
- **bank** (array) - An array of item objects in the player's bank.
  - **Slot** (integer) - The bank slot number.
  - **BagId** (string or null) - The ID of the bag if the item is in a bag.
  - **ItemId** (string) - The ID of the item.
  - **Quantity** (integer) - The number of items in the slot.
  - **StatBuffs** (array) - An array of stat buffs applied to the item.

#### Response Example
```json
{
	"inventory": [
		{
			"Slot": 22,
			"BagId": null,
			"ItemId": "1b19803a-6c28-484f-95fe-9c99f967d73f",
			"Quantity": 1,
			"StatBuffs": [0, 0, 0, 0, 0]
		}
	],
	"bank": [
		{
			"Slot": 87,
			"BagId": null,
			"ItemId": "00000000-0000-0000-0000-000000000000",
			"Quantity": 0,
			"StatBuffs": [0, 0, 0, 0, 0]
		}
	]
}
```
```

--------------------------------

### Lookup User API Response Example

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/users

Example JSON response when looking up a specific user by their username or ID. This details the user's ID, name, email, power, and status.

```JSON
{
	"Id": "fb19a81b-000f-4679-b30d-778dc8895594",
	"Name": "jcsnider",
	"Email": "test@test.com",
	"Power": {
		"Editor": false,
		"Ban": false,
		"Kick": false,
		"Mute": false,
		"Api": false,
		"PersonalInformation": false
	},
	"PasswordResetCode": null,
	"IsMuted": false,
	"MuteReason": null
}
```

--------------------------------

### Send Global Chat Message (JSON Example)

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/chat

Example JSON payload for sending a global chat message to all logged-in players. Includes message content, color, and an optional target.

```JSON
{
	"Message": "Hello World!",
	"Color": {
		"A": 255,
		"R": 255,
		"G": 255,
		"B": 255
	},
	"Target": ""
}
```

--------------------------------

### GET /api/v1/info/config

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/server-info

Retrieves the active server configuration.

```APIDOC
## GET /api/v1/info/config

### Description
Retrieves the active server configuration.

### Method
GET

### Endpoint
/api/v1/info/config

### Parameters
#### Path Parameters
NA

#### Query Parameters
NA

#### Request Body
Empty

### Request Example
NA

### Response
#### Success Response (200)
- **GameName** (string) - The name of the game.
- **ServerPort** (integer) - The port number the game server is running on.
- **AdminOnly** (boolean) - Whether the server is admin-only.
- **UPnP** (boolean) - Whether UPnP is enabled.
- **OpenPortChecker** (boolean) - Whether the open port checker is enabled.
- ... (other configuration fields may be present)

#### Response Example
```json
{
	"GameName": "Intersect",
	"ServerPort": 5400,
	"AdminOnly": false,
	"UPnP": true,
	"OpenPortChecker": true,
	...
}
```
```

--------------------------------

### GET /api/v1/gameobjects/time

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/game-objects

Retrieves the server's timing configuration and color hues for each time of day. Authorization is required.

```APIDOC
## GET /api/v1/gameobjects/time

### Description
Retrieves the servers timing configuration and color hues for each time of day.

### Method
GET

### Endpoint
`/api/v1/gameobjects/time`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
NA

### Request Example
NA

### Response
#### Success Response (200 OK)
- The response contains timing configuration and color hue data. The exact structure is not detailed in the provided text, but it's expected to contain information related to time of day and associated visual properties.

#### Response Example
*(Example not provided in the source text)*
```

--------------------------------

### Unban User Account Response

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/admin-actions

Example response for a successful user unban operation. Indicates the user has been unbanned.

```json
{
	"Message": "jcsnider has been unbanned!"
}
```

--------------------------------

### Unmute User Account Response

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/admin-actions

Example response for a successful user unmute operation. Indicates the user has been unmuted.

```json
{
	"Message": "jcsnider has been unmuted!"
}
```

--------------------------------

### GET /api/v1/players/[lookupKey]/items/inventory

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/players

Retrieves only the inventory items for a given player.

```APIDOC
## GET /api/v1/players/[lookupKey]/items/inventory

### Description
Retrieves inventory items for a player.

### Method
GET

### Endpoint
`/api/v1/players/[lookupKey]/items/inventory`

### Parameters
#### Path Parameters
- **lookupKey** (string) - Required - Character's name or id.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **inventory** (array) - An array of item objects in the player's inventory.
  - **Slot** (integer) - The inventory slot number.
  - **BagId** (string or null) - The ID of the bag if the item is in a bag.
  - **ItemId** (string) - The ID of the item.
  - **Quantity** (integer) - The number of items in the slot.
  - **StatBuffs** (array) - An array of stat buffs applied to the item.

#### Response Example
```json
[
	{
		"Slot": 22,
		"BagId": null,
		"ItemId": "1b19803a-6c28-484f-95fe-9c99f967d73f",
		"Quantity": 1,
		"StatBuffs": [0, 0, 0, 0, 0]
	}
]
```
```

--------------------------------

### GET /api/v1/info

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/server-info

Retrieves the game name and port number from your server.

```APIDOC
## GET /api/v1/info

### Description
Retrieves the game name and port number from your server.

### Method
GET

### Endpoint
/api/v1/info

### Parameters
#### Path Parameters
NA

#### Query Parameters
NA

#### Request Body
Empty

### Request Example
NA

### Response
#### Success Response (200)
- **name** (string) - The name of the game.
- **port** (integer) - The port number the game server is running on.

#### Response Example
```json
{
	"name": "Intersect",
	"port": 5400
}
```
```

--------------------------------

### GET /api/v1/players/[lookupKey]/items/bank

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/players

Retrieves only the bank items for a given player.

```APIDOC
## GET /api/v1/players/[lookupKey]/items/bank

### Description
Retrieves bank items for a player.

### Method
GET

### Endpoint
`/api/v1/players/[lookupKey]/items/bank`

### Parameters
#### Path Parameters
- **lookupKey** (string) - Required - Character's name or id.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **bank** (array) - An array of item objects in the player's bank.
  - **Slot** (integer) - The bank slot number.
  - **BagId** (string or null) - The ID of the bag if the item is in a bag.
  - **ItemId** (string) - The ID of the item.
  - **Quantity** (integer) - The number of items in the slot.
  - **StatBuffs** (array) - An array of stat buffs applied to the item.

#### Response Example
```json
[
	{
		"Slot": 87,
		"BagId": null,
		"ItemId": "00000000-0000-0000-0000-000000000000",
		"Quantity": 0,
		"StatBuffs": [0, 0, 0, 0, 0]
	}
]
```
```

--------------------------------

### GET /api/v1/players/bag/[bagId]

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/players

Retrieves all items stored within a specific bag.

```APIDOC
## GET /api/v1/players/bag/[bagId]

### Description
Retrieves stored items and metadata of a bag.

### Method
GET

### Endpoint
`/api/v1/players/bag/[bagId]`

### Parameters
#### Path Parameters
- **bagId** (string) - Required - The ID of the bag to retrieve.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **Id** (string) - The ID of the bag.
- **SlotCount** (integer) - The total number of slots in the bag.
- **Slots** (array) - An array of item objects within the bag's slots.
  - **Slot** (integer) - The slot number within the bag.
  - **BagId** (string or null) - The ID of the bag if the item is in a sub-bag.
  - **ItemId** (string) - The ID of the item.
  - **Quantity** (integer) - The number of items in the slot.
  - **StatBuffs** (array) - An array of stat buffs applied to the item.

#### Response Example
```json
{
	"Id": "08d649a8-643f-1bde-0487-3175a8badde2",
	"SlotCount": 3,
	"Slots": [
		{
			"Slot": 0,
			"BagId": null,
			"ItemId": "be82ae1a-0c50-40c8-a929-7d55335467fc",
			"Quantity": 10,
			"StatBuffs": [0, 0, 0, 0, 0]
		}
	]
}
```
```

--------------------------------

### Get Player Variables

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/players

Retrieves the variables and their corresponding values for a specific character. Requires authentication.

```APIDOC
## Get Variables

### Description
Retrieves player variables and values for a character.

### Method
GET

### Endpoint
/api/v1/players/[lookupKey]/variables

### Parameters
#### Path Parameters
- **lookupKey** (string) - Required - Character's name or id.

### Response
#### Success Response (200)
- (Object) - An object containing key-value pairs of player variables and their values.

#### Response Example
```json
{
    "variableName1": "value1",
    "variableName2": 123,
    "variableName3": true
}
```
```

--------------------------------

### JSON Example: Daylight Hues and Game Settings

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/game-objects

This JSON snippet illustrates color data for 'DaylightHues', including Alpha, Red, Green, and Blue values for each entry. It also contains game-related settings like 'Id', 'RangeInterval', 'Rate', and 'SyncTime'. This format is commonly used for configuration or data exchange in game development.

```json
{
	"DaylightHues": [
		{ "A": 204, "R": 0, "G": 0, "B": 64 },
		{ "A": 204, "R": 0, "G": 0, "B": 64 },
		{ "A": 204, "R": 0, "G": 0, "B": 64 },
		{ "A": 173, "R": 0, "G": 0, "B": 64 },
		{ "A": 163, "R": 0, "G": 0, "B": 160 },
		{ "A": 102, "R": 0, "G": 0, "B": 255 },
		{ "A": 102, "R": 0, "G": 128, "B": 255 },
		{ "A": 84, "R": 255, "G": 0, "B": 255 },
		{ "A": 102, "R": 255, "G": 128, "B": 128 },
		{ "A": 51, "R": 255, "G": 128, "B": 0 },
		{ "A": 255, "R": 255, "G": 255, "B": 255 },
		{ "A": 255, "R": 255, "G": 255, "B": 255 },
		{ "A": 255, "R": 255, "G": 255, "B": 255 },
		{ "A": 255, "R": 255, "G": 255, "B": 255 },
		{ "A": 255, "R": 255, "G": 255, "B": 255 },
		{ "A": 53, "R": 255, "G": 128, "B": 128 },
		{ "A": 122, "R": 255, "G": 128, "B": 255 },
		{ "A": 84, "R": 255, "G": 0, "B": 255 },
		{ "A": 102, "R": 128, "G": 0, "B": 128 },
		{ "A": 122, "R": 64, "G": 0, "B": 128 },
		{ "A": 112, "R": 0, "G": 0, "B": 128 },
		{ "A": 124, "R": 0, "G": 0, "B": 64 },
		{ "A": 153, "R": 0, "G": 0, "B": 64 },
		{ "A": 170, "R": 0, "G": 0, "B": 64 }
	],
	"Id": "75196252-9830-4fe0-aa38-f66bdbce62e2",
	"RangeInterval": 60,
	"Rate": 500,
	"SyncTime": false
}
```

--------------------------------

### Fork Repository with GitHub CLI

Source: https://docs.freemmorpgmaker.com/en-US/developer/repository/forking

This command-line interface (CLI) command allows you to create a fork of a specified repository. It's a quick way to duplicate a repository for experimentation or contribution. Ensure you have the GitHub CLI installed and authenticated.

```bash
gh repo fork repository
```

--------------------------------

### Fetch Server Configuration

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/server-info

Retrieves the current active server configuration, including settings like game name, port, and admin-only mode. This endpoint requires a GET request and authorization.

```json
{
	"GameName": "Intersect",
	"ServerPort": 5400,
	"AdminOnly": false,
	"UPnP": true,
	"OpenPortChecker": true,
	...
}
```

--------------------------------

### Get All Player Items

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/players

Retrieves both inventory and bank items for a player. This endpoint returns a JSON object containing two arrays: 'inventory' and 'bank', each listing the items with their details like Slot, ItemId, and Quantity.

```json
{
	"inventory": [
		{
			"Slot": 22,
			"BagId": null,
			"ItemId": "1b19803a-6c28-484f-95fe-9c99f967d73f",
			"Quantity": 1,
			"StatBuffs": [0, 0, 0, 0, 0]
		},
		{
			"Slot": 15,
			"BagId": "08d649a8-643f-1bde-0487-3175a8badde2",
			"ItemId": "bda7b222-b549-4e95-982f-cc04e680471e",
			"Quantity": 1,
			"StatBuffs": [0, 0, 0, 0, 0]
		}
	],
	"bank": [
		{
			"Slot": 87,
			"BagId": null,
			"ItemId": "00000000-0000-0000-0000-000000000000",
			"Quantity": 0,
			"StatBuffs": [0, 0, 0, 0, 0]
		},
		{
			"Slot": 91,
			"BagId": null,
			"ItemId": "00000000-0000-0000-0000-000000000000",
			"Quantity": 0,
			"StatBuffs": [0, 0, 0, 0, 0]
		}
	]
}
```

--------------------------------

### GET /api/v1/gameobjects/[typeKey]/[id]

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/game-objects

Retrieves the configuration for a singular game object from the server given its type and ID. Authorization is required.

```APIDOC
## GET /api/v1/gameobjects/[typeKey]/[id]

### Description
Retrieves the config for a singular game object from the server given it's type and id.

### Method
GET

### Endpoint
`/api/v1/gameobjects/[typeKey]/[id]`

### Parameters
#### Path Parameters
- **typeKey** (string) - Required - One of the keys in the object types table (e.g., animation, class, item).
- **id** (string) - Required - The unique identifier (Key) of the game object to retrieve.

#### Query Parameters
None

#### Request Body
NA

### Request Example
NA

### Response
#### Success Response (200 OK)
- The response format varies depending on the `typeKey`. See the example for a 'map' type.

#### Response Example (Map)
```json
{
	"Name": "Town Shore",
	"EventIds": [
		"9d89fa82-1aa5-45f6-94ff-9a9d6c4a3b10",
		"08198577-6688-430b-953d-9eabbb754a64",
		"fe5e5d59-899b-4efa-9d0c-c2bb0905dedc",
		"adc098e6-d453-403f-8f57-e76d40705306",
		"a5817278-d482-4101-8102-271a0fe8e405",
		"2fddd530-53ff-4c86-bd81-5a4a3b57226f",
		"6f9db43c-8a51-45df-ba97-8875970ce644"
	],
	"Up": "7c2fea75-7817-486e-bbe0-0b6a82e5a162",
	"Down": "00000000-0000-0000-0000-000000000000",
	"Left": "cd86fce9-d976-4565-9713-807122ed7045",
	"Right": "7fe6c3d6-ef31-4bb0-a669-366085e8b774",
	"Revision": 82,
	"Lights": [],
	"LocalEventsJson": "{}",
	"Spawns": [
		{
			"Direction": 0,
			"NpcId": "3b2ccf0d-e732-4148-b627-7d694180ed3f",
			"X": -1,
			"Y": -1
		}
	],
	"Music": "battle-of-the-ancients.ogg",
	"Sound": "None",
	"IsIndoors": false,
	"Panorama": "None",
	"Fog": "None",
	"FogXSpeed": 0,
	"FogYSpeed": 0,
	"FogTransparency": 0,
	"RHue": 0,
	"GHue": 0,
	"BHue": 0,
	"AHue": 0,
	"Brightness": 100,
	"ZoneType": 1,
	"PlayerLightSize": 300,
	"PlayerLightIntensity": 255,
	"PlayerLightExpand": 0,
	"PlayerLightColor": {
		"A": 255,
		"R": 255,
		"G": 255,
		"B": 255
	},
	"OverlayGraphic": "None",
	"WeatherAnimationId": "00000000-0000-0000-0000-000000000000",
	"WeatherXSpeed": 0,
	"WeatherYSpeed": 0,
	"WeatherIntensity": 0,
	"Id": "693b7c8f-61ac-4517-b27c-f3b0a3b98542",
	"TimeCreated": -8586627254977472901
}
```
```

--------------------------------

### Retrieve Game Name and Port

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/server-info

Fetches the game name and the server's port number. This endpoint uses a GET request and requires authorization.

```json
{
	"name": "Intersect",
	"port": 5400
}
```

--------------------------------

### Get List of Game Objects (POST)

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/game-objects

Retrieves a paginated list of game objects from the server based on their type. Requires authentication and a JSON content type. The body specifies the page number and the count of items per page.

```json
{
	"page": 0,
	"count": 5
}
```

--------------------------------

### Get Map Object Configuration (GET)

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/game-objects

Fetches the detailed configuration for a specific map object using its type and unique ID. This is a GET request and does not require a request body.

```json
{
	"Name": "Town Shore",
	"EventIds": [
		"9d89fa82-1aa5-45f6-94ff-9a9d6c4a3b10",
		"08198577-6688-430b-953d-9eabbb754a64",
		"fe5e5d59-899b-4efa-9d0c-c2bb0905dedc",
		"adc098e6-d453-403f-8f57-e76d40705306",
		"a5817278-d482-4101-8102-271a0fe8e405",
		"2fddd530-53ff-4c86-bd81-5a4a3b57226f",
		"6f9db43c-8a51-45df-ba97-8875970ce644"
	],
	"Up": "7c2fea75-7817-486e-bbe0-0b6a82e5a162",
	"Down": "00000000-0000-0000-0000-000000000000",
	"Left": "cd86fce9-d976-4565-9713-807122ed7045",
	"Right": "7fe6c3d6-ef31-4bb0-a669-366085e8b774",
	"Revision": 82,
	"Lights": [],
	"LocalEventsJson": "{}",
	"Spawns": [
		{
			"Direction": 0,
			"NpcId": "3b2ccf0d-e732-4148-b627-7d694180ed3f",
			"X": -1,
			"Y": -1
		}
	],
	"Music": "battle-of-the-ancients.ogg",
	"Sound": "None",
	"IsIndoors": false,
	"Panorama": "None",
	"Fog": "None",
	"FogXSpeed": 0,
	"FogYSpeed": 0,
	"FogTransparency": 0,
	"RHue": 0,
	"GHue": 0,
	"BHue": 0,
	"AHue": 0,
	"Brightness": 100,
	"ZoneType": 1,
	"PlayerLightSize": 300,
	"PlayerLightIntensity": 255,
	"PlayerLightExpand": 0,
	"PlayerLightColor": {
		"A": 255,
		"R": 255,
		"G": 255,
		"B": 255
	},
	"OverlayGraphic": "None",
	"WeatherAnimationId": "00000000-0000-0000-0000-000000000000",
	"WeatherXSpeed": 0,
	"WeatherYSpeed": 0,
	"WeatherIntensity": 0,
	"Id": "693b7c8f-61ac-4517-b27c-f3b0a3b98542",
	"TimeCreated": -8586627254977472901
}
```

--------------------------------

### Get Specific Variable (API)

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/server-variables

Fetches a single global variable's details using its unique ID. This endpoint requires authentication and is a GET request.

--------------------------------

### POST /api/v1/players/[lookupKey]/items/take

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/players

Takes a specified item and quantity from a player's inventory.

```APIDOC
## POST /api/v1/players/[lookupKey]/items/take

### Description
Takes a specified item and quantity from a player's inventory.

### Method
POST

### Endpoint
`/api/v1/players/[lookupKey]/items/take`

### Parameters
#### Path Parameters
- **lookupKey** (string) - Required - Character's name or id.

#### Query Parameters
None

#### Request Body
- **itemid** (guid) - Required - Id of the item to take.
- **quantity** (int) - Required - Quantity of the item to take.

### Request Example
```json
{
	"itemid": "be82ae1a-0c50-40c8-a929-7d55335467fc",
	"quantity": 5
}
```

### Response
#### Success Response (200 OK)
Item(s) taken successfully, returns the item id and quantity taken.
- **ItemId** (guid) - The ID of the item taken.
- **Quantity** (int) - The quantity of the item taken.

#### Response Example
```json
{
	"ItemId": "be82ae1a-0c50-40c8-a929-7d55335467fc",
	"Quantity": 5
}
```
```

--------------------------------

### Validate Password API Request Body Example

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/users

Example JSON body for validating a user's password. Requires the password to be provided as a SHA256 hash.

```JSON
{
	"password": "5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8"
}
```

--------------------------------

### POST /api/v1/players/[lookupKey]/spells/teach

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/players

Teaches a player a specified spell.

```APIDOC
## POST /api/v1/players/[lookupKey]/spells/teach

### Description
Teaches a player a specified spell.

### Method
POST

### Endpoint
`/api/v1/players/[lookupKey]/spells/teach`

### Parameters
#### Path Parameters
- **lookupKey** (string) - Required - Character's name or id.

#### Query Parameters
None

#### Request Body
- **spellid** (guid) - Required - Id of the spell to teach.

### Request Example
```json
{
	"spellid": "c54378ba-5632-4ad9-a7cf-6ec0b0264b4e"
}
```

### Response
#### Success Response (200 OK)
Spell was taught successfully.
- **SpellId** (guid) - The ID of the spell taught.

#### Response Example
```json
{
	"SpellId": "c54378ba-5632-4ad9-a7cf-6ec0b0264b4e"
}
```
```

--------------------------------

### Player Activity API

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/logging

Retrieves a list of player activities based on a lookup key. Requires authorization.

```APIDOC
## GET /api/v1/logs/player/[lookupKey]/activity

### Description
Retrieves player activity based on the provided lookup key. This endpoint requires authorization.

### Method
GET

### Endpoint
`/api/v1/logs/player/[lookupKey]/activity`

### Parameters
#### Path Parameters
- **lookupKey** (string) - Required - The key used to look up player activity (e.g., Character's id).

### Request Body
Empty

### Response
#### Success Response (200)
- **Total** (integer) - The total number of activities found.
- **Page** (integer) - The current page number.
- **PageSize** (integer) - The number of items per page.
- **Count** (integer) - The number of items on the current page.
- **Values** (array) - An array of player activity objects.
  - **Id** (string) - The unique identifier for the activity.
  - **TimeStamp** (string) - The date and time of the activity.
  - **UserId** (string) - The identifier of the user who performed the action.
  - **PlayerId** (string) - The identifier of the player associated with the activity.
  - **Action** (string) - The type of action performed.
  - **Peer** (string) - The source of the action (e.g., Client).
  - **Ip** (string) - The IP address from which the action was performed.
  - **Meta** (string) - Additional metadata about the activity.
- **Sort** (null) - Sorting information (currently null).
- **Extra** (null) - Extra information (currently null).

#### Response Example
```json
{
  "Total": 9,
  "Page": 0,
  "PageSize": 5,
  "Count": 5,
  "Values": [
    {
      "Id": "709e3acb-1c1e-406f-bd0d-a05d538e96b3",
      "TimeStamp": "2021-04-21T10:20:19.2101157",
      "UserId": "f4c6bead-48dc-4625-95a4-de2693efcf53",
      "PlayerId": "0d27012e-697e-4558-bf0a-794a17ab0e40",
      "Action": "SelectPlayer",
      "Peer": "Client",
      "Ip": "127.0.0.1",
      "Meta": "admin,Admin"
    }
  ],
  "Sort": null,
  "Extra": null
}
```
```

--------------------------------

### Get Server Statistics

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/server-info

Retrieves active server statistics, including the number of online players, uptime, and connections per second. This is accessed via a GET request and requires authorization.

```json
{
	"uptime": 1258852,
	"cps": 92,
	"connectedClients": 0,
	"onlineCount": 0
}
```

--------------------------------

### POST /api/v1/players/[lookupKey]/items/give

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/players

Gives a specified item and quantity to a player. It can optionally attempt to overflow to the bank if the inventory is full.

```APIDOC
## POST /api/v1/players/[lookupKey]/items/give

### Description
Gives a specified item and quantity to a player. It can optionally attempt to overflow to the bank if the inventory is full.

### Method
POST

### Endpoint
`/api/v1/players/[lookupKey]/items/give`

### Parameters
#### Path Parameters
- **lookupKey** (string) - Required - Character's name or id.

#### Query Parameters
None

#### Request Body
- **itemid** (guid) - Required - Id of the item to give.
- **quantity** (int) - Required - Quantity of the item to give.
- **bankoverflow** (boolean) - Optional - Whether or not to try to overflow to bank if the inventory is too full.

### Request Example
```json
{
	"itemid": "be82ae1a-0c50-40c8-a929-7d55335467fc",
	"quantity": 5,
	"bankoverflow": false
}
```

### Response
#### Success Response (200 OK)
Returns player count of the items in both inventory and bank.
- **id** (guid) - The ID of the item.
- **quantity** (object) - An object containing the total, bank, and inventory quantities.
  - **total** (int) - Total quantity of the item across inventory and bank.
  - **bank** (int) - Quantity of the item in the bank.
  - **inventory** (int) - Quantity of the item in the inventory.

#### Response Example
```json
{
	"id": "be82ae1a-0c50-40c8-a929-7d55335467fc",
	"quantity": {
		"total": 311,
		"bank": 5,
		"inventory": 306
	}
}
```
```

--------------------------------

### POST /api/v1/users/register

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/users

Creates a new user account on the server with the provided username, password, and email.

```APIDOC
## POST /api/v1/users/register

### Description
Creates an account on the server for a user given a username, password, and email address.

### Method
POST

### Endpoint
/api/v1/users/register

### Parameters
#### Request Body
- **username** (string) - Required - Username for the new user.
- **password** (string) - Required - Sha256 hash of the new user’s password.
- **email** (string) - Required - Email address for the new user.

### Request Example
```json
{
	"username": "jcsnider",
	"password": "5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8",
	"email": "jcsnider@ascensiongamedev.com"
}
```

### Response
#### Success Response (200)
- **Username** (string) - The registered username.
- **Email** (string) - The registered email address.

#### Response Example
```json
{
	"Username": "jcsnider",
	"Email": "jcsnider@ascensiongamedev.com"
}
```

**Notes**
- Password must be a SHA256 hash of the plaintext password, with hyphens removed.
- You can generate a SHA256 hash of a plaintext password here.
```

--------------------------------

### User Activity API

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/logging

Retrieves a list of user activities based on a lookup key. Requires authorization.

```APIDOC
## GET /api/v1/logs/user/[lookupKey]/activity

### Description
Retrieves user activity based on the provided lookup key. This endpoint requires authorization.

### Method
GET

### Endpoint
`/api/v1/logs/user/[lookupKey]/activity`

### Parameters
#### Path Parameters
- **lookupKey** (string) - Required - The key used to look up user activity (e.g., User's id).

### Request Body
Empty

### Response
#### Success Response (200)
- **Total** (integer) - The total number of activities found.
- **Page** (integer) - The current page number.
- **PageSize** (integer) - The number of items per page.
- **Count** (integer) - The number of items on the current page.
- **Values** (array) - An array of user activity objects.
  - **Id** (string) - The unique identifier for the activity.
  - **TimeStamp** (string) - The date and time of the activity.
  - **UserId** (string) - The identifier of the user performing the action.
  - **PlayerId** (string or null) - The identifier of the player associated with the activity, if any.
  - **Action** (string) - The type of action performed.
  - **Peer** (string) - The source of the action (e.g., Client).
  - **Ip** (string) - The IP address from which the action was performed.
  - **Meta** (string or null) - Additional metadata about the activity.
- **Sort** (null) - Sorting information (currently null).
- **Extra** (null) - Extra information (currently null).

#### Response Example
```json
{
  "Total": 28,
  "Page": 0,
  "PageSize": 5,
  "Count": 5,
  "Values": [
    {
      "Id": "edb6512f-345b-4196-bc84-17587bd0eb2e",
      "TimeStamp": "2021-04-21T10:20:19.06552",
      "UserId": "f4c6bead-48dc-4625-95a4-de2693efcf53",
      "PlayerId": null,
      "Action": "Login",
      "Peer": "Client",
      "Ip": "127.0.0.1",
      "Meta": null
    }
  ],
  "Sort": null,
  "Extra": null
}
```
```

--------------------------------

### Change Email API Request Body Example

Source: https://docs.freemmorpgmaker.com/en-US/api/v1/endpoints/users

Example JSON body for changing a user's email address. Requires the new email and the current password's SHA256 hash for authorization.

```JSON
{
	"new": "test100@test.com",
	"authorization": "5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8"
}
```

--------------------------------

### Password Hashing and Verification in C#

Source: https://docs.freemmorpgmaker.com/en-US/advanced/passwords

This C# code demonstrates how to hash a plaintext password and verify it against a stored salt. It uses SHA256 for hashing and requires the 'System.Security.Cryptography' and 'System.Text' namespaces. The process involves hashing the plaintext password first, then concatenating the salt and hashing the result again.

```csharp
var sha = new SHA256Managed();
string pass = BitConverter.ToString(sha.ComputeHash(Encoding.UTF8.GetBytes("plaintext_password"))).Replace("-", "");
string salt = "AD07665AE12767B2B712752595D0E4C16479B01D07E66AF9F9E6081C811C4C21";  //Salt pulled from the database
string encrypted_pass = BitConverter.ToString(sha.ComputeHash(Encoding.UTF8.GetBytes(pass + salt))).Replace("-", "");
```
Tokens:
Raw