<commit_before># java-card-game-engine
Specifications and source code for a Java based card game engine.

Game rules are specified in a rules.<game>.txt file. The rules must specify the correct deck and board files to be used. The game engine will then dynamically create all necessary components to play the game, with game play following the rules file.

##Licensing
The MIT License (MIT). See LICENSE.txt.

##TO DO
* Create rules.<game>.txt files
* Complete Design Requirements
* Clean up documentation

##Directory Structure
	/root
	|
	|___/doc			=> Project Documentation
	|
	|___/plugin			=> rules, board, and deck files (.txt)
	|
	|___/res			=> project resources (graphical)
	|
	|___/src			=> source code (.java)
	|	|
	|	|___/games			=> java games package
	|		|
	|		|___/engine			=> games engine package
	|			|
	|			|___/util			=> engine utilities
	|
	|___LICENSE.txt		=> License and warranty info
	|
	|___README.md		=> General information 
<commit_msg>Updated To Do and Directories<commit_after># java-card-game-engine
Specifications and source code for a Java based card game engine.

Game rules are specified in a rules.<game>.txt file. The rules must specify the correct deck and board files to be used. The game engine will then dynamically create all necessary components to play the game, with game play following the rules file. See plugin/PluginKeyword for list of known Plugin keywords.

##Licensing
The MIT License (MIT). See LICENSE.txt.

##TO DO
* Build rules engine by reading rules plugin file
* Basic testing of following rules
* Create test suite of plugin files to test various possible inputs
* Expand test benches to test over multiple test suites
* Organize documentation

##Complete
* Basic strutures built and tested (playing card, deck, cardpile, board)
* Reading and parsing plugin files using keywords
* Reading rules to create CardDealer - initially deal cards to piles

##Directory Structure
	/root
	|
	|___/doc			=> Project Documentation
	|
	|___/plugin			=> rules, board, and deck files (.txt)
	|
	|___/res			=> project resources (graphical)
	|
	|___/src			=> source code (.java)
	|	|
	|	|___/games			=> java games package
	|		|
	|		|___/engine			=> games engine package
	|			|
	|			|___/gui			=> graphical user interface
	|			|
	|			|___/plugin			=> engine plugin utilities
	|			|
	|			|___/tests			=> code test benches
	|			|
	|			|___/util			=> engine backbone utilities
	|
	|___LICENSE.txt		=> License and warranty info
	|
	|___README.md		=> General information 

{'fraction_non_alphanumeric': 0.08949260886935677, 'fraction_numerical': 0.0, 'mean_word_length': 3.544464609800363, 'pattern_counts': {'":': 0, '<': 6, '<?xml version=': 0, '>': 27, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '436733', 'n_tokens_mistral': 810, 'n_tokens_neox': 758, 'n_words': 305}