# Welcome to pairgoth, your Go Pairing Engine!

## What is pairgoth?

pairgoth is a Go tournament pairing engine designed to make your tournament experience effortless. pairgoth is the successor of opengotha, the well known pairing system software developed by Luc Vannier and uses the same algorithm internally, as well as import and export features towards its format.

pairgoth version 0.1 supports the Swiss pairing system, ideal for championships with no handicap games, as well as the MacMahon pairing system, more suited for classical tournaments and cups. It is still in a beta stage. Future versions will support more pairing systems and more features. Your feedback is most welcome!

## How to use pairgoth?

We offer you the flexibility to use pairgoth in a way that best suits your needs. Here are your options:

1. Stay in the browser: If you prefer convenience, you can simply use the pairgoth instance graciously hosted by the French Go Federation.

   Note that login to this instance is reserved to French federation actors plus several external people at our discretion. Send us an email to request an access.

   > Launch pairgoth

2. Launch a standalone instance: This mode allows you to run pairgoth on your local computer.

   That's the best option if you feel more comfortable when running locally or whenever you want to be able to do the pairing without internet. Pairgoth will launch a local web server on port 8080 to which you can connect using a browser.

   > Download pairgoth standalone, web interface (java required)
   > Download pairgoth standalone, web interface, via docker (docker required)

3. Launch a pairing server: This mode is the best suited for big Go events like congresses, it allows to register players, enter results and manage pairing from several workstations at once.

   > Download the standalone web interface module which suits your need, then follow the configuration guide (not yet available)

4. Compile from the sources: the pairgoth project is fully open source, and under the very permissive apache licence, allowing you to tweak it in any possible way. Be sure to contribute back your enhancements!

   Since the project is still in beta, the sources are only available to FFG actors. If that's your case, you can access the sources here:

   > Browse pairgoth sources on FFG's gitlab