Skip to content

AbdulMuhsinSE/Parmailya

Repository files navigation

Parmailya

Parmailya aims to be an all inclusive character management system for the tabletop giant Dungeons & Dragons. The application provides users with an interactive method of managing their characters, and allows DMs to manage their games.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

Java JDK, JavaFX, ControlsFX, Mysql-connector-java-*.bin, MySQL

Give examples

Installing

A step by step series of examples that tell you have to get a development env running

Run the parmailya_create.sql script.

Load the project into your favorite IDE & run it.

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Make sure that you have the required libraries included into your project and just click run.

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

Single version so far. Will update if this changes

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the GPL License - see the LICENSE.md file for details

Acknowledgments

  • Hat tip to anyone who's code was used
  • Inspiration
  • etc

Releases

No releases published

Packages

No packages published