Metadata-Version: 2.0
Name: piqueserver
Version: 0.1.0.post2
Summary: Open-Source server implementation for Ace of Spades
Home-page: https://github.com/piqueserver/piqueserver
Author: noway421
Author-email: noway@2ch.hk
License: GNU General Public License v3
Download-URL: https://github.com/piqueserver/piqueserver/archive/0.1.0.zip
Description-Content-Type: UNKNOWN
Keywords: ace of spades,aos,server,pyspades,pysnip,piqueserver
Platform: Darwin
Platform: Unix
Classifier: Intended Audience :: System Administrators
Classifier: Development Status :: 3 - Alpha
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Unix
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Cython
Classifier: Programming Language :: Python :: 2 :: Only
Classifier: Framework :: Twisted
Requires-Dist: Cython (<1,>=0)
Requires-Dist: Twisted (>=17)
Requires-Dist: Jinja2 (<3,>=2)
Requires-Dist: Pillow (<5,>=3)
Requires-Dist: pyenet
Requires-Dist: ipaddr
Provides-Extra: from
Requires-Dist: pygeoip (<0.4,>=0.3.2); extra == 'from'
Provides-Extra: ssh
Requires-Dist: pycrypto (<2.7,>=2.6.1); extra == 'ssh'
Requires-Dist: cryptography (<3.0,>=2.0.0); extra == 'ssh'
Requires-Dist: pyasn1 (<0.2,>=0.1.9); extra == 'ssh'

piqueserver |Build Status| |Join the chat at https://gitter.im/piqueserver/piqueserver|
=======================================================================================

An Ace of Spades 0.75 server based on
`PySnip <https://github.com/NateShoffner/PySnip>`__.

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

pip (stable version)
~~~~~~~~~~~~~~~~~~~~

.. code:: bash

    pip install piqueserver

to install with the optional ssh server

.. code:: bash

    pip install piqueserver[ssh]

git (bleeding edge)
~~~~~~~~~~~~~~~~~~~

.. code:: bash

    git clone https://github.com/piqueserver/piqueserver
    virtualenv2 venv
    source venv/bin/activate
    pip install -r requirements.txt
    python setup.py install

Archlinux
~~~~~~~~~

An `AUR package <https://aur.archlinux.org/packages/piqueserver-git/>`__
(git master) is available. Install manually or with your favourite AUR
helper:

.. code:: bash

    pacaur -y piqueserver-git

Running
-------

Then copy the default configuration as a base to work off

.. code:: bash

    piqueserver --copy-config

A-a-and lift off!

.. code:: bash

    piqueserver

Custom config location
~~~~~~~~~~~~~~~~~~~~~~

If you wish to use a different location to ``~/.config/piqueserver/``
for config files, specify a directory with the ``-d`` flag:

.. code:: bash

    piqueserver --copy-config -d custom_dir
    piqueserver -d custom_dir

FAQ
---

What's the purpose?
^^^^^^^^^^^^^^^^^^^

The purpose of this repo is to be a continuation of PySnip.

What if PySnip development returns?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Then they would merge our changes and development would be continued
there, I guess. The important thing is to keep AoS servers alive.

Why should I use piqueserver instead of PySnip/PySpades?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

-  Multi config installation
-  Docker support
-  Bug fixes
-  Improvements
-  Better anti-hacking
-  New scripts

What about 0.76 support
^^^^^^^^^^^^^^^^^^^^^^^

Working with multiple versions is a pain. 0.76 will be suported in the
future only.

Is that everything?
^^^^^^^^^^^^^^^^^^^

Please see also the `original
README <https://github.com/piqueserver/piqueserver/blob/master/OLD_README.md>`__
from PySnip and the
`Wiki <https://github.com/piqueserver/piqueserver/wiki>`__ for more
information.

Contribute
----------

Don't be shy and submit us a PR or an issue! Help is always appreciated

Development
-----------

Use ``pip`` and ``virtualenv`` to setup the development environment:

.. code:: bash

    $ virtualenv -p python2 venv && . ./venv/bin/activate
    (venv) $ pip install -r requirements.txt
    (venv) $ ./setup.py install
    (venv) $ deactivate # Deactivate virtualenv

--------------

Brought to you with by the `piqueserver
team <https://github.com/orgs/piqueserver/people>`__.

.. |Build Status| image:: https://travis-ci.org/piqueserver/piqueserver.svg?branch=master
   :target: https://travis-ci.org/piqueserver/piqueserver
.. |Join the chat at https://gitter.im/piqueserver/piqueserver| image:: https://badges.gitter.im/piqueserver/piqueserver.svg
   :target: https://gitter.im/piqueserver/piqueserver?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge


