NamelessMC

https://docs.namelessmc.com/
Admin
NamelessMC is a free and powerful website software for Minecraft servers, featuring forums, custom...
Tokens:24,152
Snippets:245
Trust Score:9.7
Update:4 months ago
Show doc for...
Tokens:
Raw
### Advanced Example Module Main Class

Source: https://docs.namelessmc.com/en/module-documentation

This is a comprehensive example of a NamelessMC module's main class. It demonstrates installation, enabling, disabling, and page loading logic, including permission registration, navigation bar integration, and widget addition.

```php
<?php
// Demo module by Aberdeener
// module.php file

class Demo_Module extends Module {

    protected
        $_language,
        $_queries;

    public function __construct($language, $queries) {
        $name = 'Demo Module';
        $author = 'Aberdeener';
        $module_version = '0.0.2';
        $nameless_version = '2.0.0-pr13';

        parent::__construct($this, $name, $author, $module_version, $nameless_version);

        $this->_language = $language;
        $this->_queries = $queries;
    }

    public function onInstall() {
        $queries = $this->_queries;
        if (!count($queries->tableExists('wiki_articles'))) {
            $queries->createTable('wiki_articles', "`id` INT(11) NOT NULL AUTO_INCREMENT, `content` VARCHAR(102) NOT NULL, `user_id` INT(11) NOT NULL", "");
        }
        if (!count($queries->tableExists('wiki_user_stats'))) {
            $queries->createTable('wiki_user_stats', "`id` INT(11) NOT NULL AUTO_INCREMENT, `user_id` INT(11) NOT NULL, `wiki_articles` INT(11) NOT NULL", "");
        }
    }

    public function onUninstall() {}

    public function onEnable() {}

    public function onDisable() {}

    public onPageLoad($user, $pages, $cache, $smarty, $navs, $widgets, $template) {
        PermissionHandler::registerPermissions('Demo Module', array(
            'demo_module.view_wiki' => 'View the wiki',
            'demo_module.create_wiki_page' => 'Create wiki page',
            'demo_module.delete_wiki_page' => 'Delete wiki page',
        ));

        $pages->add('Demo Module', '/wiki', 'pages/wiki.php');
        $pages->add('Demo Module', '/panel/wiki', 'pages/panel/wiki.php');

        $cache->setCache('navbar_order');
        if(!$cache->isCached('wiki_order')) {
            $order = 3;
              $cache->store('wiki_order', $order);
          } else {
              $order = $cache->retrieve('wiki_order');
          }

        $cache->setCache('navbar_icons');
        if(!$cache->isCached('wiki_icon')) {
            $icon = 'fa fas-book';
            $cache->store('wiki_order', $icon);
        } else {
            $icon = $cache->retrieve('wiki_icon');
        }

        $language = $this->_language;

        // Add a page to the top navigation bar
        $navs[0]->add('wiki', $language->get('wiki', 'wiki'), URL::build('/wiki'), 'top', null, $order, $icon);

        if ($user->hasPermission('demo_module.create_wiki_page')) {
            // Add page to StaffCP side panel
            $navs[2]->add('create_wiki', $language->get('wiki', 'create_wiki'), URL::build('/wiki/create'));
        }

        require_once ROOT_PATH . '/modules/DemoModule/widgets/DemoWidget.php';
        $widget_pages = $widgets->getPages('Demo Widget');
        $demo_widget = new Demo_Widget($widget_pages);
        $widgets->add($demo_widget);

        $queries = $this->_queries;
        $wiki_article_count = count($queries->getWhere('wiki_articles', array('user_id', '=', $user->data()->id)));

        $fields = array(
            'user_id' => $user->data()->id,
            'wiki_articles' => $wiki_article_count
        );
        DB::getInstance()->insert('wiki_user_stats', $fields);
    }

    public function getDebugInfo(): array {
        return [];
    }

}

```

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

### Install Web Server and PHP-FPM (Apache)

Source: https://docs.namelessmc.com/en/installation-vps

Installs Apache and PHP-FPM, another common setup for NamelessMC. Choose this option if you prefer Apache with PHP-FPM.

```bash
# Option 2: Apache + php-fpm
apt install apache2 php-fpm
```

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

### Install Web Server (Apache + mod_php)

Source: https://docs.namelessmc.com/en/installation-vps

Installs Apache with the mod_php module. This is an alternative to using PHP-FPM with Apache.

```bash
# Option 3: Apache + mod_php
apt install php
```

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

### Install Web Server and PHP-FPM (Nginx)

Source: https://docs.namelessmc.com/en/installation-vps

Installs Nginx and PHP-FPM, a common setup for NamelessMC on Debian/Ubuntu systems. Choose this option if you plan to use Nginx as your web server.

```bash
# Option 1: Nginx + php-fpm
apt install nginx php-fpm
```

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

### Install MariaDB Database Server

Source: https://docs.namelessmc.com/en/installation-vps

Installs the MariaDB database server, which is a recommended database system for NamelessMC. Ensure you follow up with database and user creation.

```bash
# Install MariaDB database server
apt install mariadb-server
```

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

### Install Certbot and Apache Plugin (Ubuntu)

