Nexo Maker API

https://www.nexomaker.com/devs/api
Admin
Nexo Maker API enables developers to build powerful expansions for Nexo Maker with comprehensive...
Tokens:5,328
Snippets:59
Trust Score:4.8
Update:8 months ago
Show doc for...
Tokens:
Raw
### Core API - loadFile()

Source: https://www.nexomaker.com/devs/api/index

Loads any file from your expansion directory. This is useful for accessing configuration files, data files, or any other resources your expansion might need.

```APIDOC
## GET /api/core/loadFile

### Description
Loads any file from your expansion directory.

### Method
GET

### Endpoint
/api/core/loadFile

### Parameters
#### Query Parameters
- **filePath** (string) - Required - The path to the file within your expansion directory.

### Response
#### Success Response (200)
- **content** (string) - The content of the file as a string.

#### Response Example
{
  "content": "This is the content of the file."
}
```

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

### Settings API - Reading Settings

Source: https://www.nexomaker.com/devs/api/index

Learn how to access and use settings values in your expansions. This includes both application-wide and project-specific settings.

```APIDOC
## Reading Settings

### Description
Learn how to access and use settings values in your expansions.

### Methods
- **settings.getAppSetting(key)**: Retrieves an application-wide setting.
- **settings.getProjectSetting(key)**: Retrieves a project-specific setting.

### Example Usage
```javascript
const theme = settings.getAppSetting('theme');
console.log('Current theme:', theme);

const projectName = settings.getProjectSetting('projectName');
console.log('Project name:', projectName);
```
```

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

### Creators - item.readAll()

Source: https://www.nexomaker.com/devs/api/index

Loads all items from a project. This provides a comprehensive view of all items within the current project context.

```APIDOC
## item.readAll()

### Description
Load all items from a project.

### Method
GET

### Endpoint
/api/creators/items

### Response
#### Success Response (200)
- **items** (array) - An array of item objects, where each object represents an item in the project.

#### Response Example
{
  "items": [
    {
      "id": "item_1",
      "name": "First Item",
      "type": "basic"
    },
    {
      "id": "item_2",
      "name": "Second Item",
      "type": "advanced"
    }
  ]
}
```

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

### Core API - loadAsset()

Source: https://www.nexomaker.com/devs/api/index

Loads images and assets as Base64 strings for use in your Expansion. This allows you to embed images directly into your expansion's UI or functionality.

```APIDOC
## GET /api/core/loadAsset

### Description
Loads images and assets as Base64 strings for use in your Expansion.

### Method
GET

### Endpoint
/api/core/loadAsset

### Parameters
#### Query Parameters
- **assetPath** (string) - Required - The path to the asset within your expansion directory.

### Response
#### Success Response (200)
- **base64Content** (string) - The asset content encoded as a Base64 string.

#### Response Example
{
  "base64Content": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="
}
```

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

### Core API - Console Logging

Source: https://www.nexomaker.com/devs/api/index

Provides logging utilities for debugging and monitoring inside Nexo Maker. Use these functions to output messages, warnings, and errors to the Nexo Maker console.

```APIDOC
## Console Logging Utilities

### Description
Logging utilities for debugging and monitoring inside Nexo Maker.

### Methods
- **console.log(message)**: Logs a general message.
- **console.warn(message)**: Logs a warning message.
- **console.error(message)**: Logs an error message.

### Example Usage
```javascript
console.log('Expansion started successfully.');
console.warn('Potential issue detected.');
console.error('Failed to load configuration.');
```
```

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

### Core API - YAML Handling

Source: https://www.nexomaker.com/devs/api/index

Read and write YAML files in Nexo Maker projects. This is essential for managing configuration, project data, and other structured information.

```APIDOC
## YAML File Operations

### Description
Read and write YAML files in Nexo Maker projects.

### Methods
- **yaml.readFile(filePath)**: Reads a YAML file and returns its content as a JavaScript object.
- **yaml.writeFile(filePath, data)**: Writes a JavaScript object to a YAML file.

### Example Usage
```javascript
// Reading a YAML file
const config = yaml.readFile('config.yaml');
console.log(config.setting1);

// Writing a YAML file
const newData = { key: 'value', number: 123 };
yaml.writeFile('output.yaml', newData);
```
```

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

### Core API - postSidebarIcon()

Source: https://www.nexomaker.com/devs/api/index

Adds custom sidebar buttons to the Nexo Maker Project UI. This enables users to access your expansion's features directly from the main project interface.

```APIDOC
## POST /api/core/postSidebarIcon

### Description
Adds custom sidebar buttons to the Nexo Maker Project UI.

### Method
POST

### Endpoint
/api/core/postSidebarIcon

### Parameters
#### Request Body
- **iconName** (string) - Required - The name or identifier for the icon.
- **iconPath** (string) - Required - The path to the icon image file within your expansion directory.
- **tooltip** (string) - Optional - Text to display when hovering over the icon.
- **onClickAction** (string) - Optional - JavaScript function to execute when the icon is clicked.

### Request Example
{
  "iconName": "my_custom_icon",
  "iconPath": "/icons/my_icon.png",
  "tooltip": "Open my custom panel",
  "onClickAction": "myExpansion.openPanel()"
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the icon was added.

#### Response Example
{
  "message": "Sidebar icon added successfully."
}
```

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

