Squadmin is an administrative tool for Squad servers, providing integrations, automation, logging, and easy web-based administration. If you are already familiar with administrating Squad servers, think of Squadmin as a new, hosted SquadJS with an easy-to-use web user interface and integrations that play nice with your existing tooling.

Squadmin entered open beta on 24 January, 2025! All communities are welcome to sign up and try out Squadmin! For more details join our Discord and see this post in announcements.

Join us in Discord!

Feature Highlights

Squadmin Modules

When you first connect your Squad server to Squadmin nothing happens. You will see a list of modules other Squadmin users have created and published, and you can pick-and-choose which modules to install. You click a button to install a module, click a button to enable the module, and now you have additional fancy features for your Squad server.

Know a competent programmer and want more features? Squadmin modules are written in lua, specifically luau, the same programming language that powers Roblox. You can write and deploy your own custom modules. All of the hard stuff is already done for you!

Examples of existing modules deployed in production now are:

• Automated squad baiting detection, and prevention of flagged squad baiters creating new squads.
• In-game notifications when admins enter/exit admin cam.
• Type !note playerName some text here in-game and a note is automatically posted to the player's Battlemetrics profile.
• Likewise type !notes playerName and receive up to the last five most recent player notes from Battlemetrics.
• ... and more!

What Does a Squadmin Module Look Like?

Take a look at a simple module which kicks a player and adds a note to their Battlemetrics profile triggered on !kick playerName a kick message:

local MODULE = {}

  ---@param chat_message SquadChatMessage
  function MODULE.on_chat_message(chat_message)
      local sender = chat_message.steam_id:squad_player()
      if sender == nil then
          return
      end
  
      local name, message = string.match(chat_message.message, "^!kick (%g+) (.+)")
      if name ~= nil then
          --  Make sure the user who sent this message has the warn permission
          if not sender:has_permission(KICK_PERMISSION) then
              sender:warn("You do not have permission to do that")
              return
          end
  
          local target_player = SERVER:match_player_name(name, sender)
          if target_player == nil then
              return
          end
  
          target_player:kick(message)
          local battlemetrics_user = target_player:battlemetrics_user()
          local note = string.format(
              "%s kicked player with the following reason:\n%s",
              chat_message.name,
              message
          )
          battlemetrics_user:add_note(note)
  
          sender:warn(
              "Player was kicked and a note was added to their battlemetrics profile"
          )
  
          local audit_message = string.format(
              "%s kicked %s with message %s",
              chat_message.name, target_player.name, message
          )
          SERVER:audit_log(audit_message, {
              sender:player(),
              target_player:player()
          })
      end
  end
  
  KICK_PERMISSION = ModuleDefinedPermission.new(
      "In-Game Kick Permissions",
      "Users with this permission can use the in-game !kick command"
  )
  
  MODULE.permissions = {
      KICK_PERMISSION
  }
  
  return MODULE