PretendYoureXyzzy/README.md

Pretend You're Xyzzy
===================

A Cards Against Humanity clone, server and web client. See WebContent/license.html for full details.

Note: This project is only known to work with Tomcat 7, all other versions are unsupported. 
Currently, the only way to build PYX is using Maven via ```mvn clean package war:war``` in the project's directory.


If you're doing ```mvn clean package war:exploded jetty:run```, you now need to add ```-Dmaven.buildNumber.doCheck=false -Dmaven.buildNumber.doUpdate=false``` to make the buildnumber plugin allow you to run with uncommited changes.


For GeoIP functions to work, download http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.mmdb.gz somewhere, gunzip it, and update the geoip.db value in build.properties to point to it.

## Third-Party Usage

A Docker package for this project exists at [emcniece/DockerYourXyzzy](https://github.com/emcniece/DockerYourXyzzy):

```sh
docker run -d -p 8080:8080 emcniece/dockeryourxyzzy:dev
```
Update and rename README to README.md The README file needs an update. As Eclipse will no longer compile the WAR correctly. Using Maven will compile PYX correctly. 2016-04-13 16:01:41 +01:00			`Pretend You're Xyzzy`
			`===================`

			`A Cards Against Humanity clone, server and web client. See WebContent/license.html for full details.`

			`Note: This project is only known to work with Tomcat 7, all other versions are unsupported.`
			Currently, the only way to build PYX is using Maven via ```mvn clean package war:war``` in the project's directory.
add instructions on how to avoid buildnumber plugin errors to readme 2017-02-15 04:18:54 +00:00

Update README with correct command to run via jetty. Fixes #163. 2018-02-15 22:06:47 +00:00			If you're doing ```mvn clean package war:exploded jetty:run```, you now need to add ```-Dmaven.buildNumber.doCheck=false -Dmaven.buildNumber.doUpdate=false``` to make the buildnumber plugin allow you to run with uncommited changes.
Add persistent IDs to users, stored via cookie (opt-out availabled). Fix removing cookies. Add per-server instance unique IDs for games and users, which will not collide between servers or when servers restart. Add GeoIP capability. Add beginning of framework for logging card plays. 2017-02-21 05:35:44 +00:00

			`For GeoIP functions to work, download http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.mmdb.gz somewhere, gunzip it, and update the geoip.db value in build.properties to point to it.`
Adding Docker docs to README 2018-08-26 22:02:38 +01:00
			`## Third-Party Usage`

			`A Docker package for this project exists at [emcniece/DockerYourXyzzy](https://github.com/emcniece/DockerYourXyzzy):`

			```sh
			`docker run -d -p 8080:8080 emcniece/dockeryourxyzzy:dev`
			```