Jump to content
sale $39.99  $31.99

1 Screenshot

  • 1,405
  • 23
  • 15.79 kB
 Share

About Oxidation's Server Metadata

This is a server management plugin. It allows you to have consistency and visibility over all the information related with your server, including it's basic configuration. You may find this valuable no matter if you manage ONE or TEN servers, it works great with automation tools, docker and alike. It has four main features:

  1. Wipe schedule calculator
  2. Manages server information (Title, description, tags, logo, banner, etc)
  3. Manages the basic server configuration (cvars)
  4. Manages Oxide's groups, permissions and user membership.
  5. Loading messages when a player is joining and/or waiting in queue.

1. Wipe schedule calculator

The plugin provides four "tokens" that you can use within the server's title or description to inform your users when was the last wipe and when it will be the next wipe. You can customize the date format and wipe schedule on the config file and the wipe schedule calculator will have into account the Thursday forced wipe.

  // You can format the date as you'd like
  "Date": {
    "Short": "dd/MM",
    "Long": "dd/MM/yyyy"
  },
  // Wipe schedule value is in days
  "Server": {
    "Wipe schedule": 7
  },

2. Manages server information

This one is pretty self-explicatory, it allows you to define all the metadata about your server.

  "Server": {
    "Name": "DEVELOPMENT SERVER | %LASTWIPE%",
    "Description": [
      "Map size is %WORLDSIZE% using seed %WORLDSEED%.",
      "Last wipe was at %LASTWIPE_LONG%, Next wipe is at %NEXTWIPE_LONG%",
      "Server has %UPTIME% seconds uptime, running at %FPS% fps with %ONLINE%/%MAXSLOTS% players online."
    ],
    "Banner image": "https://assets.example.com/banner.jpg",
    "Logo image": "https://assets.example.com/logo.png",
    "Tags": [
      "weekly",
      "vanilla"
    ],
    "Website": "https://example.com/",
    "Custom map name": "kasvoton was here",
    "Wipe schedule": 7
  },

spacer.png

Notice the special feature "Custom map name" which allows you to customize the map name that is displayed on the server list (Procedural Map). This shows in not only at Rust's in-game server browser, but also all on all the other sites that show off your server, i.e. Battlemetrics. WE DO NOT REQUIRE OXIDE'S SANDBOX MODE TO BE TURNED OFF AS OTHER PLUGINS DO.

3. Manages the basic server configuration (cvars)

 It allows you to have a clear view of what cvars are applied, very helpful if you run automation tools such as docker or github to manage server configurations.

  "CVars": {
    "fps.limit": "32",
    "server.tickrate": "10",
    "server.censorplayerlist": "true",
    "server.maxplayers": "8",
    "env.time": "12",
    "env.progresstime": "false"
  },

4. Manages Oxide's groups, permissions and user membership.

When you define a group inside the plugin's config file it means that the plugin will make sure that the group is created, that the permissions are assigned and that the listed members are part of the group. You can (and should) assign users to your groups using the oxide's tools or any other third party plugin as usual, the only difference is that the members listed on this config file will always be added back to the groups even when manually removed.

  "Permissions": {
    "Delay": 60.0,
    "Groups": [
      {
        "Name": "admin",
        "Title": "Administrators",
        "Parent": "developer",
        "Rank": 0,
        "Default": false,
        "Permissions": [],
        "Members": []
      },
      {
        "Name": "default",
        "Title": "Default",
        "Parent": null,
        "Rank": 0,
        "Default": true,
        "Permissions": [],
        "Members": [
          "*"
        ]
      },
      {
        "Name": "developer",
        "Title": "Developer",
        "Parent": "administrator",
        "Rank": 800,
        "Default": false,
        "Permissions": [
          "plugin.e",
          "plugin.f"
        ],
        "Members": [
          "123456789123456789"
        ]
      },
      {
        "Name": "administrator",
        "Title": "Administrator",
        "Parent": "moderator",
        "Rank": 80,
        "Default": false,
        "Permissions": [
          "plugin.b",
          "plugin.c",
          "plugin.d"
        ],
        "Members": [
          "123456789123456789",
          "123456789123456789"
        ]
      },
      {
        "Name": "moderator",
        "Title": "Moderator",
        "Parent": "default",
        "Rank": 60,
        "Default": false,
        "Permissions": [
          "plugin.a"
        ],
        "Members": [
          "123456789123456789",
          "123456789123456789",
          "123456789123456789"
        ]
      }
    ]
  }

Note the important config parameter "Delay", when the server starts we have no way to tell in which order the plugins will get loaded by Oxide, which means that when OxidationMetadata loads it's probable that we will not be the last one getting loaded. If we try to assign a permission to a group but the third party plugin has not yet loaded then the permission is not found and we'll get an error. The "Delay" creates a waiting period for OxidationMetadata to wait for all other plugins to load and only then it tries to assign the permissions, the value of the delay is really dependent of your own server.

List of supported string format "tokens":

%FPS%           Average FPS value on the server
%MAXSLOTS%      Max number of players on the server
%ONLINE%        Total number of online players
%UPTIME%        Server uptime in seconds
%WORLDSEED%     Seed used to generate the world
%WORLDSIZE%     World size i.e. 3500

%LASTWIPE%      Last wipe date formatted in short form
%LASTWIPE_LONG% Last wipe date formatted in long form
%NEXTWIPE%      Next wipe date formatted in short form
%NEXTWIPE_LONG% Next wipe date formatted in long form

 

 Share


User Feedback

353.7k

Downloads

Total number of downloads.

1.8k

Customers

Total customers served.

24.4k

Files Sold

Total number of files sold.

379.5k

Payments Processed

Total payments processed.

×
×
  • Create New...

Important Information

We have placed cookies on your device to help make this website better. You can adjust your cookie settings, otherwise we'll assume you're okay to continue.