Go to file
Kevin Belisle ad466ca35b Merge branch 'main' of https://git.birbmc.com/Klutz/Stonks into main 2021-07-19 02:58:16 -04:00
.vscode Initial commit 2021-06-25 15:13:25 -04:00
app Fix initial aggregates insert 2021-07-19 02:58:06 -04:00
gradle/wrapper Initial commit 2021-06-25 15:13:25 -04:00
spa Add aggregate statistics showcase to search view 2021-07-12 17:47:27 -04:00
test_data First functional version 2021-06-29 17:49:36 -04:00
.gitattributes Initial commit 2021-06-25 15:13:25 -04:00
.gitignore Add spa/build to .gitignore 2021-07-09 00:49:06 -04:00
LICENSE Add MIT License 2021-07-15 21:05:46 +00:00
README.md Fix readme.md typo 2021-07-06 23:00:25 -04:00
gradlew Initial commit 2021-06-25 15:13:25 -04:00
gradlew.bat Initial commit 2021-06-25 15:13:25 -04:00
settings.gradle.kts Initial commit 2021-06-25 15:13:25 -04:00

README.md

Stonks

Stonks is an app that tracks player statistics in a Minecraft world and makes them available via an API and a web interface.

Installation

Download the latest stonks.jar release, as well as the stonks.config.sample file. Copy both files to a folder on your server.

Edit the config file (see different configuration option below) and rename it to stonks.config.

Run Stonks from the command line:

java -jar .\stonks.jar

Profit!

Config file

databaseBaseDir=./databases
databaseName=statistics
h2StartWebServer=false
h2tWebServerPort=8082
h2TcpServerPort=9092
apiServerPort=7000
statisticsUpdateInterval=900000
minecraftStatsFolder=./saves/world1/stats

databaseBaseDir

This is the relative path to where Stonks will store it's database files.

databaseName

This is the name of the database Stonks will use.

h2StartWebServer and h2tWebServerPort

If set to true, this will start a web interface to view the contents of the database, available at localhost:{h2tWebServerPort}.

h2TcpServerPort

This is the port the database's TCP port will be available at, used internally.

apiServerPort

This is the port on which the Stonks web interface and JSON API will be available at.

statisticsUpdateInterval

The frequency, in ms, at which the statistics will be updated.

minecraftStatsFolder

The path to Minecraft's stats folder.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.