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

Update the README concerning changes.

Browse Source
This commit is contained in:
Cryptkeeper 2016-02-01 04:41:04 -06:00
parent 878fe6496b
commit ff99e1a828
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -6,9 +6,10 @@ Built to be lightweight and durable, you can easily adapt it to monitor BungeeCo
You can see an up-to-date copy of the master branch running on http://minetrack.me You can see an up-to-date copy of the master branch running on http://minetrack.me
#### Usage #### Usage
1. Customize it by editing the ```config.json``` file. 1. Make sure everything is correct in ```config.json```.
2. Run ```npm install```. 2. Add/remove servers by editing the ```servers.json``` file.
2. Run ```node app.js``` to boot the system (may need sudo!) 3. Run ```npm install```.
4. Run ```node app.js``` to boot the system (may need sudo!)
(There's also ```install.sh``` and ```start.sh```, but they may not work for your OS.) (There's also ```install.sh``` and ```start.sh```, but they may not work for your OS.)
@ -18,6 +19,10 @@ This requires sqlite3 drivers to be installed.
#### How do I get added? #### How do I get added?
At the moment, the main "minetrack.me" site is only accepting networks that average roughly 1,000 players at peak for **PC** servers, and 100 players at peak for **PE** servers. This is due to limited capacity and it's functionality. If you fit this description, you're welcome to open a Pull Request adding the network to ```config.json```. At the moment, the main "minetrack.me" site is only accepting networks that average roughly 1,000 players at peak for **PC** servers, and 100 players at peak for **PE** servers. This is due to limited capacity and it's functionality. If you fit this description, you're welcome to open a Pull Request adding the network to ```config.json```.
Minetrack is designed to be flexible, you're more than welcome to fork/clone it and start your own listing focusing on different networks.
*Smaller networks currently listed have been grandfathered in.*
#### TODO #### TODO
- Add public API (similiar to old server.json) - Add public API (similiar to old server.json)
- Add ingame server, similiar to old mc.minetrack.me - Add ingame server, similiar to old mc.minetrack.me