Source: https://docs.namelessmc.com/en/ssl

Installs Certbot and the Apache plugin on Ubuntu systems. This is the recommended method for Apache users.

```bash
sudo apt update
sudo apt install -y certbot python3-certbot-apache
```

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

### Start Apache2 Service

Source: https://docs.namelessmc.com/en/ssl

Starts the Apache2 webserver. This command is used after renewing the SSL certificate to resume webserver operations.

```bash
systemctl start apache2
```

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

### Start NGINX Service

Source: https://docs.namelessmc.com/en/ssl

Starts the NGINX webserver. This command is used after renewing the SSL certificate to resume webserver operations.

```bash
systemctl start nginx
```

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

### Install Certbot and NGINX Plugin (Ubuntu)

Source: https://docs.namelessmc.com/en/ssl

Installs Certbot and the NGINX plugin on Ubuntu systems. This is the recommended method for NGINX users.

```bash
sudo apt update
sudo apt install -y certbot python3-certbot-nginx
```

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

### Database Insertion Fields Example

Source: https://docs.namelessmc.com/en/module-documentation

This example demonstrates the required array format for the `$fields` parameter when using the `DB::insert()` method to add a new row to a database table.

```php
// Column name => value
$fields = array(
    'wiki_title' => 'First Wiki Article!',
    'wiki_content' => 'Greetings, everyone!',
    'wiki_author' => $user->data()->id
);

```

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

### Create a MySQL Database

Source: https://docs.namelessmc.com/en/mysql

Create a new database for your NamelessMC installation. The database name 'nameless' can be customized.

```sql
CREATE DATABASE nameless;
```

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

### POST /suggestions/create

Source: https://docs.namelessmc.com/en/api-documentation

Creates a new suggestion. The response is the same as the GET /suggestions/{suggestion} endpoint.

```APIDOC
## POST /suggestions/create

### Description
Creates a new suggestion. The response is the same as the GET /suggestions/{suggestion} endpoint.

### Method
POST

### Endpoint
`/suggestions/create`

### Parameters
#### Request Body
- **user** (user transformer) - Required - The user creating the suggestion.
- **title** (string) - Required - The title of the suggestion.
- **content** (string) - Required - The content of the suggestion (Use \n for new lines).
- **category** (int) - Optional - Category ID. Defaults to Unassigned.
```

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

### Register Permissions Example

Source: https://docs.namelessmc.com/en/module-documentation

Register permissions for a module, grouping them under a specific section in the StaffCP. The permissions array maps internal permission values to user-friendly titles.

```php
$permissions = array(
    'demo_module.add_user' => 'Add user',
    'demo_module.delete_user' => 'Delete user'
);
```

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

### Install Required PHP Extensions

Source: https://docs.namelessmc.com/en/installation-vps

Installs essential PHP extensions required for NamelessMC functionality, such as curl, gd, mbstring, and pdo. These are necessary for various features of the application.

```bash
# Install required extensions
apt install php-{curl,exif,gd,mbstring,mysql,pdo,xml}
```

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

### GET /store/products

Source: https://docs.namelessmc.com/en/api-documentation

Retrieves a list of all store products. Includes details like ID, category, name, price, and visibility status.

```APIDOC
## GET /store/products

### Description
Retrieves a list of all store products, including their ID, category, name, price, and visibility status.

### Method
GET

### Endpoint
/store/products

### Response
#### Success Response (200)
- **products** (array) - An array of product objects.
  - **id** (int) - The unique identifier for the product.
  - **category_id** (int) - The ID of the category the product belongs to.
  - **name** (string) - The name of the product.
  - **price** (float) - The price of the product.
  - **price_cents** (int) - The price of the product in cents.
  - **hidden** (bool) - Indicates if the product is hidden.
  - **disabled** (bool) - Indicates if the product is disabled.
```

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

### Example Module File Layout

Source: https://docs.namelessmc.com/en/module-documentation

This is a typical file structure for a NamelessMC module, excluding custom organization folders like 'classes/'.

```plaintext
- modules/
    - DemoModule/
        - init.php
        - module.php
        - hooks/
            - <hook classes>
        - includes/
            - admin_widgets/
                - <widget settings files>
            - endpoints/
                - <EndpointBase classes>
        - pages/
            - <frontend page files>
            - panel/
                - <StaffCP page files>
        - widgets/
            - <WidgetBase classes>
- custom/
    - templates/
        - DefaultRevamp/
            - DemoModule/
                - <frontend Smarty files>
```

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

### GET /info

Source: https://docs.namelessmc.com/en/api-documentation

Retrieves general information about the NamelessMC instance, including version, language, and enabled modules.

```APIDOC
## GET /info

### Description
Returns general information about this NamelessMC instance. No parameters required.

### Method
GET

### Endpoint
/info

### Response
#### Success Response
- **nameless_version** (string) - NamelessMC version, e.g. `2.0.0-pr13`
- **version_update** (object, optional)
  - **update** (boolean) - whether there is an update available, true or false
  - **version** (string, optional) - the version for the available update
  - **urgent** (boolean, optional) - whether the update is urgent (ie a security fix), true or false
- **language** (string) - Default language string
- **modules** (array) - list of names of enabled modules
```

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

