piqueserver |Build Status| |Wheel Status| |Coverage Status|
===========================================================
An Ace of Spades 0.75 server based on
`PySnip <https://github.com/NateShoffner/PySnip>`__.
\:point_right: Chat with us!
----------------------------
- Gitter: |Join the chat at https://gitter.im/piqueserver/piqueserver|
- Matrix: ``#piqueserver:matrix.org`` (`Riot Webchat
link <https://riot.im/app/#/room/#piqueserver:matrix.org>`__)
- Discord: Join with `this invite link <https://discord.gg/w6Te7xC>`__
- Slack: Join with `this invite link <https://join.slack.com/t/piqueserver/shared_invite/enQtMjg5MDI3MTkwNTgxLTNhMDkyNDRkNzhiNmQyYjRkOTdjNGNkYzNhNTQ4NzZkY2JhZjQxYzIyMTQ0Y2JlYTI2ZGFjMTFmNjAwZTM2OGU>`__
- IRC: (disabled due to spam) ``#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!
\:tada: Features
----------------
- Many administrator features
- A lot of epic commands
- A remote console (using SSH)
- Map rotation
- Map metadata (name, version, author, and map configuration)
- Map extensions (water damage, etc.)
- A map generator
- An IRC client for managing your server
- A JSON query webserver
- A status server with map overview
- Server/map scripts
- Airstrikes
- Melee attacks with the pickaxe
- New gamemodes (deathmatch / runningman)
- Rollback feature (rolling back to the original map)
- Spectator mode
- Dirt grenades
- Platforms with buttons
- Ban subscribe service
- A ton of other features
\:rocket: Installation
----------------------
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 support
- `from`: enable the `from` command to geolocate players by ip
To 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
\:speech_balloon: 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
`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
Raw data
{
"_id": null,
"home_page": "https://github.com/piqueserver/piqueserver",
"name": "piqueserver",
"maintainer": "noway421",
"docs_url": null,
"requires_python": ">=3.7.0",
"maintainer_email": "noway@2ch.hk",
"keywords": "ace of spades,aos,server,pyspades,pysnip,piqueserver",
"author": "Originally MatPow2 and PySnip contributors,now, StackOverflow and piqueserver authors",
"author_email": "nate.shoffner@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/86/20/f08d35d4db7ab60c2846260ac5bfc33c216ba1a2e3623928c6173c856764/piqueserver-1.1.1.tar.gz",
"platform": "Darwin",
"description": "piqueserver |Build Status| |Wheel Status| |Coverage Status|\n===========================================================\n\nAn Ace of Spades 0.75 server based on\n`PySnip <https://github.com/NateShoffner/PySnip>`__.\n\n\\:point_right: Chat with us!\n----------------------------\n\n- Gitter: |Join the chat at https://gitter.im/piqueserver/piqueserver|\n- Matrix: ``#piqueserver:matrix.org`` (`Riot Webchat\n link <https://riot.im/app/#/room/#piqueserver:matrix.org>`__)\n- Discord: Join with `this invite link <https://discord.gg/w6Te7xC>`__\n- Slack: Join with `this invite link <https://join.slack.com/t/piqueserver/shared_invite/enQtMjg5MDI3MTkwNTgxLTNhMDkyNDRkNzhiNmQyYjRkOTdjNGNkYzNhNTQ4NzZkY2JhZjQxYzIyMTQ0Y2JlYTI2ZGFjMTFmNjAwZTM2OGU>`__\n- IRC: (disabled due to spam) ``#piqueserver`` on freenode.net\n (`web <http://webchat.freenode.net/?channels=%23piqueserver>`__)\n\nAll of these are `bridged <https://matrix.org/docs/guides/faq.html#what-is-matrix>`__ together!\n\n\\:tada: Features\n----------------\n\n- Many administrator features\n- A lot of epic commands\n- A remote console (using SSH)\n- Map rotation\n- Map metadata (name, version, author, and map configuration)\n- Map extensions (water damage, etc.)\n- A map generator\n- An IRC client for managing your server\n- A JSON query webserver\n- A status server with map overview\n- Server/map scripts\n- Airstrikes\n- Melee attacks with the pickaxe\n- New gamemodes (deathmatch / runningman)\n- Rollback feature (rolling back to the original map)\n- Spectator mode\n- Dirt grenades\n- Platforms with buttons\n- Ban subscribe service\n- A ton of other features\n\n\\:rocket: Installation\n----------------------\n\nRequirements\n~~~~~~~~~~~~\n\nPiqueserver requires python 3.7 and above\n\nWe currently provide builds for:\n - Linux x86_64\n - Windows x86 and x86_64\n \nIf your system is not one of the above, you will also need a recent C++ Compiler.\n\npip (stable version)\n~~~~~~~~~~~~~~~~~~~~\n\n.. code:: bash\n\n pip3 install piqueserver\n\nOptional features:\n\n- `ssh`: enable ssh manhole server support\n- `from`: enable the `from` command to geolocate players by ip\n\nTo install with optional features with pip:\n\n.. code:: bash\n\n pip3 install piqueserver[ssh,from]\n\ngit (bleeding edge)\n~~~~~~~~~~~~~~~~~~~\n\n.. code:: bash\n\n git clone https://github.com/piqueserver/piqueserver\n cd piqueserver\n python3 -m venv venv\n source venv/bin/activate\n\n # note: requirements.txt includes all optional deps too\n pip install -r requirements.txt\n\n python setup.py install\n\n # now `piqueserver` will be available on the $PATH when venv active\n\nArch Linux\n~~~~~~~~~~\n\nThe `AUR package <https://aur.archlinux.org/packages/piqueserver-git/>`__\n(git master) is currently broken. When it gets repaired (you can help!),\nyou'll be able to install manually or with your favourite AUR helper:\n\n.. code:: bash\n\n pacaur -S piqueserver-git\n\n\\:rocket: Running\n-----------------\n\nThen copy the default configuration as a base to work off\n\n.. code:: bash\n\n piqueserver --copy-config\n\nA-a-and lift off!\n\n.. code:: bash\n\n piqueserver\n\nCustom config location\n~~~~~~~~~~~~~~~~~~~~~~\n\nIf you wish to use a different location to ``~/.config/piqueserver/``\nfor config files, specify a directory with the ``-d`` flag:\n\n.. code:: bash\n\n piqueserver --copy-config -d custom_dir\n piqueserver -d custom_dir\n\n\\:speech_balloon: FAQ\n---------------------\n\nWhat's the purpose?\n~~~~~~~~~~~~~~~~~~~\n\nThe purpose of this repo is to be a continuation of PySnip.\n\nWhat if PySnip development returns?\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThen they would merge our changes and development would be continued\nthere, I guess. The important thing is to keep AoS servers alive.\n\nWhy should I use piqueserver instead of PySnip/PySpades?\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n- Multi config installation\n- Docker support\n- Bug fixes\n- Improvements\n- Better anti-hacking\n- New scripts\n\nWhat about 0.76 support\n~~~~~~~~~~~~~~~~~~~~~~~\n\nWorking with multiple versions is a pain. 0.76 will be suported in the\nfuture only.\n\nIs that everything?\n~~~~~~~~~~~~~~~~~~~\n\nPlease see also the\n`Online Documentation <https://piqueserver.readthedocs.io/en/latest/>`__ for more\ninformation (readthedocs.io has replaced our wiki).\n\nWhere can i find more scripts?\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nYou 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.\nOr in community forums, such as:\n`aloha.pk <https://aloha.pk/c/aos-modding/scripts/83>`__ and `BuildAndShoot <https://www.buildandshoot.com/forums/viewforum.php?f=19>`__\n\n\\:blush: Contribute\n-------------------\n\nDon't be shy and submit us a PR or an issue! Help is always appreciated\n\n\\:wrench: Development\n---------------------\n\nUse ``python3`` and ``pip`` to setup the development environment:\n\n.. code:: bash\n\n $ python3 -m venv venv && source venv/bin/activate\n (venv) $ pip install -r requirements.txt\n (venv) $ pip install -r dev-requirements.txt # includes dev tools\n (venv) $ python setup.py develop # install in-place\n (venv) $ deactivate # Deactivate virtualenv\n\n--------------\n\nBrought to you with :heart: by the `piqueserver\nteam <https://github.com/orgs/piqueserver/people>`__.\n\n.. |Build Status| image:: https://github.com/piqueserver/piqueserver/actions/workflows/main.yml/badge.svg?branch=master\n :target: https://github.com/piqueserver/piqueserver/actions/workflows/main.yml\n.. |Wheel Status| image:: https://github.com/piqueserver/piqueserver/actions/workflows/wheels.yml/badge.svg?branch=master\n :target: https://github.com/piqueserver/piqueserver/actions/workflows/wheels.yml\n.. |Coverage Status| image:: https://coveralls.io/repos/github/piqueserver/piqueserver/badge.svg?branch=master\n :target: https://coveralls.io/github/piqueserver/piqueserver?branch=master\n.. |Join the chat at https://gitter.im/piqueserver/piqueserver| image:: https://badges.gitter.im/piqueserver/piqueserver.svg\n :target: https://gitter.im/piqueserver/piqueserver?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge\n",
"bugtrack_url": null,
"license": "GNU General Public License v3",
"summary": "Open-Source server implementation for Ace of Spades",
"version": "1.1.1",
"project_urls": {
"Homepage": "https://github.com/piqueserver/piqueserver"
},
"split_keywords": [
"ace of spades",
"aos",
"server",
"pyspades",
"pysnip",
"piqueserver"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8620f08d35d4db7ab60c2846260ac5bfc33c216ba1a2e3623928c6173c856764",
"md5": "e185228c62918114d286dc785034307a",
"sha256": "dc9b336b44e442107dd57ea8e15ee80b50a2bfff57c4a22c81bbdee900c7f17d"
},
"downloads": -1,
"filename": "piqueserver-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "e185228c62918114d286dc785034307a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.0",
"size": 230667,
"upload_time": "2023-07-03T17:47:45",
"upload_time_iso_8601": "2023-07-03T17:47:45.430669Z",
"url": "https://files.pythonhosted.org/packages/86/20/f08d35d4db7ab60c2846260ac5bfc33c216ba1a2e3623928c6173c856764/piqueserver-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-03 17:47:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "piqueserver",
"github_project": "piqueserver",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "Cython",
"specs": [
[
">=",
"0.27"
],
[
"<",
"1"
]
]
},
{
"name": "Jinja2",
"specs": [
[
">=",
"3.0.0"
],
[
"<",
"4"
]
]
},
{
"name": "pyenet",
"specs": []
},
{
"name": "toml",
"specs": []
},
{
"name": "Pillow",
"specs": [
[
"<",
"11"
],
[
">=",
"5.1.0"
]
]
},
{
"name": "aiohttp",
"specs": [
[
">=",
"3.3.0"
],
[
"<",
"3.8.0"
]
]
},
{
"name": "packaging",
"specs": [
[
">=",
"19.0"
]
]
},
{
"name": "geoip2",
"specs": [
[
"<",
"5.0"
],
[
">=",
"2.9"
]
]
},
{
"name": "Twisted",
"specs": []
},
{
"name": "pypiwin32",
"specs": []
}
],
"tox": true,
"lcname": "piqueserver"
}
JSON
