Project Name

Cryodex is an open source X-Wing, Imperial Assault, and Armada tournament management software. It follows and implements the guidelines as described by the Fantasy Flight Tournament Rules for each of these games.

Installation

To install and run Cryodex, you need the following software:

A Java Runtime, Java 7 or higher.
The Cyrodex.jar file, as of this writing Cryodex 4.0.5 is available.

To run Cyrodex.

Copy the Jar to a Directory on your hard drive.
If using a file browser, Double Click the JAR file and it should launch.
Alternatively from the command prompt: java -jar Cyrodex.jar

Contributing

Fork it!
Create your feature branch: git checkout -b my-new-feature
Commit your changes: git commit -am 'Add some feature'
Push to the branch: git push origin my-new-feature
Submit a pull request :D

Building Cryodex

Maven can be used to build cryodex. The Maven Wrapper has been provided for convience.

./mvnw clean install

This will build the Cryodex jar from the latest source, you will find the output in the target directory.

Running Cryodex

Maven can be used to run Cryodex as well. The Maven Wrapper has been provided for convenience.

./mvnw package -Prun

This will build Cryodex and then run it.

History

Credits

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

bdwakefield/CryodexSource