### GET /forms/{form}

Source: https://docs.namelessmc.com/en/api-documentation

Retrieves details for a specific form, including its fields and configuration.

```APIDOC
## GET /forms/{form}

### Description
Retrieves detailed information for a specific form, including its fields and configuration.

### Method
GET

### Endpoint
/forms/{form}

### Parameters
#### Path Parameters
- **form** (string/int) - Required. The ID or URL path of the form (e.g., '1' or '/apply').

### Response
#### Success Response (200)
- **id** (int) - The unique identifier for the form.
- **url** (string) - The URL path for the form (e.g., /apply).
- **url_full** (string) - The full URL to the form page.
- **title** (string) - The title of the form.
- **captcha** (bool) - Indicates if the form uses captcha protection.
- **comment_status** (int) - The status for user comments on submissions (default 0 for disabled).
- **fields** (array) - An array of field objects for this form.
  - **id** (int) - The unique identifier for the field.
  - **name** (string) - The name of the field.
  - **type** (int) - The type of the field.
  - **required** (bool) - Indicates if the field is required.
  - **min** (int) - The minimum allowed characters for the field.
  - **max** (int) - The maximum allowed characters for the field.
  - **placeholder** (string/null) - Placeholder text for the field.
  - **options** (string/null) - Options for select or radio fields.
  - **info** (string/null) - Additional information or help text for the field.
```

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

### GET /groups

Source: https://docs.namelessmc.com/en/api-documentation

Retrieves a list of all available user groups.

```APIDOC
## GET /groups

### Description
Retrieves a list of all user groups available on the NamelessMC site, ordered by their display order.

### Method
GET

### Endpoint
`/groups`

### Parameters
#### Query Parameters
- **id** (string) - Optional - Specify multiple times to filter by specific group IDs.
- **name** (string) - Optional - Specify multiple times to filter by specific group names.

### Response
#### Success Response (200)
- **groups** (array) - An array of group objects, ordered by `order`.
  - **id** (integer) - The group ID.
  - **name** (string) - The group name.
  - **staff** (boolean) - Indicates if the group is a staff group.
  - **order** (integer) - The display order of the group.
```

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

### GET /users/{user}

Source: https://docs.namelessmc.com/en/api-documentation

Retrieves information about a specified user.

```APIDOC
## GET /users/{user}

### Description
Retrieves detailed information about a specific user identified by their username or ID.

### Method
GET

### Endpoint
`/users/{user}`

### Parameters
#### Path Parameters
- **user** (string) - Required - The username or ID of the user to retrieve.

### Response
#### Success Response (200)
- **exists** (boolean) - Indicates if the user exists. If false, no other values are present.
- **id** (string) - The user's unique ID.
- **username** (string) - The user's username.
- **language_id** (string) - The user's language ID.
- **language** (string) - The user's language.
- **displayname** (string) - The user's display name (can be null).
- **uuid** (string) - The user's UUID.
- **registered_timestamp** (integer) - Timestamp of user registration.
- **last_online_timestamp** (integer) - Timestamp of the user's last online activity.
- **banned** (boolean) - Indicates if the user is banned.
- **validated** (boolean) - Indicates if the user's account is verified.
- **user_title** (string) - The user's title.
- **discord_id** (string) - The user's Discord ID, or null if not linked.
- **groups** (array) - A list of groups the user belongs to.
  - **id** (integer) - Group ID.
  - **name** (string) - Group name.
  - **staff** (boolean) - Indicates if the group is a staff group.
  - **order** (integer) - The order of the group.
- **profile_fields** (object) - A map of profile fields.
  - **`<field_id>`** (object)
    - **name** (string) - The name of the profile field.
    - **type** (integer) - The type of the field (1: text, 2: textarea, 3: date).
    - **public** (boolean) - Whether the field is public.
    - **required** (boolean) - Whether the field is required.
    - **description** (string) - Description of the field.
    - **value** (string) - The value of the field.
```

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

### GET /forms

Source: https://docs.namelessmc.com/en/api-documentation

Retrieves a list of all available forms on the platform. Includes basic information about each form.

```APIDOC
## GET /forms

### Description
Retrieves a list of all available forms on the platform, including their ID, URL, title, and settings.

### Method
GET

### Endpoint
/forms

### Response
#### Success Response (200)
- **forms** (array) - A list of form objects.
  - **id** (int) - The unique identifier for the form.
  - **url** (string) - The URL path for the form (e.g., /apply).
  - **url_full** (string) - The full URL to the form page.
  - **title** (string) - The title of the form.
  - **captcha** (bool) - Indicates if the form uses captcha protection.
  - **comment_status** (int) - The status for user comments on submissions (default 0 for disabled).
```

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

### GET /websend/commands

Source: https://docs.namelessmc.com/en/api-documentation

Retrieves a list of available commands for the Websend module, filtered by server ID.