### Modular.js - useProjectState()

Source: https://www.nexomaker.com/devs/api/index

Manage state that persists within a specific project only. This is useful for project-specific configurations or temporary data.

```APIDOC
## useProjectState Hook

### Description
Manage state that persists within a specific project only.

### Usage
`const [state, setState] = useProjectState(key, initialState);
`

### Parameters
- **key** (string): A unique key to identify the project state.
- **initialState**: The initial value of the project state if it doesn't exist.

### Return Value
- **state**: The current project state value.
- **setState**: A function to update the project state value.

### Example Usage
```javascript
function ProjectSettings() {
  const [autoSave, setAutoSave] = useProjectState('autoSaveEnabled', true);

  return (
    <label>
      <input type="checkbox" checked={autoSave} onChange={e => setAutoSave(e.target.checked)} />
      Enable Auto Save
    </label>
  );
}
```
```

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

### Modular.js - useEffect()

Source: https://www.nexomaker.com/devs/api/index

Run side effects and cleanup code in response to component lifecycle events. Use this for data fetching, subscriptions, or manual DOM manipulations.

```APIDOC
## useEffect Hook

### Description
Run side effects and cleanup code in response to component lifecycle events.

### Usage
`useEffect(() => {
  // Effect code
  return () => {
    // Cleanup code
  };
}, [dependencies]);`

### Parameters
- **effect**: A function containing the side effect logic.
- **dependencies** (optional): An array of values that the effect depends on. If omitted, the effect runs after every render. If an empty array, the effect runs only once after the initial render.

### Example Usage
```javascript
useEffect(() => {
  console.log('Component mounted or updated');
  return () => {
    console.log('Component unmounting or updating');
  };
}, [someValue]);
```
```

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

### Core API - loadModel()

Source: https://www.nexomaker.com/devs/api/index

Loads Minecraft JSON models for use in your Expansion. This enables you to dynamically load and utilize custom 3D models within Nexo Maker.

```APIDOC
## GET /api/core/loadModel

### Description
Loads Minecraft JSON models for use in your Expansion.

### Method
GET

### Endpoint
/api/core/loadModel

### Parameters
#### Query Parameters
- **modelPath** (string) - Required - The path to the Minecraft JSON model file within your expansion directory.

### Response
#### Success Response (200)
- **modelData** (object) - The parsed JSON data of the Minecraft model.

#### Response Example
{
  "modelData": {
    "parent": "block/cube_all",
    "textures": {
      "all": "blocks/my_custom_block"
    }
  }
}
```

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

### Core API - postEditorModule()

Source: https://www.nexomaker.com/devs/api/index

Adds custom fields and functionality to item editors in Nexo Maker. This allows you to extend the default item editing experience with your own custom inputs and logic.

```APIDOC
## POST /api/core/postEditorModule

### Description
Adds custom fields and functionality to item editors in Nexo Maker.

### Method
POST

### Endpoint
/api/core/postEditorModule

### Parameters
#### Request Body
- **moduleName** (string) - Required - The name of the custom editor module.
- **moduleContent** (string) - Required - The HTML or JavaScript content for the custom module.

### Request Example
{
  "moduleName": "custom_field_module",
  "moduleContent": "<input type=\"text\" placeholder=\"Enter value\">
<script>console.log('Custom field loaded');</script>"
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the module was added.

#### Response Example
{
  "message": "Custom editor module added successfully."
}
```

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

### Themes - Icon Replacement API

Source: https://www.nexomaker.com/devs/api/index

Replace or add custom icons in Nexo Maker using expansion APIs. This allows for visual customization of the Nexo Maker interface.

```APIDOC
## Icon Replacement API

### Description
Replace or add custom icons in Nexo Maker using expansion APIs.

### Method
POST (or similar registration mechanism)

### Endpoint
(Specific endpoint for icon registration will vary)

### Parameters
#### Request Body
- **iconId** (string) - Required - The identifier of the icon to replace or add.
- **iconPath** (string) - Required - The path to the new icon image file within your expansion directory.

### Request Example
{
  "iconId": "default_save_icon",
  "iconPath": "/icons/my_custom_save_icon.png"
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "Icon 'default_save_icon' replaced successfully."
}
```

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

### Modular.js - useState()

Source: https://www.nexomaker.com/devs/api/index

Manage component state and trigger re-renders when state changes. This is a fundamental hook for building interactive components in Modular.js.

```APIDOC
## useState Hook

### Description
Manage component state and trigger re-renders when state changes.

### Usage
`const [state, setState] = useState(initialState);`

### Parameters
- **initialState**: The initial value of the state.

### Return Value
- **state**: The current state value.
- **setState**: A function to update the state value and trigger a re-render.

### Example Usage
```javascript
function Counter() {
  const [count, setCount] = useState(0);

  return (
    <div>
      <p>You clicked {count} times</p>
      <button onClick={() => setCount(count + 1)}>
        Click me
      </button>
    </div>
  );
}
```
```

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

