Metadata-Version: 2.1
Name: nekoyume
Version: 0.1.0
Summary: Decentralized MMORPG based on Dungeon World
Home-page: https://github.com/nekoyume/nekoyume
Author: JC Kim
Author-email: jc@nekoyu.me
License: LICENSE.txt
Project-URL: Bug Reports, https://github.com/nekoyume/nekoyume/issues
Project-URL: Funding, https://nekoyu.me/
Project-URL: Source, https://github.com/nekoyume/nekoyume/
Keywords: blockchain mmorpg game
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Other Audience
Classifier: Topic :: Database :: Database Engines/Servers
Classifier: Topic :: Games/Entertainment :: Role-Playing
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Provides-Extra: dev
Provides-Extra: test
Requires-Dist: bencode.py (<2.1.0,>=2.0.0)
Requires-Dist: blinker (<1.5,>=1.4)
Requires-Dist: celery (<4.2.0,>=4.1.0)
Requires-Dist: click (<7.0,>=6.7)
Requires-Dist: cykeccak (<0.14.0.0,>=0.13.2.2)
Requires-Dist: Flask (<0.13.0,>=0.12.2)
Requires-Dist: Flask-Babel (<0.12.0,>=0.11.2)
Requires-Dist: Flask-Caching (<1.5.0,>=1.4.0)
Requires-Dist: Flask-SQLAlchemy (<2.4.0,>=2.3.2)
Requires-Dist: gevent (==1.3.5)
Requires-Dist: gunicorn (>=19.9.0)
Requires-Dist: psycopg2 (<2.8.0,>=2.7.5)
Requires-Dist: ptpython (==0.41)
Requires-Dist: pytz (>=2018.3)
Requires-Dist: raven (==6.9.0)
Requires-Dist: redis (<2.11.0,>=2.10.6)
Requires-Dist: requests (<2.19.0,>=2.18.4)
Requires-Dist: coincurve (<8.1.0,>=8.0.2)
Requires-Dist: SQLAlchemy (<1.3.0,>=1.2.2)
Requires-Dist: tablib (<0.13.0,>=0.12.1)
Provides-Extra: dev
Requires-Dist: flake8 (<3.6.0,>=3.5.0); extra == 'dev'
Requires-Dist: recommonmark (==0.4.0); extra == 'dev'
Requires-Dist: Sphinx (<1.8.0,>=1.7.1); extra == 'dev'
Requires-Dist: sphinx-rtd-theme (==0.2.4); extra == 'dev'
Provides-Extra: test
Requires-Dist: pytest (<3.5.0,>=3.4.2); extra == 'test'
Requires-Dist: pytest-localserver (<0.5,>=0.4.1); extra == 'test'
Requires-Dist: codecov (<2.1.0,>=2.0.15); extra == 'test'


Nekoyume
========

|build| |coverage| |pypi| |chat| |gitter|

Nekoyume is the first `MMORPG <https://en.wikipedia.org/wiki/Massively_multiplayer_online_role-playing_game>`_ based on `blockchain <https://en.wikipedia.org/wiki/Blockchain>`_.


* Nekoyume is entirely decentralized MMORPG game.
* Nekoyume uses `Dungeon World <https://en.wikipedia.org/wiki/Dungeon_World>`_ as a basic rule.
* To achieve randomness on the blockchain, this project implements Hash random. (Read `white paper <//docs.nekoyu.me/white_paper.html>`_ for details.)

Dependencies
------------

* `Python <http://python.org/>`_ >= 3.6
* `SQLite <https://www.sqlite.org/>`_ >= 3.16.0
* `gmp <https://gmplib.org/>`_
* (Recommended) `PostgreSQL <https://www.postgresql.org/>`_ >= 9.5
* (Recommended) `Redis <https://redis.io/>`_

Installation
------------

Installation to local environment
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: console

   $ pip install nekoyume
   $ nekoyume init

Installation to Heroku
^^^^^^^^^^^^^^^^^^^^^^^
|deploy|

Installation for development
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: console

   $ git clone git@github.com:nekoyume/nekoyume.git
   $ cd nekoyume
   $ virtualenv -p $(which python3.6) .env
   $ . .env/bin/activate
   $ pip install -e .[dev,test]
   $ nekoyume init


Launching node
--------------

.. code-block:: console

   $ pip install honcho
   $ curl https://raw.githubusercontent.com/nekoyume/nekoyume/master/Procfile > Procfile
   $ PORT=5000 honcho start



Mining
------

.. code-block:: console

   $ nekoyume neko


.. |build| image:: https://circleci.com/gh/nekoyume/nekoyume.svg?style=shield&circle-token=fb83e926d78b99e4cda9788f3f3dce9e281270e3
    :target: https://circleci.com/gh/nekoyume/nekoyume

.. |coverage| image:: https://codecov.io/gh/nekoyume/nekoyume/branch/master/graph/badge.svg?token=VaVMWbOpm7
  :target: https://codecov.io/gh/nekoyume/nekoyume

.. |pypi| image:: https://img.shields.io/pypi/v/nekoyume.svg
  :target: https://pypi.org/project/nekoyume/

.. |chat| image:: https://img.shields.io/badge/chat-on%20telegram-brightgreen.svg
  :target: https://t.me/nekoyume

.. |deploy| image:: https://www.herokucdn.com/deploy/button.svg
  :target: https://heroku.com/deploy

.. |gitter| image:: https://badges.gitter.im/gitterHQ/gitter.png
  :target: https://gitter.im/nekoyume-dev