```APIDOC
## GET /websend/commands

### Description
Retrieves a list of available commands for the Websend module, filtered by server ID.

### Method
GET

### Endpoint
/websend/commands

### Parameters
#### Query Parameters
- **server_id** (int) - Required

### Response
#### Success Response
- **commands** (array of json objects)
  - **id** (int)
  - **command** (string)

### Response Example
```json
{
  "commands": [
    {
      "id": 1,
      "command": "say Hello"
    }
  ]
}
```

### Errors
?
```

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

### GET /users

Source: https://docs.namelessmc.com/en/api-documentation

Retrieves a list of users with optional filtering and limiting.

```APIDOC
## GET /users

### Description
Retrieves a list of users with optional filtering and limiting.

### Method
GET

### Endpoint
/users

### Parameters
#### Query Parameters
- **limit** (int) - Optional - Max number of users to return. Defaults to 15. Set to 0 to disable.
- **banned** (boolean) - Optional - Filter by banned status.
- **verified** (boolean) - Optional - Filter by verified status.
- **discord_linked** (boolean) - Optional - Filter by Discord linked status.
- **group_id** (integer) - Optional - Filter by group ID.
- **operator** (string) - Optional - Whether all filters must apply ('AND', default) or at least one ('OR').

### Response
#### Success Response
- **users** (array)
  - **id** (int)
  - **username** (string)
  - **banned** (boolean)
  - **verified** (boolean)
  - **integrations** (object)

### Response Example
```json
{
  "users": [
    {
      "id": 1,
      "username": "TestUser",
      "banned": false,
      "verified": true,
      "integrations": {}
    }
  ]
}
```

### Errors
?
TODO: Document integration data
TODO: Website may return more fields than mentioned here
```

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

### Enable Apache Rewrite Module and AllowOverride

Source: https://docs.namelessmc.com/en/faq

Modify Apache configuration to enable .htaccess files and the rewrite module for NamelessMC installation in a subdirectory. This is typically needed on Ubuntu/Debian systems.

```apache
<Directory /var/www/html>
    AllowOverride All
</Directory>
```

```bash
sudo a2enmod rewrite
sudo service apache2 restart
```

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

### Set File Permissions for NamelessMC Directory

Source: https://docs.namelessmc.com/en/faq

Ensure the NamelessMC web directory and its subdirectories are writable by the webserver process. This command is an example for Apache and Nginx on Ubuntu.

```bash
sudo chown -R www-data:www-data /var/www/html
```

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

### GET /suggestions/{suggestion}

Source: https://docs.namelessmc.com/en/api-documentation

Retrieves details of a specific suggestion, including author, status, category, and engagement metrics.

```APIDOC
## GET /suggestions/{suggestion}

### Description
Retrieves details of a specific suggestion, including author, status, category, and engagement metrics.

### Method
GET

### Endpoint
`/suggestions/{suggestion}`

### Response
#### Success Response
- **id** (int) - Suggestion ID.
- **author** (json object)
  - **id** (int) - User ID of the author.
  - **link** (string) - URL to the suggestion.
  - **username** (string) - Username or 'Deleted User'.
- **updated_by** (json object)
  - **id** (int) - User ID of the last updater.
  - **username** (string) - Username or 'Deleted User'.
- **status** (json object)
  - **id** (int) - Status ID.
  - **name** (string) - Status name.
  - **open** (bool) - Indicates if the suggestion is open or closed.
- **category** (json object)
  - **id** (int) - Category ID.
  - **name** (string) - Category name.
- **title** (string) - Suggestion Title.
- **content** (string) - Suggestion content (Use \n for new lines).
- **views** (int) - The amount of views.
- **created** (int) - Timestamp of creation.
- **last_updated** (int) - Timestamp of last update.
- **likes_count** (int) - The amount of likes.
- **dislikes_count** (int) - The amount of dislikes.
- **likes** (array) - List of user IDs who liked the suggestion.
- **dislikes** (array) - List of user IDs who disliked the suggestion.
```

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

### GET /store/categories

Source: https://docs.namelessmc.com/en/api-documentation

Retrieves a list of all store categories. Includes details like ID, name, and visibility status.

```APIDOC
## GET /store/categories

### Description
Retrieves a list of all store categories, including their ID, name, and whether they are hidden or disabled.

### Method
GET

### Endpoint
/store/categories

### Response
#### Success Response (200)
- **categories** (array) - An array of category objects.
  - **id** (int) - The unique identifier for the category.
  - **name** (string) - The name of the category.
  - **hidden** (bool) - Indicates if the category is hidden.
  - **disabled** (bool) - Indicates if the category is disabled.
```

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

### Bare Minimum Module Initialization

Source: https://docs.namelessmc.com/en/module-documentation

This snippet shows the essential lines required in an init.php file to load and instantiate a module's main class.

```php
<?php
// Demo module by Aberdeener
// init.php file

require_once ROOT_PATH . '/modules/DemoModule/module.php';
$module = new Demo_Module();

```

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

### Enable NGINX Configuration and Reload

Source: https://docs.namelessmc.com/en/webserver

After creating the NGINX configuration file, enable it by creating a symbolic link (if not on CentOS) and then reload the NGINX service to apply the changes.

```bash
# You do not need to symlink this file if you are using CentOS.
sudo ln -s /etc/nginx/sites-available/nameless.conf /etc/nginx/sites-enabled/nameless.conf

# Reload NGINX
nginx -s reload
```

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

