Wulf
Provides name and chat command password protection for the server

Supported Games
works with

Password offers a couple methods to require players to enter a password to connect or play on a server. The players can either provide a password via their Steam Friends name which is checked on connection (fastest method), or by using the 'password' chat or console command after they've connected (slower method). The command is the default method, as the name method isn't as easy to understand.

When using the command method, players are unable to chat or see chat from others until they are authorized, which they're given 3 password attempts (configurable) before being kicked. Players can also be optionally frozen to prevent movement until they are authorized as well. There is a default grace period of 30 seconds (configurable) before players are kicked.

Note: The 'password' command is only used if the name check is disabled or if they're not already authorized. All players currently on the server when the plugin is loaded will be automatically authorized, and will remain authored until the server is restarted so no repeat password checks are needed.

Also keep in mind that when setting a password for use with the name method, it's recommended to keep the password something that isn't obviously a password as it would then appear to be more of a tag. Ex." Wulf @ uMod" doesn't look like a password.

Permissions

  • password.bypass -- Allows player bypass password check

Commands

This plugin offers both chat and console commands. When using a command chat, prefix with a forward slash: /.

  • password <password>
    Attempt to use a password; replace <password> with the attempted server password
  • server.password <password>
    Set a new password; replace <password> with the new server password to set (admin only)
  • server.password
    Show the current server password (admin only)

Configuration

{
  "Server password": "umod",
  "Maxium password attempts": 3,
  "Grace period (seconds)": 60,
  "Always check for password on join": true,
  "Ask for password in chat": true,
  "Check for password in names": true,
  "Freeze unauthorized players": true,
  "Mute unauthorized players": true
}

Localization

For Developers

Hooks

void OnPasswordAccepted(string playerName, string playerId)

Possible Conflicts

  • Caps No Caps, No Green, Right To Left, UFilter, and any other plugin that customizes the chat. Plugins compatible with Better Chat shouldn't have an issue.

MIT License, with distribution exclusivity for uMod.org


Copyright (c) 2020 Wulf


Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:


The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.


THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.