Friday, September 20, 2024 4:21:37 AM
> settings

Customize


Authenticate

> _notification_configuration.html.erb
<div class="uk-margin-bottom">
    <h1 class="uk-margin-top">Notification Configuration for <strong class="esm-text-color-red">server admins</strong></h1>

    <p>
        <span class="uk-label uk-label-danger">Important</span> This feature is only available for communities that host servers <small>(Player mode disabled)</small>.
    </p>

    <p>Notification Configuration allows Servers to create/edit XM8 and Gambling Notifications for their Community.</p>
    <div uk-lightbox>
        <a href="/wiki/notification_configuration_help.png">
            <img src="/wiki/notification_configuration_help.png">
        </a>
    </div>

    <h2>Types</h2>
    <p>
        Exile Server Manager supports custom notifications for the following types:
    </p>
    <p>
        <strong>For XM8 Notifications:</strong>
        <ol class="uk-list uk-margin-left">
            <li>XM8 (Base Raid)</li>
            <li>XM8 (Flag Stolen)</li>
            <li>XM8 (Flag Restored)</li>
            <li>XM8 (Protection Money Due)</li>
            <li>XM8 (Protection Money Paid)</li>
            <li>XM8 (Charge Plant Started)</li>
            <li>XM8 (Grind Started)</li>
            <li>XM8 (Hack Started)</li>
            <li>XM8 (Flag Steal Started)</li>
            <li>XM8 (MarXet Item Sold)</li>
        </ol>
    </p>
    <p>
        <strong>For <code>!gamble</code></strong>
        <ol class="uk-list uk-margin-left">
            <li>Gambling (Win)</li>
            <li>Gambling (Loss)</li>
        </ol>
    </p>
    <p>
        <strong>For <code>!player</code></strong>
        <ol class="uk-list uk-margin-left">
            <li>Player (Money)</li>
            <li>Player (Locker)</li>
            <li>Player (Respect)</li>
            <li>Player (Heal)</li>
            <li>Player (Kill)</li>
        </ol>
    </p>

    <h2>Formatting</h2>
    <p>
        The notification's title and message both support "Mustache" syntax (double curly braces) and <a href="https://support.discordapp.com/hc/en-us/articles/210298617-Markdown-Text-101-Chat-Formatting-Bold-Italic-Underline-" target="_blank">Discord's Markdown</a>.
        <br>
        For example, if you wanted to include the Server's name, use <code>{{ serverName }}</code> in your message.
        <br>
        <span class="uk-label">Tip:</span> You can view the available variables for the message type by clicking "Supported Variables"
    </p>
    <p>
        <span class="uk-label uk-label-warning">Note:</span> Variable formatting is <u>case insensitive and ignores whitespace</u>. So long as you have the correct variable name surrounded by curly braces, it will accept it.
    </p>

    <h2>Colors</h2>
    <p>
        You may choose which color to have on the side of the notification. Along with the default colors used in ESM, you can choose "Custom" to pick a custom color, or "Random" to randomly choose one of the following colors each time the notification is sent.
    </p>
    <p>
        Below are the available colors and their HEX value:
        <ol class="uk-list uk-margin-left">
            <li>
                <a href="https://www.colorhexa.com/c62551" style="color: #C62551 !important">Red: #C62551</a>
            </li>
            <li>
                <a href="https://www.colorhexa.com/3ED3FB" style="color: #3ED3FB !important">Blue: #3ED3FB</a>
            </li>
            <li>
                <a href="https://www.colorhexa.com/9FDE3A" style="color: #9FDE3A !important">Green: #9FDE3A</a>
            </li>
            <li>
                <a href="https://www.colorhexa.com/DECA39" style="color: #DECA39 !important">Yellow: #DECA39</a>
            </li>
            <li>
                <a href="https://www.colorhexa.com/793ADE" style="color: #793ADE !important">Purple: #793ADE</a>
            </li>
            <li>
                <a href="https://www.colorhexa.com/DE3A9F" style="color: #DE3A9F !important">Pink: #DE3A9F</a>
            </li>
            <li>
                <a href="https://www.colorhexa.com/DE7839" style="color: #DE7839 !important">Orange: #DE7839</a>
            </li>
            <li>
                <a href="https://www.colorhexa.com/FFFFFF" style="color: #FFFFFF !important">White: #FFFFFF</a>
            </li>
        </ol>
    </p>

    <h2>Previewing</h2>
    <p>
        When creating/editing a notification, you will be given a (close) preview of the message as it were to appear to the Player. Variable values are, for the most part, randomly generated to give "realistic" looking previews. When you finish typing, ESM will automatically preview the message and replace any variables as needed.
    </p>

    <h2>Limits</h2>
    <p>
        ESM does not limit to how many notifications a server creates. When a notification is being built, ESM will randomly pick from the available notification templates.
    </p>
    <p>
        Discord, however, does impose a hard limit on how many characters the title/message has. These limits are displayed while editing, however, due to variable replacement, they may not be completely accurate. With that being said, if the title/message is over the limit, ESM will automatically truncate so the message will send.
    </p>
</div>
All opinions represented herein are my own
- © 2024 itsthedevman
- build 340fbb8