Skip to content

Commit

Permalink
Actualized README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MEDVEDx64 authored Jan 10, 2022
1 parent 943f815 commit c1b8977
Showing 1 changed file with 14 additions and 10 deletions.
24 changes: 14 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,38 +3,42 @@
***
*Disclaimer. This stuff may not be suitable for you, because
it is initially were written for my own Minecraft server.
It is quite possible that you will need to change something in the code.*
It is quite possible that you will need to edit the code to fit your server setup.*
***
*Disclaimer #2. FunkyStore may become a reason of your Minecraft server crash.*
***
*Disclaimer #3. The code is **BAD**, please, never write web applications that way.*
***

This is an online in-game item store for vanilla Minecraft servers.
It DOES NOT deals with real money, there are an internal
It is NOT about real money, there are an internal
pseudo-currency called Funks is used to buy things.
FunkyStore includes .schematiic file format printer feature,
that allows to print buildings (etc.) directly to server's world.

Requirements
------------

* Vanilla Minecraft >= 1.7 server with configured RCON
* **Python 2.7**
* Vanilla Minecraft >= 1.18 server with configured RCON
* MongoDB and pymongo
* PyYaml
* [pymclevel](https://github.com/mcedit/pymclevel) and it's dependencies
* [MCRcon](https://github.com/barneygale/MCRcon)

*RockMongo* web interface installation is recommended.
* [MCRcon](https://github.com/barneygale/MCRcon) (checkout to 149b9c1)

Getting it working
------------------

* Copy `config_default.py` to `config.py` and edit it;
* Run `./first_run.py`;
* Run `./funky.py`.

* Set up `./funky.py` to run as a system service or run it directly.

Becoming an administrator
-------------------------

* Register an account
* Append "admin" string to "flags" field of your account entry from collection "funky". It can be achieved by executing the following code in mongo console: `db.accounts.update({}, {"$push":{"flags": "admin"}})`

Markerplace definition example
------------------------------

Marketplaces has no implementation in FunkyStore's admin console
and have to be pushed into `markets` collection manually. See [an example](market_example.json).

0 comments on commit c1b8977

Please sign in to comment.