### Create Website Directory

Source: https://docs.namelessmc.com/en/installation-vps

Creates the directory structure for the NamelessMC website. This command ensures the parent directories exist before creating the final directory.

```bash
mkdir -p /var/www/html
```

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

### Enable Apache Configuration and Modules

Source: https://docs.namelessmc.com/en/webserver

Enables a custom Apache site configuration, rewrites, and SSL module, then restarts the Apache service. These commands are specific to Debian-based systems like Ubuntu.

```bash
# You do not need to run any of these commands on CentOS
sudo ln -s /etc/apache2/sites-available/nameless.conf /etc/apache2/sites-enabled/nameless.conf
sudo a2enmod rewrite
sudo a2enmod ssl
systemctl restart apache2
```

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

### GET /users/{user}/notifications

Source: https://docs.namelessmc.com/en/api-documentation

Retrieves a list of notifications for a specified user.

```APIDOC
## GET /users/{user}/notifications

### Description
Retrieves a list of alerts and notifications associated with a specific user account.

### Method
GET

### Endpoint
`/users/{user}/notifications`

### Parameters
#### Path Parameters
- **user** (string) - Required - The username or ID of the user whose notifications to retrieve.

### Response
#### Success Response (200)
- **notifications** (array) - An array of notification objects.
  - **message** (string) - The content of the notification.
  - **url** (string) - The URL associated with the notification.
  - **type** (string) - The type of notification (e.g., "message", "like", "profile_post", "thread-reply").

**Notification Types:**
- `message`: A new private message for the user.
- `like`: Someone has liked a post by the user (coming soon).
- `profile_post`: Someone has left a comment on the user's profile.
- `profile_post_reply`: Someone has replied to a comment on a profile.
- `thread-reply`: Someone has posted in a thread the user is watching (coming soon).
- `follow`: Someone has followed the user (coming soon).

**Note:** Modules may introduce custom notification types. Your application should be prepared to handle unknown types gracefully.
```

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

### GET /users/{user}/announcements

Source: https://docs.namelessmc.com/en/api-documentation

Fetches all announcements visible to a specified user.

```APIDOC
## GET /users/{user}/announcements

### Description
Returns all announcements the specified user can see.

### Method
GET

### Endpoint
/users/{user}/announcements

### Parameters
#### Path Parameters
- **user** (string) - Required - The user identifier (ID, username, or integration ID).

### Response
#### Success Response
- **announcements** (array)
  - **id** (int) - announcement id
  - **header** (string) - announcement header/title
  - **message** (string) - announcement content
  - **pages** (string array) - pages where the announcement is displayed
  - **groups** (int array) - groups to which the announcement is shown
```

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

### Generate SSL Certificate with Certbot (Apache)

Source: https://docs.namelessmc.com/en/ssl

Generates an SSL certificate for a specified domain using Certbot's Apache plugin. Replace 'example.com' with your domain. Multiple domains can be added with additional -d flags.

```bash
certbot certonly --apache -d example.com
```

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

### Generate SSL Certificate with Certbot (NGINX)

Source: https://docs.namelessmc.com/en/ssl

Generates an SSL certificate for a specified domain using Certbot's NGINX plugin. Replace 'example.com' with your domain. Multiple domains can be added with additional -d flags.

```bash
certbot certonly --nginx -d example.com
```

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

### Enable Apache Configuration and Rewrite Module

Source: https://docs.namelessmc.com/en/webserver

Enables a custom Apache site configuration and the rewrite module, then restarts the Apache service. These commands are specific to Debian-based systems like Ubuntu and do not include SSL module enabling.

```bash
# You do not need to run any of these commands on CentOS
sudo ln -s /etc/apache2/sites-available/nameless.conf /etc/apache2/sites-enabled/nameless.conf
sudo a2enmod rewrite
systemctl restart apache2
```

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

### GET /forms/submissions/{submission}

Source: https://docs.namelessmc.com/en/api-documentation

Retrieves details for a specific form submission, including field answers and status.

```APIDOC
## GET /forms/submissions/{submission}

### Description
Retrieves detailed information for a specific form submission, including the form details, user information, status, and field answers.

### Method
GET

### Endpoint
/forms/submissions/{submission}

### Parameters
#### Path Parameters
- **submission** (int) - Required. The ID of the submission to retrieve.

### Response
#### Success Response (200)
- **id** (int) - The unique identifier for the submission.
- **form** (json object) - Information about the form.
  - **id** (int) - The form's ID.
  - **title** (string) - The form's title.
- **user** (json object) - Information about the user who submitted.
  - **id** (int/null) - The user's ID (null if posted by a guest).
  - **username** (string) - The username or 'Guest'/'Deleted User'.
- **created** (int) - Timestamp of when the submission was created.
- **last_updated** (int) - Timestamp of when the submission was last updated.
- **status** (json object) - Information about the submission's status.
  - **id** (int) - The status ID.
  - **name** (string) - The status name.
  - **open** (int) - Indicates if the submission is open (1) or closed (0).
- **fields** (array) - An array of field objects with the user's answers.
  - **question** (string) - The question asked in the form field.
  - **field_type** (int) - The type of the form field.
  - **answer** (string) - The user's input for this field.
```

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

