Skip to main content

List the player usernames that have signed to a Minecraft server lately

Project description

Minecraft Server Player List

Quick script that generates a list of recent players on your server, sorted in order of who last logged in. Works by looking at the last modified time of their player.dat files in <server root>/world/playerdata, and resolving those UUIDs to a playername using Mojang's API.

Caching

Optionally, you can write out the usernames to a cache file (to prevent API rate limiting) using the --cache-file option. Usernames will only be looked up again after 120s.

Usage

$ mc_players -h
usage: mc_players [-h] [--out OUT] [--cache-file CACHE_FILE] [--cache-expiry CACHE_EXPIRY] [--html] [-n N] [--servername SERVERNAME] worldpath

Generate a list of recent players on a minecraft server.

positional arguments:
  worldpath             Path to the world folder to scan (eg <server_root>/world)

options:
  -h, --help            show this help message and exit
  --out OUT             Path to output file, defaults to stdout
  --cache-file CACHE_FILE
                        Path to cache file (created if not exists) to prevent rate limiting
  --cache-expiry CACHE_EXPIRY
                        Look up usernames that haven't been looked up in n seconds
  --html
  -n N                  Only return the last n usernames, default all
  --servername SERVERNAME
                        Server name for use in output

Example Output

Plain Text

$ python3 playerlist.py  /opt/mc/world
Players last seen on server
=================================================
1                Bob    Mon Oct 05 2020, 11:01 PM
2                Dan    Mon Oct 05 2020, 10:28 PM
3             George    Mon Oct 05 2020, 03:06 PM

HTML

$ python3 playerlist.py --html /opt/mc/world

<html>
  <head>
    <!-- generated with github.com/jaydenmilne/minecraft-server-player-list -->
    <title>server players</title>
    <meta name='viewport' content='width=device-width, initial-scale=1.0'>
  </head>
  <body>
    <h1>Players on server</h1>
    <table>
      <tr><th>Place</th><th>Player</th><th>Last Seen</th></tr>
      <tr><td>1<td>Bob</td><td>Tue Oct 06 2020, 07:33 PM</td></tr>
      <tr><td>2<td>Dan</td><td>Tue Oct 06 2020, 07:06 PM</td></tr>
      <tr><td>3<td>George</td><td>Tue Oct 06 2020, 06:39 PM</td></tr>
    </table>
  </body>
</html>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mc_players-2.1.1.tar.gz (17.1 kB view hashes)

Uploaded Source

Built Distribution

mc_players-2.1.1-py3-none-any.whl (17.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page