mercury.core.ts

The mercury.core.ts file is the main configuration file for Mercury Core. This file controls all aspects of your revival including branding, features, services, and default settings.

If you’re running in production, you’ll need to rebuild Mercury Core to apply changes to this file.

Basic Settings

Name

string

required

The name of your revival.

Name: "Mercury"

Domain

string

required

Your revival’s domain name.

Domain: "mercs.dev"

CurrencySymbol

string

required

The symbol for your revival’s currency. Placed before the amount.

CurrencySymbol: "屌"

Pages

array

required

Controls which optional pages on the site are enabled. This allows you to turn off unnecessary features for your revival.Available pages: "Statistics", "Groups", "Forum"

Pages: ["Statistics", "Forum", "Groups"]

Service URLs

DatabaseURL

string

required

The URL of your database server.

DatabaseURL: "http://localhost:8000"

RCCServiceProxyURL

string

required

The URL of your RCC proxy server. Requires a URL scheme.

RCCServiceProxyURL: "http://localhost:64990"

OrbiterPrivateURL

string

required

The URL of your Orbiter gameserver hoster, exposing the private API for use by the Site. Requires a URL scheme.

OrbiterPrivateURL: "http://localhost:64991"

OrbiterPublicDomain

string

required

The domain name of your Orbiter gameserver hoster, exposing the public API for use by a user’s browser.

OrbiterPublicDomain: "localhost:64992"

LauncherURI

string

required

The URI scheme to pass to the launcher when joining a game.

LauncherURI: "mercury-launcher:"

Default Body Colors

DefaultBodyColors

object

required

The default body colours for avatar creation, given to each new user on registration. Each colour is a BrickColor ID.

DefaultBodyColors: {
  Head: 24,
  LeftArm: 24,
  LeftLeg: 119,
  RightArm: 24,
  RightLeg: 119,
  Torso: 23,
}

Show Body color properties

DefaultBodyColors.Head

number

required

The default head colour.

DefaultBodyColors.LeftArm

number

required

The default left arm colour.

DefaultBodyColors.LeftLeg

number

required

The default left leg colour.

DefaultBodyColors.RightArm

number

required

The default right arm colour.

DefaultBodyColors.RightLeg

number

required

The default right leg colour.

DefaultBodyColors.Torso

number

required

The default torso colour.

Logging

object

required

Configuration for logging done by Mercury Core.

Logging: {
  Requests: true,
  FormattedErrors: false,
  Time: true,
}

Show Logging properties

Logging.Requests

boolean

required

Whether to log all incoming requests to dynamic pages.

Logging.FormattedErrors

boolean

required

Whether to format errors in a more readable way. This does not provide a full stack trace.

Logging.Time

boolean

required

Whether to log the time of each request.

Branding

object

required

Configuration for custom branding and icon file paths in the Assets directory.

Branding: {
  Favicon: "Branding/Favicon.svg",
  Icon: "Branding/Icon.svg",
  Tagline: "Revival tagline",
  Descriptions: {
    "Endless possibilites":
      "Create or play your favourite games and customise your character with items on our catalog.",
    "New features":
      "In addition to full client usability, additional features such as security fixes, QoL fixes and an easy to use website make your experience better.",
    "Same nostalgia":
      "All of our clients will remain as vanilla as possible, to make sure it's exactly as you remember it.",
  },
}

Show Branding properties

Branding.Favicon

string

required

Path to your revival’s favicon in the Assets directory. May be in any browser-supported format.

Branding.Icon

string

required

Path to your revival’s logo icon in the Assets directory. May be in any browser-supported format.

Branding.Tagline

string

required

A very short tagline for your revival. This is displayed in the footer as well as on the login and register pages.If set to an empty string, this does not display.

Branding.Descriptions

object

required

Descriptions for your revival’s features. These are displayed on the register page.Each description is a key-value pair, where the key is a feature’s title and the value is its description.

See the Branding page for more details.

Images

object

required

Configuration for image file paths in the Assets directory.

Images: {
  DefaultPlaceIcons: ["Images/DefaultIcon1.avif"],
  DefaultPlaceThumbnails: [
    "Images/DefaultThumbnail1.avif",
    "Images/DefaultThumbnail2.avif",
    "Images/DefaultThumbnail3.avif",
  ],
}

Show Image properties

Images.DefaultPlaceIcons

string[]

required

Array of paths for default place icons in the Assets directory. May be in any browser-supported format.

Images.DefaultPlaceThumbnails

string[]

required

Array of paths for default place thumbnails in the Assets directory. May be in any browser-supported format.

Themes

array

required

Configuration for the revival’s available themes. The first theme in the array will be the default theme.

Themes: [
  {
    Name: "Standard",
    Path: "Themes/Standard.css",
  },
]

Show Theme properties

Themes[].Name

string

required

The name of the theme.

Themes[].Path

string

required

Path to the theme’s CSS file in the Assets directory.

Text Filtering

Filtering

object

required