### GET /forms/submissions

Source: https://docs.namelessmc.com/en/api-documentation

Retrieves a list of form submissions with optional filtering by form, user, status, and limit.

```APIDOC
## GET /forms/submissions

### Description
Retrieves a list of form submissions with optional filtering by form, user, status, and limit. Submissions are ordered by newest.

### Method
GET

### Endpoint
/forms/submissions

### Parameters
#### Query Parameters
- **form** (int) - Optional. Filter by form ID.
- **user_id** (int) - Optional. Filter by the ID of the user who submitted.
- **updated_by_user** (int) - Optional. Filter by the ID of the user who last updated the submission.
- **status** (int) - Optional. Filter by submission status ID.
- **limit** (int) - Optional. Limit the number of submissions returned.

### Response
#### Success Response (200)
- **submissions** (array) - A list of submission objects.
  - **id** (int) - The unique identifier for the submission.
  - **form_id** (int) - The ID of the form the submission belongs to.
  - **user_id** (int/null) - The ID of the user who submitted (null if posted by a guest).
  - **updated_by** (int/null) - The ID of the user who last updated the submission (null if posted by a guest).
  - **created** (int) - Timestamp of when the submission was created.
  - **last_updated** (int) - Timestamp of when the submission was last updated.
  - **status_id** (int) - The status ID of the submission.
```

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

### POST /users/register

Source: https://docs.namelessmc.com/en/api-documentation

Registers a new user with the provided username, email, and optional integrations.

```APIDOC
## POST /users/register

### Description
Registers a specified user. This endpoint allows for the creation of new user accounts, optionally linking external service accounts.

### Method
POST

### Endpoint
`/users/register`

### Parameters
#### Request Body
- **username** (string) - Required - The desired username for the new account.
- **email** (string) - Required - The email address for the new account.
- **integrations** (json object) - Optional - An object containing details for linked services.
  - **`<integration name>`** (object) - e.g., "Minecraft", "Discord"
    - **identifier** (string) - Required if integration is present - The unique ID from the integration service (e.g., Discord ID, UUID).
    - **username** (string) - Required if integration is present - The username from the integration service (e.g., Discord username, Minecraft username).

### Request Example
```json
{
  "username": "Derkades",
  "email": "me@example.com",
  "integrations": {
    "Discord": {
      "identifier": "183954832485253121",
      "username": "Derkades#9976"
    }
  }
}
```

### Response
#### Success Response (200)
- **link** (string) - Optional - A link to set the user's password or for email verification.

### Error Codes
- 7: Invalid email address
- 8: Invalid username
- 10: Duplicate email
- 11: Duplicate username
- 13: Other error
- 14: Failed to send email
- 38: Duplicate integration username
- 39: Duplicate integration ID
```

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

### GET /store/pending-commands

Source: https://docs.namelessmc.com/en/api-documentation

Retrieves pending commands for a specific connection, useful for synchronizing actions with external services.

```APIDOC
## GET /store/pending-commands

### Description
Retrieves pending commands for a specific connection, useful for synchronizing actions with external services like game servers.

### Method
GET

### Endpoint
/store/pending-commands

### Parameters
#### Query Parameters
- **connection_id** (int) - Required. The connection ID to the external service (e.g., minigame server).

### Response
#### Success Response (200)
- **online_mode** (bool) - Indicates if the website is using UUID linking.
- **customers** (array) - A list of customers with pending commands.
  - **customer_id** (int) - The customer's ID.
  - **user_id** (int/null) - The associated user ID, if any.
  - **identifier** (string/null) - An identifier for the customer.
  - **username** (string) - The username of the customer.
  - **commands** (array) - A list of commands to be executed for this customer.
    - **id** (int) - The command's unique identifier.
    - **command** (string) - The command string to execute.
    - **order_id** (int) - The ID of the order associated with the command.
    - **require_online** (bool) - Indicates if the player needs to be online for the command to execute.
```

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

### GET /store/payments

Source: https://docs.namelessmc.com/en/api-documentation

Retrieves a list of payments with optional filtering by order, gateway, status, customer, or recipient.

