An Ace of Spades 0.75 server based on PySnip.
An Ace of Spades 0.75 server based on
PySnip <https://github.com/NateShoffner/PySnip>
__.
#piqueserver:matrix.org
(Riot Webchat link <https://riot.im/app/#/room/#piqueserver:matrix.org>
__)this invite link <https://discord.gg/w6Te7xC>
__this invite link <https://join.slack.com/t/piqueserver/shared_invite/enQtMjg5MDI3MTkwNTgxLTNhMDkyNDRkNzhiNmQyYjRkOTdjNGNkYzNhNTQ4NzZkY2JhZjQxYzIyMTQ0Y2JlYTI2ZGFjMTFmNjAwZTM2OGU>
__#piqueserver
on freenode.net
(web <http://webchat.freenode.net/?channels=%23piqueserver>
__)All of these are bridged <https://matrix.org/docs/guides/faq.html#what-is-matrix>
__ together!
Requirements
Piqueserver requires python 3.7 and above
We currently provide builds for:
- Linux x86_64
- Windows x86 and x86_64
If your system is not one of the above, you will also need a recent C++ Compiler.
pip (stable version)
.. code:: bash
pip3 install piqueserver
Optional features:
ssh
: enable ssh manhole server supportfrom
: enable the from
command to geolocate players by ipTo install with optional features with pip:
.. code:: bash
pip3 install piqueserver[ssh,from]
git (bleeding edge)
.. code:: bash
git clone https://github.com/piqueserver/piqueserver
cd piqueserver
python3 -m venv venv
source venv/bin/activate
# note: requirements.txt includes all optional deps too
pip install -r requirements.txt
python setup.py install
# now `piqueserver` will be available on the $PATH when venv active
Arch Linux
~~~~~~~~~~
The `AUR package <https://aur.archlinux.org/packages/piqueserver-git/>`__
(git master) is currently broken. When it gets repaired (you can help!),
you'll be able to install manually or with your favourite AUR helper:
.. code:: bash
pacaur -S piqueserver-git
\:rocket: 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
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
`Online Documentation <https://piqueserver.readthedocs.io/en/latest/>`__ for more
information (readthedocs.io has replaced our wiki).
Where can i find more scripts?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can checkout the `Piqueserver Extras Repository <https://github.com/piqueserver/piqueserver-extras>`__, that contains scripts made by the community and ports from PySnip/PySpades script.
Or in community forums, such as:
`aloha.pk <https://aloha.pk/c/aos-modding/scripts/83>`__ and `BuildAndShoot <https://www.buildandshoot.com/forums/viewforum.php?f=19>`__
\:blush: Contribute
-------------------
Don't be shy and submit us a PR or an issue! Help is always appreciated
\:wrench: Development
---------------------
Use ``python3`` and ``pip`` to setup the development environment:
.. code:: bash
$ python3 -m venv venv && source venv/bin/activate
(venv) $ pip install -r requirements.txt
(venv) $ pip install -r dev-requirements.txt # includes dev tools
(venv) $ python setup.py develop # install in-place
(venv) $ deactivate # Deactivate virtualenv
--------------
Brought to you with :heart: by the `piqueserver
team <https://github.com/orgs/piqueserver/people>`__.
.. |Build Status| image:: https://github.com/piqueserver/piqueserver/actions/workflows/main.yml/badge.svg?branch=master
:target: https://github.com/piqueserver/piqueserver/actions/workflows/main.yml
.. |Wheel Status| image:: https://github.com/piqueserver/piqueserver/actions/workflows/wheels.yml/badge.svg?branch=master
:target: https://github.com/piqueserver/piqueserver/actions/workflows/wheels.yml
.. |Coverage Status| image:: https://coveralls.io/repos/github/piqueserver/piqueserver/badge.svg?branch=master
:target: https://coveralls.io/github/piqueserver/piqueserver?branch=master
.. |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