Configuration for basic text filtering for profanity.

Filtering: {
  FilteredWords: [],
  ReplaceWith: "#",
  ReplaceType: "Character",
}

Show Filtering properties

Filtering.FilteredWords

string[]

required

Array of words to naively filter out of text (where surrounded by whitespace). You may wish to pass this in from a package or JSON file.Set to a blank array to disable filtering.

Filtering.ReplaceWith

string

required

The character of which to replace filtered words with.

Filtering.ReplaceType

'Character' | 'Word'

required

How to replace filtered words, either by replacing each character or replacing the entire word with ReplaceWith.

Registration

object

required

Configuration for user registration.

Registration: {
  Keys: {
    Enabled: true,
    Prefix: "mercurkey-",
  },
  Emails: true,
}

Show Registration properties

Registration.Keys

object

required

Configuration for how registration keys are used and generated.

Show Keys properties

Registration.Keys.Enabled

boolean

required

Whether registration keys are enabled.

Registration.Keys.Prefix

string

required

Prefix for registration keys. This is used to identify keys generated by your revival.

Registration.Emails

boolean

required

Whether to ask for and require email addresses for registration.

Email

object

required

Configuration for sending emails.

Email: {
  Host: "smtp.example.com",
  Port: 587,
  Username: "username",
}

The email password should be configured in your environment variables as EMAIL_PASSWORD. See Environment Variables for details.

Show Email properties

Email.Host

string

required

The SMTP server host to use for sending emails.

Email.Port

number

required

The SMTP server port to use for sending emails.

Email.Username

string

required

The username to use for authentication with the SMTP server. The corresponding password should be configured in your environment variables.

Gameservers

object

required

Configuration for gameserver hosting.

Gameservers: {
  Hosting: "Both",
}

Show Gameserver properties

Gameservers.Hosting

'Selfhosted' | 'Dedicated' | 'Both'

required

The type of gameserver hosting to use.

Selfhosted: Only allow self-hosted game servers
Dedicated: Only allow dedicated game servers
Both: Allow both self-hosted and dedicated game servers

Example Configuration

export default {
  Name: "Mercury",
  Domain: "mercs.dev",
  DatabaseURL: "http://localhost:8000",
  RCCServiceProxyURL: "http://localhost:64990",
  OrbiterPrivateURL: "http://localhost:64991",
  OrbiterPublicDomain: "localhost:64992",
  LauncherURI: "mercury-launcher:",
  CurrencySymbol: "屌",
  Pages: ["Statistics", "Forum", "Groups"],

  DefaultBodyColors: {
    Head: 24,
    LeftArm: 24,
    LeftLeg: 119,
    RightArm: 24,
    RightLeg: 119,
    Torso: 23,
  },

  Logging: {
    Requests: true,
    FormattedErrors: false,
    Time: true,
  },

  Branding: {
    Favicon: "Branding/Favicon.svg",
    Icon: "Branding/Icon.svg",
    Tagline: "Revival tagline",
    Descriptions: {
      "Endless possibilites":
        "Create or play your favourite games and customise your character with items on our catalog.",
      "New features":
        "In addition to full client usability, additional features such as security fixes, QoL fixes and an easy to use website make your experience better.",
      "Same nostalgia":
        "All of our clients will remain as vanilla as possible, to make sure it's exactly as you remember it.",
    },
  },

  Images: {
    DefaultPlaceIcons: ["Images/DefaultIcon1.avif"],
    DefaultPlaceThumbnails: [
      "Images/DefaultThumbnail1.avif",
      "Images/DefaultThumbnail2.avif",
      "Images/DefaultThumbnail3.avif",
    ],
  },

  Themes: [
    {
      Name: "Standard",
      Path: "Themes/Standard.css",
    },
  ],

  Filtering: {
    FilteredWords: [],
    ReplaceWith: "#",
    ReplaceType: "Character",
  },

  Registration: {
    Keys: {
      Enabled: true,
      Prefix: "mercurkey-",
    },
    Emails: true,
  },

  Email: {
    Host: "smtp.example.com",
    Port: 587,
    Username: "username",
  },

  Gameservers: {
    Hosting: "Both",
  },
} satisfies import("./Assets/schema.ts").Config

Get Started

Installation

Core Concepts

Configuration

Features

Client Integration

Deployment

Basic Settings

Service URLs

Default Body Colors

Logging

Branding

Images

Themes

Text Filtering

Registration

Email

Gameservers

Example Configuration

Build docs developers (and LLMs) love

Get Started

Installation

Core Concepts

Configuration

Features

Client Integration

Deployment

​Basic Settings

​Service URLs

​Default Body Colors

​Logging

​Branding

​Images

​Themes

​Text Filtering

​Registration

​Email

​Gameservers

​Example Configuration

Build docs developers (and LLMs) love

Basic Settings

Service URLs

Default Body Colors

Logging

Branding

Images

Themes

Text Filtering

Registration

Email

Gameservers

Example Configuration