NamelessMC Documentation

NamelessMC is a website software designed for Minecraft server communities. Key features include:

• Forums: Community discussion boards.
• Custom Pages: Create HTML pages with group-based access restrictions.
• Social Logins: Integration with Discord and Google.
• Minecraft Integration:
  • Server status display (Java/Bedrock).
  • Account verification via MCAssoc or the NamelessMC plugin.
  • In-game plugin support for registration, rank synchronization (Vault to NamelessMC), announcements, whitelisting, and banning.
• Discord Integration: Webhooks for updates and the Nameless-Link bot for bidirectional role/group synchronization.
• Extensibility: A powerful module system, widget system, and a full API.
• Customization: Template and language systems for total UI/UX control.
• Pretty URLs: Supported via mod_rewrite or specific Nginx configurations.

NamelessMC requires specific URL rewriting rules to be configured in the web.config file when running on an IIS (Internet Information Services) web server. These rules handle:

1. Trailing Slash Redirection: Redirects requests for directories that are not actual physical directories to their non-trailing-slash equivalent (Rule 2).
2. Avatar Routing: Rewrites clean avatar URLs (e.g., /avatar/username/size/type) to the internal core/avatar/face.php handler (Rules 3, 4, 5, and 6).
3. Front Controller Pattern: Routes all requests that do not match an existing physical file or directory to index.php using the route query parameter (Rule 7). This enables NamelessMC's SEO-friendly routing.

To use this configuration, rename web.config.example to web.config and place it in your web root.

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <system.webServer>
        <rewrite>
            <rules>
                <!-- Rule 2: Remove trailing slashes -->
                <rule name="Rule 2" stopProcessing="true">
                    <match url="^(.+)/" ignoreCase="false" />
                    <conditions logicalGrouping="MatchAll">
                        <add input="{REQUEST_FILENAME}" matchType="IsDirectory" ignoreCase="false" negate="true" />
                    </conditions>
                    <action type="Redirect" url="{R:1}" redirectType="Permanent" />
                </rule>

                <!-- Rules 3-6: Avatar Rewriting -->
                <!-- ... -->

                <!-- Rule 7: Route everything else to index.php -->
                <rule name="Rule 7" stopProcessing="true">
                    <match url="^(.*)$" />
                    <conditions logicalGrouping="MatchAll">
                        <add input="{REQUEST_FILENAME}" matchType="IsFile" ignoreCase="false" negate="true" />
                        <add input="{REQUEST_FILENAME}" matchType="IsDirectory" ignoreCase="false" negate="true" />
                    </conditions>
                    <action type="Rewrite" url="index.php?route=/{R:1}" appendQueryString="true" />
                </rule>
            </rules>
        </rewrite>
    </system.webServer>
</configuration>

A standard NamelessMC page entrypoint follows a specific lifecycle to ensure modules, navigation, and templates are loaded correctly:

1. Define Page Identity: Set the PAGE constant and $page_title.
2. Initialize Frontend: require_once ROOT_PATH . '/core/templates/frontend_init.php';.
3. Load Modules: Use Module::loadPage() passing the $user, $pages, $cache, $smarty, navigation arrays, $widgets, and $template.
4. Render Components: Require standard components like cc_navbar.php, navbar.php, and footer.php.
5. Finalize: Call $template->onPageLoad() and then $template->displayTemplate('template_path').

const PAGE = 'cc_overview';
$page_title = $language->get('user', 'user_cp');
require_once ROOT_PATH . '/core/templates/frontend_init.php';

// ... logic ...

Module::loadPage($user, $pages, $cache, $smarty, [$navigation, $cc_nav, $staffcp_nav], $widgets, $template);

require(ROOT_PATH . '/core/templates/cc_navbar.php');
$template->onPageLoad();
require(ROOT_PATH . '/core/templates/navbar.php');
require(ROOT_PATH . '/core/templates/footer.php');

$template->displayTemplate('user/index');