Skip to content

ChineseMarc/mc-player-counter

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mc-player-counter

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

Options

  • refreshRate - Rate that the counter will refresh.
  • 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, should be prefixed with data-playercounter-. E.g (data-playercounter-ip)

You can also 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@1.1.1/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 (Optional)

new PlayerCounter({
  element: element,
  ip: 'server ip',
  format: '{online}/{max}' // default {online}
  refreshRate: 1000 // default 5s (5000)
});

License

Copyright (C) 2017-2018 leonardosnt leonrdsnt@gmail.com
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%