From 1846abb6034f135f67d8e1bbce3665f222a7061d Mon Sep 17 00:00:00 2001 From: Ray Date: Thu, 26 Mar 2009 16:17:38 -0400 Subject: [PATCH] Updated readme. Deleted more obsolete files in docs. --- docs/abbreviations.txt | 47 --------------- docs/benchmarks.txt | 75 ------------------------ docs/codingstyle.txt | 27 --------- docs/db-todo.txt | 22 ------- docs/known-bugs-and-planned-features.txt | 62 -------------------- docs/readme-user.txt | 47 --------------- docs/readme.txt | 64 ++++++++++++++++++++ 7 files changed, 64 insertions(+), 280 deletions(-) delete mode 100644 docs/abbreviations.txt delete mode 100644 docs/benchmarks.txt delete mode 100644 docs/codingstyle.txt delete mode 100644 docs/db-todo.txt delete mode 100644 docs/known-bugs-and-planned-features.txt delete mode 100644 docs/readme-user.txt create mode 100644 docs/readme.txt diff --git a/docs/abbreviations.txt b/docs/abbreviations.txt deleted file mode 100644 index 94fd5b16..00000000 --- a/docs/abbreviations.txt +++ /dev/null @@ -1,47 +0,0 @@ -HUD/table viewer -================ -A3-7=3rd-7th street Complete/Raise percentage -AF=Flop Bet/Raise percentage -AT=River Bet/Raise percentage -AR=Turn Bet/Raise percentage -F3-7=3rd-7th street Fold percentage -FB=like FSB but for big blinds only -FF=Flop Fold percentage -FR=River Fold percentage -FSB=Fold to steal - combined of small and big blind (FSB means Fold Small Big). E.g. if a player faced a steal attempt in the SB 7 times and -FS=like FSB but for small blinds only. -FT=Turn Fold percentage -HD=Hands -PF3B4B=Pre Flop 3Bet or 4Bet -PFR=Pre Flop Raise -Postf A=Postflop (ie. flop+turn+river) Aggression% -Postf F=Postflop Fold % -SD/F=Showdown/Flop=WtSD=How often player went to showdown when he saw the flop -ST=Steal chance (nobody had entered the pot before the player in question, and the player is in cutoff, button or SB position) -W$wsF=Won $ when he saw flop -W$@SD=Won $ at showdown -VPI3=Voluntary Put In on 3rd Street (ie. call+complete+raise) -VPIP=Voluntary Put In Preflop (ie. call+raise) - -Other -===== -CLI=Command Line Interface (Shell, Terminal, "DOS-window") -FTP=Full Tilt Poker -GUI=Graphical User Interface (normal interface with buttons and menus) -HUD=Heads-Up Display (shows stats directly in the poker software) -PS=PokerStars -MTT=Multi Table Tournament -SnG=Sit and Go - -License -======= -Trademarks of third parties have been used under Fair Use or similar laws. - -Copyright 2008 Steffen Jobbagy-Felso -Permission is granted to copy, distribute and/or modify this -document under the terms of the GNU Free Documentation License, -Version 1.2 as published by the Free Software Foundation; with -no Invariant Sections, no Front-Cover Texts, and with no Back-Cover -Texts. A copy of the license can be found in fdl-1.2.txt - -The program itself is licensed under AGPLv3, see agpl-3.0.txt diff --git a/docs/benchmarks.txt b/docs/benchmarks.txt deleted file mode 100644 index 9f3bc680..00000000 --- a/docs/benchmarks.txt +++ /dev/null @@ -1,75 +0,0 @@ -benchmarks -========== -All measurements on my Athlon64@1.1GHz, 1 GB RAM, RAID5, Hardened Gentoo Linux 2.6.23 -From svn47 all measurements on my Athlon64 X2@1GHz, 2GB RAM -All measurements were ran several times in a row, unless otherwise noted the computer was mostly idle -svn12/15 were with PostgreSQL, svn23 onwards with MySQL -All import measurements were taken immediately after reseting the tables - -svn12, whilst compiling open office in the background -===== -reseting tables (incl filling default data): 0.5-0.6s -importing one hand from a file: 0.5-0.7s - -svn15 -===== -reseting tables (incl filling default data): 0.35-0.4s -importing one FTP hand from a file: 0.2-0.3s or 12-18k/hr -importing 51 FTP hands: 2.8-2.9s or 63-66k/hr -The large speedup will be partially due to not compiling in the background, and -partially due to less connecting/disconnecting the DB I'd imagine. -I'm VERY happy with this performance, but large gains could probably be made by -making the importer just a bit more sensible. - -svn23 -===== -reseting tables (incl filling default data): 0.3-0.35s -importing 75 PS hands: 3.2s or 84k/hr -importing 180 FTP hands: 7.7-7.9s 82k/hr -This is the rewrite in import_FTP_and_PS.py, svn12/15 are with import_file.py -Nice, it's substantially faster inspite of supporting PS and FTP (ish) rather -than just FTP and handling more special cases. - -svn24 -===== -importing 75 PS hands: 3.2-3.3s or 82k/hr -importing 507 FTP hands: 23.5-23.8s or 77k/hr -importing 947 FTP hands: 76.2-72.7s or 44k/hr -As you can see FTP has gotten about 6% slower on 500 hands - but the much expanded handling -of new cases (particularly the ante folding will be ALOT of extra string -comparisons) easily explains that. In fact I expected a much bigger impact. - (I suspect this is due to the parsing pausing whilst my shell catches up) - -svn47 -===== -It significantly slows down as the database gets larger, after a few thousand -hands it got to just one hand per second and slower. However, around 90% of the -CPU load was MySQL. Any tips are most welcome.. - -svn52 (whilst watching movie in a small window) -===== -Importing 2500 hands (mixed sites+types): 6m15s or 31k/hr (ran twice) -Of these 230 were skipped as duplicate or partial so counting 2270 hands - -svn53 (whilst watching movie in a small window) -===== -Importing the 2270 hands from svn52: 1m50 or 74k/hr (82 if counting dupes/partial) -Importing my 35661 (plus 427 dupe/part) hands: 51m51s or 41k/hr (ran once) - -The dbsize still has a significant impact, but with these sizes certainly it's -just not a problem. If anyone runs a larger database let me know how long it takes. -Thanks bwarycha for the tip with the foreign keys! - - -License -======= -Trademarks of third parties have been used under Fair Use or similar laws. - -Copyright 2008 Steffen Jobbagy-Felso -Permission is granted to copy, distribute and/or modify this -document under the terms of the GNU Free Documentation License, -Version 1.2 as published by the Free Software Foundation; with -no Invariant Sections, no Front-Cover Texts, and with no Back-Cover -Texts. A copy of the license can be found in fdl-1.2.txt - -The program itself is licensed under AGPLv3, see agpl-3.0.txt diff --git a/docs/codingstyle.txt b/docs/codingstyle.txt deleted file mode 100644 index 31c113f9..00000000 --- a/docs/codingstyle.txt +++ /dev/null @@ -1,27 +0,0 @@ -This is just a loose collection of things so far, but might as well make a start :) - -A word on wrapping: Please avoid making manual line breaks, the computer can and therefore should do it. Whether people use a phone or a 40" super-uber-HD screen, they should be allowed to use as much of it as they wish/can. Incidentially, if anyone knows how to activate line wrap in Eclipse I'd really appreciate if you let me know. - -Comments (or prints) with todo are things that are missing, bugs, or just messy code. - -After every def (ie. at the end of the method) there should be a comment including the name, e.g. -#def end of parseActionLine - -If you don't mind make names in java style, ie.: -Classes, files or tables like this: MyClassName -Methods and variables like this: myMethodName - -I'll eventually change all my code to that style, too. - -License -======= -Trademarks of third parties have been used under Fair Use or similar laws. - -Copyright 2008 Steffen Jobbagy-Felso -Permission is granted to copy, distribute and/or modify this -document under the terms of the GNU Free Documentation License, -Version 1.2 as published by the Free Software Foundation; with -no Invariant Sections, no Front-Cover Texts, and with no Back-Cover -Texts. A copy of the license can be found in fdl-1.2.txt - -The program itself is licensed under AGPLv3, see agpl-3.0.txt diff --git a/docs/db-todo.txt b/docs/db-todo.txt deleted file mode 100644 index 9d8c0042..00000000 --- a/docs/db-todo.txt +++ /dev/null @@ -1,22 +0,0 @@ -stats to add -============ -*CC,TotalColdCalls,TimesFacingRaisePreflop -**Folded to 3-Bet,FoldedToThreeBetPreflop,FacedThreeBetPreflop -Called 3-Bet,CalledThreeBetPreflop,FacedThreeBetPreflop -*Winning %,wonhand,TotalHands -**Flop Aggression Factor,timesaggressiveflop,timescalledflop -**Turn Aggression Factor,timesaggressiveturn,timescalledturn -**River Aggression Factor,timesaggressiveriver,timescalledriver -scoopedPot (useful for hi/lo split games) - -couldSqueeze, didSqueeze, facedSqueeze, calledSqueeze -> if (player raises from EP) and (someone after him calls) and (someone after that goes all in) -Donk Bet Turn,DidDonkBetTurn,CouldDonkBetTurn -> EP raises, LP reraises, EP calls. If EP bets out after the flop, it is considered a donk bet -Float Turn,DidFloatTurn,CouldFloatTurn -> - -other -===== -look at PT3 and HM tables see if i forgot anything -store all-in somewhere -add somewhere: mixed flag to denote that the game is part of a mixed game rotation - -add tables for single draw (5card draw, 2-7 single draw, badugi) and tripple draw (2-7 tripple draw) diff --git a/docs/known-bugs-and-planned-features.txt b/docs/known-bugs-and-planned-features.txt deleted file mode 100644 index aed9eb6c..00000000 --- a/docs/known-bugs-and-planned-features.txt +++ /dev/null @@ -1,62 +0,0 @@ -This file is badly out of date, but I'm going to leave it here for now. :) -More up-to-date information is on the wiki: http://fpdb.wiki.sourceforge.net/ -REB 30-Jan-2009 - -Everything is subject to change and the order does not indicate priority. Patches for any of these or other features are very welcome, see readme-overview.txt for contacts. -Please also see db-todo.txt - -before beta -=========== -change to savannah? - - - -Any comment or print with "todo" in it in the sourcecode except what is marked todo in the menu -make a quick benchmark of mysql and postgresql: import of my whole db, some tableviewer refreshes with and without updated file -Make tab and enter work as sensible in GUIs and implement Ctrl+Q, Ctrl+X and Alt+F4 for close. -use profile file for bulk import and table viewer settings and pathes -check that we read sitout correctly in: Full Tilt Poker Game #6150325318: Table Bogside -verify at least 2 or 3 sng hands - -no rush but before 1.0RC -======================== -improve handling of dead hand before BB, see git101/7bd1631 -make DB version error offer reimport, recreation and continue. -In many places there are unnecessary database accesses or it regenerates information it already had before or just generally does things in obscenely inefficient ways. Optimise this -multi-select in bulk importer -cut down action_types array size to appropriate length -make the gui display errors -log file -move directory import code from gui to backend -convert fpdb_import to not require passing "self", generally clean the parameter passing -Doesn't handle Daylight Saving Time (I don't think at least) -ensure that refresh still takes no more than 10 seks on my P3M-800 (a quick run on git15 indicates this is ok now), or 5 with remote DB -select range of stakes and sng/mtt values and types for hud -recognise somewhere if a file is still active and if so keep it open and only read new hands rather than detecting dupes -return full ftp functionality - -can wait till 1.x -================= -in all importer: stop doing if site=="ftp", make class constants for site_id instead -It treats fold due to disconnect as voluntary fold which is not ideal -aliases -repair hands where the seat lines are missing, happens when observing at FTP -flags for storing the reason for winning (best hi, tie for best low, etc.) to DB. not sure actually if this is such a good idea remember that there can be multiple reasons for the same player in the same hand -benchmark properly on mysql innodb, postgresql, more? -rename things like this: ClassName.methodName and variableName. update codingstyle -CLI (not ncurses, normal CLI) equivalent for fpdb.py -optimise/simplify storing by creating the SQL statements depending on hand rather than calling different methods -make range of activeSeats configurable for tv/hud - -License -======= -Trademarks of third parties have been used under Fair Use or similar laws. - -Copyright 2008 Steffen Jobbagy-Felso -Permission is granted to copy, distribute and/or modify this -document under the terms of the GNU Free Documentation License, -Version 1.2 as published by the Free Software Foundation; with -no Invariant Sections, no Front-Cover Texts, and with no Back-Cover -Texts. A copy of the license can be found in fdl-1.2.txt - -The program itself is licensed under AGPLv3, see agpl-3.0.txt diff --git a/docs/readme-user.txt b/docs/readme-user.txt deleted file mode 100644 index 8a186667..00000000 --- a/docs/readme-user.txt +++ /dev/null @@ -1,47 +0,0 @@ -This file is badly out of date, but I'm going to leave it here for now. :) -More up-to-date information is on the wiki: http://fpdb.wiki.sourceforge.net/ -REB 30-Jan-2009 - -Before you do this make sure you setup the dependencies, the database, user, tables and config file. - -Running it -========== -If you have python setup properly you can execute it by double clicking pyfpdb/fpdb.py. - -Note however that all error messages are currently only printed if you call it from a shell. It'll be much easier to diagnose possible problems (which are likely in alpha stage) if you run it from a shell. In Windows XP it seems to automatically open a shell window with the fpdb window where you can see the command line output. - -In Linux/MacOS/*BSD, e.g. if its in /home/sycamore/fpdb/, do this: -cd /home/sycamore/fpdb/pyfpdb -python fpdb.py - - -That will start the main GUI. - -Have a look at the menus, the stuff that is marked todo is not yet implemented. - -The main things are the bulk importer and the table viewer. To use the importer open it from the menu (import files and directories). You can set a few options at the bottom, then select a folder or single file in the main are and click Import. Please report any errors by one of the contacts listed in readme-overview.txt. -Currently this will block the interface, but you can open another instance of this program e.g. if you wanna play whilst a big import is running. - -Please check the output at the shell for errors, if there are any please get in touch by one of the methods listed in readme-overview.txt - -Table Viewer (tv) -================= -To use the table viewer open it from the menu, select the hand history file of the table you're at, and click the Import&Read&Refresh button. The abbreviations there are explained in abbreviations.txt, but feel free to ask. Note that most poker software will only create the file once the first hand you payed to play is finished. -In each column there is either just the number (hand count for current stake, range of seats and type of game) or a percentage and the number of hands that this percentage is based on. For example, in W$@SD (won $ at shodown) the number in brackets is how many showdowns that player has seen. - -Reimporting -=========== -Currently on most updates a reimport of the whole database is required. To do this open fpdb, click the menu Database and select Create/Recreate tables. Then import all your history files again. - -License -======= -Trademarks of third parties have been used under Fair Use or similar laws. - -Copyright 2008 Steffen Jobbagy-Felso -Permission is granted to copy, distribute and/or modify this -document under the terms of the GNU Free Documentation License, -Version 1.2 as published by the Free Software Foundation; with -no Invariant Sections, no Front-Cover Texts, and with no Back-Cover -Texts. A copy of the license can be found in fdl-1.2.txt - -The program itself is licensed under AGPLv3, see agpl-3.0.txt diff --git a/docs/readme.txt b/docs/readme.txt new file mode 100644 index 00000000..03e071d3 --- /dev/null +++ b/docs/readme.txt @@ -0,0 +1,64 @@ +README.txt +updated 26 March 2009, REB + +fpdb - Free Poker Database + +The most accurate and up-to-date information on fpdb will be found in the wiki: +http://fpdb.wiki.sourceforge.net/ + +Other resources are: + Mailing list: http://sourceforge.net/mailarchive/forum.php?forum_name=fpdb-main + Chat room(irc): #fpdb on freenode.net + +fpdb is a free program for use with on line poker. It provides: + Tracking of your results and statistics. + Tracking of opponents' results statistics. + Win/loss graphing + Heads Up Display (HUD) with a variety of statistics + Display of mucked cards in the HUD + +fpdb supports: + Sites: + PokerStars + Full Tilt Poker + Everleaf Network + Other sites are under development and are easily added + + Games: + Holdem + Omaha (incl Hi/low) + 7 Card Stud (incl Hi/low) + Razz + Draw support is under development + Mixed Games -- HUD under development + + Operating Systems: + Linux and other Unix-like, using X + Windows + Mac OS/X -- no support for HUD + + Databases: + MySQL + PostgreSQL + SQLite under development + +Downloads: + Releases: http://sourceforge.net/project/showfiles.php?group_id=226872 + Development code via git: http://www.assembla.com/spaces/free_poker_tools/trac_git_tool + +Developers: + At least 7 people have contributed code or patches. Others are welcome. + +License +======= +Trademarks of third parties have been used under Fair Use or similar laws. + +Copyright 2008 Steffen Jobbagy-Felso +Copyright 2009 Ray E. Barker +Permission is granted to copy, distribute and/or modify this +document under the terms of the GNU Free Documentation License, +Version 1.2 as published by the Free Software Foundation; with +no Invariant Sections, no Front-Cover Texts, and with no Back-Cover +Texts. A copy of the license can be found in fdl-1.2.txt + +fpdb itself is licensed under AGPLv3, see agpl-3.0.txt.