```APIDOC
## GET /store/payments

### Description
Retrieves a list of payments with optional filtering by order, gateway, status, customer, or recipient. Payments are sorted by the latest.

### Method
GET

### Endpoint
/store/payments

### Parameters
#### Query Parameters
- **order** (int) - Optional. Order ID.
- **gateway** (int) - Optional. Gateway ID.
- **status** (int) - Optional. Payment Status ID (0: Pending, 1: Complete, 2: Refunded, 3: Chargebacked, 4: Denied).
- **customer** (int) - Optional. Customer ID.
- **recipient** (int) - Optional. Customer ID of the recipient.
- **limit** (int) - Optional. Limit the number of payments returned.

### Response
#### Success Response (200)
- **payments** (array) - An array of payment objects.
  - **id** (int) - The unique identifier for the payment.
  - **order_id** (int) - The ID of the associated order.
  - **gateway_id** (int) - The ID of the payment gateway.
  - **transaction** (string, nullable) - The transaction identifier.
  - **amount** (string) - The payment amount.
  - **amount_cents** (int) - The payment amount in cents.
  - **currency** (string) - The currency of the payment.
  - **fee** (string) - The transaction fee.
  - **status_id** (int) - The status ID of the payment.
  - **created** (int) - Timestamp of payment creation.
  - **last_updated** (int) - Timestamp of the last update by the gateway provider.
  - **customer** (json object) - Information about the customer who paid.
    - **customer_id** (int) - The customer's ID.
    - **user_id** (int/null) - The associated user ID, if any.
    - **username** (string/null) - The username of the customer, if associated with a user.
    - **identifier** (string/null) - An identifier for the customer.
  - **recipient** (json object) - Information about the customer receiving the items.
    - **customer_id** (int) - The customer's ID.
    - **user_id** (int/null) - The associated user ID, if any.
    - **username** (string/null) - The username of the recipient, if associated with a user.
    - **identifier** (string/null) - An identifier for the recipient.
  - **products** (array) - A list of products included in the payment.
    - **id** (int) - The product ID.
    - **name** (string) - The product name.
```

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

### Trust All IP Addresses as Proxies (Testing Only)

Source: https://docs.namelessmc.com/en/trusted-proxies

Use '0.0.0.0/0' to trust all IP addresses as proxies. This is dangerous and should only be used for testing purposes as it bypasses IP-based security measures like bans and rate limits.

```php
'trustedProxies' => ['0.0.0.0/0']
```

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

### Configure Trusted Proxies in config.php

Source: https://docs.namelessmc.com/en/trusted-proxies

Add the 'trustedProxies' option to the 'core' section of your `core/config.php` file. This is an array of IP networks that NamelessMC will trust for proxy headers.

```php
'trustedProxies' => ['10.0.0.0/8', '172.16.0.0/12', '192.168.0.0/16']
```

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

### Demo Module Class Structure

Source: https://docs.namelessmc.com/en/module-documentation

The core module class must extend NamelessMC's Module class and implement several key methods for lifecycle management and event handling.

```php
<?php
// Demo module by Aberdeener
// module.php file

class Demo_Module extends Module {

    public function __construct() {
        $name = 'Demo Module';
        $author = 'Aberdeener';
        $module_version = '0.0.1';
        $nameless_version = '2.0.0-pr13';

        parent::__construct($this, $name, $author, $module_version, $nameless_version);
    }

    public function onInstall() {}

    public function onUninstall() {}

    public function onEnable() {}

    public function onDisable() {}

    public function onPageLoad($user, $pages, $cache, $smarty, $navs, $widgets, $template) {}

    public function getDebugInfo(): array {
        return [];
    }

}

```

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

### POST /integration/verify

Source: https://docs.namelessmc.com/en/api-documentation

Verifies a user's integration with a service like Minecraft or Discord using a code and identifier.

```APIDOC
## POST /integration/verify

### Description
Verifies a user's integration with a service like Minecraft or Discord using a code and identifier.

### Method
POST

### Endpoint
/integration/verify

### Parameters
#### Request Body
- **integration** (string) - Required - Integration type (e.g., "Minecraft", "Discord")
- **code** (string) - Required - Verification code
- **identifier** (string) - Required - Unique identifier (e.g., UUID, numerical ID)
- **username** (string) - Required - Display name (e.g., Minecraft or Discord username)

### Response
(No success response documented)

### Errors
- **core:invalid_integration**
- **core:invalid_code**
- **38/39** for invalid integration username / identifier respectively
```

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

### Create NamelessMC Database and User

Source: https://docs.namelessmc.com/en/installation-vps

Creates a dedicated MySQL/MariaDB database and user for NamelessMC. This includes setting a password, granting privileges, and exiting the MySQL client.

```sql
mysql -u root -p
# Remember to change 'yourPassword' below to be a unique > password
CREATE USER 'nameless'@'127.0.0.1' IDENTIFIED BY 'yourPassword';
CREATE DATABASE nameless;
GRANT ALL PRIVILEGES ON nameless.* TO 'nameless'@'127.0.0.1' WITH GRANT OPTION;
exit
```

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

### Login to MySQL Command Line

Source: https://docs.namelessmc.com/en/mysql

Use this command to access the MySQL command line interface. You will be prompted for the root password.

```bash
mysql -u root -p
```

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

### Remove Default NGINX Configuration

Source: https://docs.namelessmc.com/en/webserver

Before applying a new NGINX configuration, remove the default one. This command is used for both HTTP and HTTPS setups.

```bash
rm /etc/nginx/sites-enabled/default
```

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

### Generate SSL Certificate with Certbot (Standalone)

Source: https://docs.namelessmc.com/en/ssl

Generates an SSL certificate using Certbot's standalone mode. This method requires stopping your webserver first. Replace 'example.com' with your domain.

```bash
certbot certonly --standalone -d example.com
```

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

### Configure Trusted Proxies via Environment Variable

Source: https://docs.namelessmc.com/en/trusted-proxies

Set the NAMELESS_TRUSTED_PROXIES environment variable as a comma-separated list of IP networks. This method allows for dynamic configuration without modifying the config file.

