Skip to content

Displays the number of online players of your Minecraft Server in your website using 2 lines of HTML.

License

Notifications You must be signed in to change notification settings

Fabelz/mc-player-counter

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mc-player-counter

Displays the number of online players in your Minecraft Server using 2 lines of HTML.

Options

  • refreshRate - The rate that the counter will refresh (1m by default. Note that https://mcapi.us/ has a 5 minute cache.)
  • format - Format that the counter will be displayed
    • {max} - Maximum players
    • {online} - Online players
  • ip - Server IP. E.g (mc.hypixel.net), with port (mc.hypixel.net:25565)
  • element - Element that the counter will be rendered in.

In HTML, the attributes should be prefixed with data-playercounter-. E.g (data-playercounter-ip)

It's also possible to display the server status by adding the attribute data-playercounter-status. It will display "online" or "offline". See example

Demo

Usage:

HTML

<!DOCTYPE html>
<html>
  <head>
    <!-- ... -->
    <script src="https://cdn.jsdelivr.net/gh/leonardosnt/mc-player-counter/dist/mc-player-counter.min.js"></script>
  </head>
  <body>
    There are <span data-playercounter-ip="my.server.ip">0</span> players online on my server.
  </body>
</html>

JS ("API")

new PlayerCounter({
  element: element,
  ip: 'server ip',
  format: '{online}/{max}' // default {online}
  refreshRate: 60 * 1000 // default 1m
});

License

Copyright (C) 2017-2019 leonardosnt [email protected]
Licensed under the MIT License. See LICENSE file in the project root for full license information.

About

Displays the number of online players of your Minecraft Server in your website using 2 lines of HTML.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%