======
BYCEPS
======

.. image:: assets/byceps_logo.svg
   :align: left
   :alt: BYCEPS logo
   :height: 150
   :width: 150

BYCEPS is the Bring-Your-Computer Event Processing System.

It is **a tool to prepare and operate a LAN party**, both online on the
Internet and locally as an intranet system, for both organizers and
attendees.

The system incorporates experience from almost 25 years of organizing
LAN parties as well as concepts and source code developed for more than
a decade.


Website
=======

The official tiny website is at https://byceps.nwsnet.de/.


Community
=========

If you have questions, suggestions, or want to exchange experience,
consider yourself invited to join us on the BYCEPS Discord server:

.. image:: https://discordapp.com/api/guilds/736558889767796789/widget.png?style=banner2
   :alt: Join BYCEPS on Discord
   :target: https://discord.gg/HxXbBN554U


In the Wild
===========

Parties using BYCEPS:

- Since 2014, BYCEPS is the foundation of the public website and local
  party intranet of the LANresort_ (300+ attendees) event series.
- In 2016, `LANresort Bostalsee`_ was launched on BYCEPS.
- In 2017, NorthCon_ (1,300+ attendees) was relaunched on BYCEPS.

Other sites using BYCEPS:

- In 2019, the OrgaTalk_ community was launched using BYCEPS as a
  discussion board.

.. _LANresort: https://www.lanresort.de/
.. _LANresort Bostalsee: https://bostalsee.lanresort.de/
.. _NorthCon: https://www.northcon.de/
.. _OrgaTalk: https://www.orgatalk.de/


Installation
============

See `installation instructions
<https://byceps.readthedocs.io/en/latest/installation/index.html>`_.


Code Status
===========

|badge_github-action-test|
|badge_rtd-build|
|badge_scrutinizer-ci_coverage|
|badge_scrutinizer-ci_quality-score|
|badge_code-climate_maintainability|


.. |badge_github-action-test| image:: https://img.shields.io/github/actions/workflow/status/byceps/byceps/test.yml?branch=main
   :alt: Build Status
   :target: https://github.com/byceps/byceps/actions/workflows/test.yml

.. |badge_rtd-build| image:: https://readthedocs.org/projects/byceps/badge/?version=latest
   :alt: Documentation Status
   :target: https://byceps.readthedocs.io/en/latest/

.. |badge_scrutinizer-ci_coverage| image:: https://scrutinizer-ci.com/g/byceps/byceps/badges/coverage.png?b=main
   :alt: Scrutinizer Code Coverage
   :target: https://scrutinizer-ci.com/g/byceps/byceps/?branch=main

.. |badge_scrutinizer-ci_quality-score| image:: https://scrutinizer-ci.com/g/byceps/byceps/badges/quality-score.png?b=main
   :alt: Scrutinizer Code Quality
   :target: https://scrutinizer-ci.com/g/byceps/byceps/?branch=main

.. |badge_code-climate_maintainability| image:: https://codeclimate.com/github/codeclimate/codeclimate/badges/gpa.svg
   :alt: Code Climate
   :target: https://codeclimate.com/github/byceps/byceps


Author
======

BYCEPS was created, and is developed and maintained, by Jochen "Y0Gi"
Kupperschmidt.


License
=======

BYCEPS is licensed under the `BSD 3-Clause "New" or "Revised" License
<https://choosealicense.com/licenses/bsd-3-clause/>`_.

The license text is provided in the `LICENSE <LICENSE>`_ file.