```bash
NAMELESS_TRUSTED_PROXIES=10.0.0.0/8,172.16.0.0/12,192.168.0.0/16
```

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

### POST /websend/console

Source: https://docs.namelessmc.com/en/api-documentation

Sends console commands to a specified server via the Websend module.

```APIDOC
## POST /websend/console

### Description
Sends console commands to a specified server via the Websend module.

### Method
POST

### Endpoint
/websend/console

### Parameters
#### Request Body
- **server_id** (int) - Required
- **content** (array of strings) - Required - One line per array element

### Request Example
```json
{
  "server_id": 1,
  "content": [
    "say This is a command.",
    "say This is another command."
  ]
}
```

### Response
(No success response documented)

### Errors
?
```

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

### Reset Admin Password in NamelessMC Database

Source: https://docs.namelessmc.com/en/faq

To reset an admin password, directly modify the 'password' and 'pass_method' fields in the 'nl2_users' table within your database. This example sets the password to '123456'.

```sql
UPDATE nl2_users SET password = '$2y$13$Q1NRQCPQNhs4EihdJSidQ.31bw2CTPSH03QrXd9EOH3sYuni1fbSu', pass_method = 'default' WHERE username = 'your_username';
```

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

### Set File Ownership and Permissions

Source: https://docs.namelessmc.com/en/installation-vps

Sets the correct ownership and permissions for the NamelessMC files. This is crucial for the webserver to be able to read and write to the necessary directories.

```bash
chown -R www-data:www-data /var/www/html
chmod -R ugo-x,u+rwX,go-rw /var/www/html
```

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

### Disable Two-Factor Authentication for Users and Groups

Source: https://docs.namelessmc.com/en/faq

Run SQL queries to disable two-factor authentication. The first query disables it for all users, and the second disables forced TFA setup for all groups.

```sql
UPDATE nl2_users SET tfa_enabled=0;
```

```sql
UPDATE nl2_groups SET force_tfa=0;
```

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

### Registering Event Parameters

Source: https://docs.namelessmc.com/en/module-documentation

Defines the parameters for a NamelessMC event. Use this when registering a new event with `HookHandler::registerEvent` if your event requires specific data.

```php
<?php
// Param name => Param description
$params = array(
    'user_id' => 'ID of the user to ban.',
    'reason' => 'Reason to display to banned user.'
);

```

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

### Create a New MySQL User

Source: https://docs.namelessmc.com/en/mysql

Create a dedicated user for your website. Replace 'somePassword' with a strong, unique password. This user is configured to only allow connections from localhost.

```sql
# Remember to change 'somePassword' below to be a unique password specific to this account.
CREATE USER 'nameless'@'127.0.0.1' IDENTIFIED BY 'somePassword';
```

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

### Create Report

Source: https://docs.namelessmc.com/en/api-documentation

Creates a report about a user. If the reported user is not specified by ID, both reported_username and reported_uid must be provided. Server ID is required for reports associated with Minecraft servers.

```json
{
  "reporter": 1,
  "content": "User is cheating",
  "reported": 2,
  "server_id": "1"
}
```

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

### POST /suggestions/{suggestion}/like

Source: https://docs.namelessmc.com/en/api-documentation

Allows a user to like or unlike a suggestion. Defaults to liking if 'like' is not specified.

```APIDOC
## POST /suggestions/{suggestion}/like

### Description
Allows a user to like or unlike a suggestion. Defaults to liking if 'like' is not specified.

### Method
POST

### Endpoint
`/suggestions/{suggestion}/like`

### Parameters
#### Request Body
- **user** (user transformer) - Required - The user performing the action.
- **like** (bool) - Optional - Set to true to like, false to unlike. Defaults to true.
```

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

### Assign Permissions to MySQL User

Source: https://docs.namelessmc.com/en/mysql

Grant all privileges on the newly created database to the dedicated user. This ensures the website has full access to its database.

```sql
GRANT ALL PRIVILEGES ON nameless.* TO 'nameless'@'127.0.0.1' WITH GRANT OPTION;
```

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

### POST /users/{user}/add-credits

Source: https://docs.namelessmc.com/en/api-documentation

Adds credits to a user's account. The amount is specified as a floating-point number.

```APIDOC
## POST /users/{user}/add-credits

### Description
Adds credits to a user's account. The amount is specified as a floating-point number.

### Method
POST

### Endpoint
/users/{user}/add-credits

### Parameters
#### Path Parameters
- **user** (string) - Required - The NamelessMC ID of the user

#### Request Body
- **credits** (float) - Required - The amount of credits to add (e.g., 5.99)

### Response
(No success response documented)

### Errors
- **store:invalid_credits_amount**
```

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

### Register User with Discord Integration

Source: https://docs.namelessmc.com/en/api-documentation

Use this endpoint to register a new user and link their Discord account. Ensure the Discord identifier and username are correctly provided.

```json
{
  "username": "Derkades",
  "email": "me@example.com",
  "integrations": {
    "Discord": {
      "identifier": "183954832485253121",
      "username": "Derkades#9976"
    }
  }
}
```
Tokens:
Raw