Skip to content

nahkd123/stonks

Repository files navigation

Stonks Banner

Stonks

Build Status Badge License Badge Dynamic Version Badge Minecraft Version Badge

Weird little stocks/items market for block game.

Get Stonks (for Fabric)

Releases

All releases can be found in Releases page.

Development builds

You can grab development builds here. Click on latest workflow run, scroll down to Artifacts section and click on Fabric Artifacts to download. Then copy stonks-fabric-[MOD VERSION]+[GAME VERSION].jar to your mods/ folder/directory.

Small note: The link above includes filter for success development builds only. Click on "Actions" tab to see everything.

Documentations

For documentations, please see here. Documentations are maintained in docs/<version> branches.

Contributing

All contributions are welcomed! This includes code, documentations, finding bugs and even helping other people using Stonks!

Please take a look at Code of Conduct before contributing to this project.

tl;dr: be nice in general.

After that, see Contributing guide to get started.

A story behind the version 2

Most people doesn't know this, but Stonks was originally created as a Bukkit plugin. It was created to showcase the FeatherPowder's capability, but ended up abandoning it because the code base is too hard to maintain.

The first Stonks for Fabric port (let's call this "Stonks 1.1") was released under PhoMC organization. This one includes MongoDB support, but then I realized SQL databases are the better candidate for storing players' offer data.

And now we have Stonks 2.0! I decided to go for "local first" - storing all data locally before adding SQL support to the mod/plugin. I also decided to separate the market logic (core subproject) and mod + plugin front-end (fabric and bukkit subprojects) so other people can use Stonks Core for their "virtual market", like stocks market training platform for example, while keeping "Stonks for Fabric" and "Stonks for Bukkit".