Minetrack/README.md

32 lines
1.5 KiB
Markdown
Raw Normal View History

### 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.
#### This project is not actively maintained!
This project and the offical website are not actively maintained anymore, but you are welcome to run your own instances of Minetrack.
I will however review and accept pull-requests, so please share any improvements you are making so everybody can benefit from them.
You can find a list of community hosted instances below:
* https://minetrack.me
Want to be listed here? Add yourself in a pull-request!
#### Try it out!
2016-07-05 19:11:09 +00:00
You can see an up-to-date copy of the production branch running on http://minetrack.me
2016-02-24 01:44:15 +00:00
"master" branch contains everything you need to start your own copy. "production" branch is what's used in the production environment of the minetrack.me site.
#### Usage
2016-02-01 10:41:04 +00:00
1. Make sure everything is correct in ```config.json```.
2. Add/remove servers by editing the ```servers.json``` file.
3. Run ```npm install```.
4. Run ```node app.js``` to boot the system (may need sudo!)
2015-11-09 07:50:45 +00:00
2015-12-11 04:06:27 +00:00
(There's also ```install.sh``` and ```start.sh```, but they may not work for your OS.)
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.