Fascinated/Minetrack
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

new README.md

Browse Source
This commit is contained in:
Nick Krecklow 2020-05-05 19:07:40 -05:00
parent b0e1f90ddb
commit 4c2c8492b8
No known key found for this signature in database
GPG Key ID: 5F149FDE156FFA94
1 changed files with 26 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -1,26 +1,36 @@
### Minetrack
Minetrack is a Minecraft PC/PE server tracker that lets you focus on what's happening *now*.
Built to be lightweight and durable, you can easily adapt it to monitor BungeeCord or server instances.
<p align="center">
<img width="120" height="120" src="assets/images/logo.svg">
</p>
#### Migrating to Minetrack 5
See our Minetrack 5 [migration guide](docs/MIGRATING.md).
# Minetrack
Minetrack makes it easy to keep an eye on your favorite Minecraft servers. Simple and hackable, Minetrack easily runs on any hardware. Use it for monitoring, analytics, or just for fun. [Check it out](https://minetrack.me).
#### This project is not actively supported!
This project and the offical website are not actively supported. Pull requests will be reviewed and merged (if accepted), but issues _might_ not be addressed outside of fixes provided by community members. Please share any improvements or fixes you've made so everyone can benefit from them.
### This project is not actively supported!
This project is not actively supported. Pull requests will be reviewed and merged (if accepted), but issues _might_ not be addressed outside of fixes provided by community members. Please share any improvements or fixes you've made so everyone can benefit from them.
### Features
- 🚀 Real time Minecraft server player count tracking with customizable update speed.
- 📝 Historical player count logging with 24 hour peak and player count record tracking.
- 📈 Historical graph with customizable time frame.
- 📦 Out of the box included dashboard with various customizable sorting and viewing options.
- 📱(Decent) mobile support.
- 🕹 Supports both Minecraft Java Edition and Minecraft Bedrock Edition.
- 🚨 [minecraft.net](https://minecraft.net) and [mojang.com](https://mojang.com) services status monitoring to watch for interruptions.
### Community Showcase
You can find a list of community hosted instances below. Want to be listed here? Add yourself in a pull request!
You can find a list of community hosted instances below:
* https://minetrack.me
* https://bedrock.minetrack.me
* https://trackedservers.com
Want to be listed here? Add yourself in a pull-request!
## Updates
For updates and release notes, please read the [CHANGELOG](docs/CHANGELOG.md).
#### Try it out!
You can see an up-to-date copy of the production branch running on https://minetrack.me
**Migrating to Minetrack 5?** See the [migration guide](docs/MIGRATING.md).
"master" branch contains everything you need to start your own copy. "prod" and "prod-bedrock" branches are what is used in the production environment of the minetrack.me sites.
#### Usage
1. Install Node 12.4.0+ (check your version with `node -v`)
## Installation
1. Node 12.4.0+ is required (you can check your version using `node -v`)
2. Make sure everything is correct in ```config.json```.
3. Add/remove servers by editing the ```servers.json``` file
4. Run ```npm install```
@ -31,6 +41,3 @@ You can see an up-to-date copy of the production branch running on https://minet
Database logging is disabled by default. You can enable it in ```config.json``` by setting ```logToDatabase``` to true.
This requires sqlite3 drivers to be installed.
#### What's being changed?
For the changelog, check out the [CHANGELOG](docs/CHANGELOG.md) file.