### Core API - Custom Element Types

Source: https://www.nexomaker.com/devs/api/index

Register new element types that integrate with Nexo Maker's project browser, routing, and editor system. This allows for custom data structures and their associated UIs.

```APIDOC
## Registering Custom Element Types

### Description
Register new element types that integrate with Nexo Maker's project browser, routing, and editor system.

### Method
POST (or similar registration mechanism)

### Endpoint
(Specific endpoint for registration will vary)

### Parameters
#### Request Body (example structure)
- **elementType** (string) - Required - Unique identifier for the new element type.
- **displayName** (string) - Required - User-friendly name for the element type.
- **icon** (string) - Optional - Path to an icon for the element type.
- **editorComponent** (string) - Optional - Reference to the UI component for editing this element type.

### Request Example
{
  "elementType": "custom_data_object",
  "displayName": "Custom Data",
  "icon": "/icons/data_icon.png",
  "editorComponent": "CustomDataEditor"
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "Custom element type 'custom_data_object' registered successfully."
}
```

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

### Themes - Language Registration API

Source: https://www.nexomaker.com/devs/api/index

Register custom languages to provide translations for Nexo Maker's UI. This enables internationalization and localization for your expansion.

```APIDOC
## Language Registration API

### Description
Register custom languages to provide translations for Nexo Maker's UI.

### Method
POST (or similar registration mechanism)

### Endpoint
(Specific endpoint for language registration will vary)

### Parameters
#### Request Body
- **languageCode** (string) - Required - The ISO language code (e.g., 'en', 'fr', 'es').
- **translations** (object) - Required - An object containing key-value pairs of translations.

### Request Example
{
  "languageCode": "fr",
  "translations": {
    "saveButton": "Enregistrer",
    "cancelButton": "Annuler"
  }
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "Language 'fr' registered successfully."
}
```

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

### Modular.js - useGlobalState()

Source: https://www.nexomaker.com/devs/api/index

Share state across components and persist data across route changes. This hook is ideal for global application state management.

```APIDOC
## useGlobalState Hook

### Description
Share state across components and persist data across route changes.

### Usage
`const [state, setState] = useGlobalState(key, initialState);
`

### Parameters
- **key** (string): A unique key to identify the global state.
- **initialState**: The initial value of the global state if it doesn't exist.

### Return Value
- **state**: The current global state value.
- **setState**: A function to update the global state value.

### Example Usage
```javascript
function ComponentA() {
  const [user, setUser] = useGlobalState('currentUser', null);

  return (
    <button onClick={() => setUser({ name: 'Alice' }) }>
      Login as Alice
    </button>
  );
}

function ComponentB() {
  const [user] = useGlobalState('currentUser');

  return <p>Welcome, {user ? user.name : 'Guest'}</p>;
}
```
```

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

### Creators - item.update()

Source: https://www.nexomaker.com/devs/api/index

Updates an existing item with new data. Use this to modify properties of items within a Nexo Maker project.

```APIDOC
## item.update()

### Description
Update an existing item with new data.

### Method
POST (or similar update mechanism)

### Endpoint
(Specific endpoint for item updates will vary)

### Parameters
#### Request Body
- **itemId** (string) - Required - The unique identifier of the item to update.
- **newData** (object) - Required - An object containing the new data for the item.

### Request Example
{
  "itemId": "item_123",
  "newData": {
    "name": "Updated Item Name",
    "value": 42
  }
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "Item 'item_123' updated successfully."
}
```

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

### Plugins Extension API - Transform Function

Source: https://www.nexomaker.com/devs/api/index

The core component for transforming items in export formats. Define how your expansion modifies or processes data during the export pipeline.

```APIDOC
## Transform Function

### Description
The core component for transforming items in export formats.

### Method Signature
`transform(item, context)`

### Parameters
- **item** (object) - The item data to be transformed.
- **context** (object) - Provides additional information about the export process.

### Return Value
- (object) - The transformed item data.

### Example Usage
```javascript
function transform(item, context) {
  // Modify item properties here
  item.processed = true;
  return item;
}
```
```

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

### Creators - item.deleteField()

Source: https://www.nexomaker.com/devs/api/index

Removes a field from an item's YAML data. This is useful for cleaning up item data or removing obsolete properties.

```APIDOC
## item.deleteField()

### Description
Remove a field from an item's YAML data.

### Method
POST (or similar delete mechanism)

### Endpoint
(Specific endpoint for field deletion will vary)

### Parameters
#### Request Body
- **itemId** (string) - Required - The unique identifier of the item.
- **fieldName** (string) - Required - The name of the field to remove.

### Request Example
{
  "itemId": "item_456",
  "fieldName": "obsolete_property"
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "Field 'obsolete_property' removed from item 'item_456'."
}
```
Tokens:
Raw