https://github.com/loganintech/better-allowlist

A better allowlist for TShock
https://github.com/loganintech/better-allowlist

Last synced: 20 days ago
JSON representation

A better allowlist for TShock

• Host: GitHub
• URL: https://github.com/loganintech/better-allowlist
• Owner: loganintech
• Created: 2023-07-24T01:27:14.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-07-24T07:51:24.000Z (over 1 year ago)
• Last Synced: 2024-10-14T17:55:07.746Z (24 days ago)
• Language: C#
• Size: 11.7 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Better Allowlist

The Better Allowlist is a plugin for TShock that allows you to manage a list of allowed players based on their IP, UUID, or Character Name, or any combination of these criteria.

## Command Reference

- **Add**: Adds a player's IP, UUID, Name, or all 3 to the allowlist.

  ```

  /allowlist add [ip/uuid/name/all] 

  ```

- **Remove**: Remove a player from the allowlist using their name.

  ```

  /allowlist remove 

  ```

- **Reload**: Reload the allowlist from the file.

  ```

  /allowlist reload

  ```

- **List**: View all players currently on the allowlist.

  ```

  /allowlist list

  ```

- **Enable / Disable**: Enable or disable the allowlist as needed.

  ```

  /allowlist [enable/disable]

  ```

## Example Configuration

Below is an example of the configuration file, `allowlist-config.json`:

```json5

{

  "enabled": true,

  "allowList": [

    {

      // Only IP

      "ip": ""

    },

    {

      // Only UUID

      "uuid": ""

    },

    {

      // Only Name

      "name": ""

    },

    {

      // All 3 criteria required for access

      "ip": "127.0.0.1",

      "uuid": "SOMEVERYLONGSTRINGOFCHARACTERSANDNUMBERSHERE",

      "name": "loganintech"

    }

  ],

  "removalReason": "You are not on the allowlist."

}

```

With the Better Allowlist plugin, managing access to your TShock server becomes more convenient and flexible. By utilizing IPs, UUIDs, and Character Names, or any combination of these, you can efficiently control who can join your server.