Remove outdated files in docs/. See wiki instead.
This commit is contained in:
Ray
parent
3e6fccd34d
commit
61c0e03098
|
|
@ -1,46 +0,0 @@
|
|||
Last checked: 1 Sep, p74
|
||||
|
||||
These instructions are for any Ubuntu Linux, but except for the name of the package management software it should be identical on other Linux distributions.
|
||||
|
||||
Using the package manager (I think it's called synaptics) install the dependencies: mysql, python, mysql-python, pygtk
|
||||
I don't use ubuntu but I'd imagine it will at some point prompt you for a MySQL root password enter one and when it's done installing everything open a shell/terminal and type this:
|
||||
mysql --user=root --password=YourMysqlRootPassword
|
||||
It should say something like this:
|
||||
|
||||
Welcome to the MySQL monitor. Commands end with ; or \g.
|
||||
Your MySQL connection id is 4
|
||||
Server version: 5.0.60-log Ubuntu Linux mysql-5.0.60-r1
|
||||
|
||||
Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
|
||||
|
||||
mysql>
|
||||
|
||||
Now type this:
|
||||
CREATE DATABASE fpdb;
|
||||
|
||||
Next you need to create a user. Type this (replacing newPassword with the password you want the fpdb user to have - this can, but for security shouldn't, be the same as the root mysql password):
|
||||
GRANT ALL PRIVILEGES ON fpdb.* TO 'fpdb'@'localhost' IDENTIFIED BY 'newPassword' WITH GRANT OPTION;
|
||||
|
||||
Then download one of the alpha2 archives from the sourceforge page at https://sourceforge.net/projects/fpdb/ and unpack it into a folder of your choice.
|
||||
|
||||
Next create a directory called .fpdb (the . at the beginning is important) in your home directory, e.g. /home/steffen/.fpdb
|
||||
Then copy the default.conf file from the docs directory of the archive into this new folder.
|
||||
Finally edit default.conf with any texteditor and enter the fpdb password you entered above (in the GRANT ALL... command).
|
||||
|
||||
This should be it, try double clicking pyfpdb/fpdb.py or open it from a shell with python /path/to/fpdb/pyfpdb/fpdb.py
|
||||
|
||||
Now see readme-user.txt for usage instructions.
|
||||
|
||||
|
||||
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
|
||||
|
|
@ -1,71 +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
|
||||
|
||||
Hi,
|
||||
This document is to serve as a little overview (later: full technical doc) for current and prospective developers with:
|
||||
a) introduction into the code structure
|
||||
b) organisational/legal things
|
||||
|
||||
What to do?
|
||||
===========
|
||||
- Anything you want.
|
||||
- The most useful (because it's the most boring) would be to update print_hand.py, update the expected files (testdata/*.found.txt) and create more .found.txt to ensure import processing is running correctly.
|
||||
- There's a list of various bugs, deficiencies and important missing features in known_bugs_and_planned_features.txt.
|
||||
- In the main GUI there's various menu points marked with todo - all of these will have to be done eventually.
|
||||
|
||||
If you want to take a look at coding-style.txt.
|
||||
Ideally use git (see git-instructions.txt for some commands) and let me know where to pull from, alternatively feel free to send patches or even just changed file in whatever code layout or naming convention you like best. I will, of course, still give you full credit.
|
||||
|
||||
Contact/Communication
|
||||
=====================
|
||||
If you start working on something please open a bug or feature request at sf to avoid someone else from doing the same
|
||||
Please see readme-overview
|
||||
|
||||
Dependencies
|
||||
============
|
||||
Please let me know before you add any new dependencies and ensure that they are source-compatible between *nix and Windows
|
||||
|
||||
Code/File/Class Structure
|
||||
=========================
|
||||
Basically the code runs like this
|
||||
|
||||
fpdb.py -> bulk importer tab (import_threaded.py) -> fpdb_import.py -> fpdb_parse_logic.py -> fpdb_save_to_db.py
|
||||
or
|
||||
fpdb.py -> table viewer tab (table_viewer.py) (todo: -> libTableViewer)
|
||||
|
||||
All files call the simple methods that I just collected in fpdb_simple.py, to abstract the other files off the nitty gritty details as I was learning python.
|
||||
I'm currently working on (amongst other things) integrating everything into the fpdb.py GUI with a view to allow easy creation of a CLI client, too.
|
||||
|
||||
Also see filelist.txt.
|
||||
|
||||
How to Commit
|
||||
=============
|
||||
Please make sure you read and accept the copyright policy as stated in this file. Then see git-instructions.txt. Don't get me wrong, I hate all this legalese, but unfortunately it's kinda necessary.
|
||||
|
||||
Copyright/Licensing
|
||||
===================
|
||||
Copyright by default is handled on a per-file basis. If you send in a patch or make a commit to an existing file it is done on the understanding that you transfer all rights (as far as legally possible in your jurisdiction) to the current copyright holder of that file, unless otherwise stated. If you create a new file please ensure to include a copyright and license statement.
|
||||
|
||||
The licenses used by this project are the AGPL3 for code and FDL1.2 for documentation. See readme-overview.txt for reasons and if you wish to use fpdb with different licensing.
|
||||
|
||||
Preferred File Formats
|
||||
======================
|
||||
Preferred: Where possible simple text-based formats, e.g. plain text (with Unix end of line char) or (X)HTML. Preferred picture format is PNG. IE-compability for HTML files is optional as IE was never meant to be a real web browser, if it were they would've implemented web standards.
|
||||
|
||||
Also good: Other free and open formats, e.g. ODF.
|
||||
|
||||
Not good: Any format that doesn't have full documentation freely and publicly available with a proper license for anyone to implement it. Sadly, Microsoft has chosen not fulfil these requirements for ISO MS OOXML to become a truly open standard.
|
||||
|
||||
License (of this file)
|
||||
=======
|
||||
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
|
||||
|
|
@ -1,91 +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
|
||||
|
||||
|
||||
Summary
|
||||
=======
|
||||
A database program to track your online poker games, the behaviour of the other players and your winnings/losses. Supports Holdem, Omaha, Stud and Razz for cash games as well as SnG and MTT tournaments with more possibly coming in the future. Some of this is not yet working though, please see status.txt and known-bugs-and-planned-features.txt
|
||||
|
||||
Contact
|
||||
=======
|
||||
Please note that this project has two hostings: one at assembla.com which holds are version control "central tree" (irrelevant for users) and everything else at http://sourceforge.net/projects/fpdb/.
|
||||
|
||||
The best means of contact are the sourceforge page: Use the bug, feature request or patch functions or just post in the forum.
|
||||
|
||||
Alternatively feel free to contact me directly:
|
||||
|
||||
mail: steffen(at)sycamoretest.info
|
||||
jabber/xmpp/Google Talk: as above
|
||||
ICQ: 7806355
|
||||
MSN: steffenjf@gmx.de (don't email that)
|
||||
|
||||
But you could send all my hand histories to yourself!
|
||||
=====================================================
|
||||
At the end of the day this comes down to a question of trust, but unlike Windows and the poker client software you don't have to trust fpdb blindly. You can:
|
||||
- Verify the source code yourself.
|
||||
- Convince or pay someone to verify the source code for you.
|
||||
- Use a personal firewall to completely block fpdb from the Internet
|
||||
- (for the uber-paranoid) Get yourself the free virtualisation software VirtualBox, set up a VM (virtual machine) to run fpdb but run the poker software on your real PC. Then cut the VM off the Internet, fpdb doesn't need it. If you have a PC made in the last few years this should run fast enough as well. Note that most Windows licenses do NOT permit you to use two Windows installations at once, even if they are on the same PC.
|
||||
|
||||
Installing
|
||||
==========
|
||||
See the install-*.txt for your operating system. If your OS is missing or if you have problems let me know (contacts are further below). In particular I'd be happy to provide packages for GNU/Linux and *BSD distributions.
|
||||
|
||||
Using it
|
||||
========
|
||||
See readme-user.txt
|
||||
If you have a problem, request or question see the contacts section below
|
||||
|
||||
Changing it
|
||||
===========
|
||||
See readme-dev.txt
|
||||
|
||||
Requirements
|
||||
============
|
||||
Software requirements are listed in requirements.txt
|
||||
As for hardware, my main test machine is a Pentium 3-M 800 with 256 RAM and Gentoo GNU/Linux
|
||||
(running the poker client through what most people will call emulation). So this
|
||||
program will have to work on that. If you run an even more ancient machine and
|
||||
its too slow let me know and I'll see what I can do :)
|
||||
|
||||
Why Free Software?
|
||||
==================
|
||||
This program is released under the terms of the free/libre software license AGPL3 as released by the FSF. The AGPL3 protects your rights and those of the wider community. As Richard Stallman, one of the founders of the free software movement, put it: "Free software is a matter of liberty, not price. To understand the concept, you should think of free as in free speech, not as in free beer." (well, it is both really, like the right to vote used to be free)
|
||||
|
||||
For example, a "pirated" copy of proprietary software X is free of charge, but you don't actually have a legal right to use it, you don't have any possibility to fix its bugs and you certainly don't have any legal right to share it with your friends. You also won't be able to get support, often not even security fixes. Actually, even if you pay hundreds of pounds for your program they deny your right to fix their errors for them. Imagine buying a car where you're not permitted (under threat of jail) to replace broken parts..
|
||||
|
||||
With free/libre software (also known as open source software, or short FOSS or FLOSS) on the other hand you get all these freedoms:
|
||||
(note: the legally binding terms are in the license text, this is merely an amateur summary so normal people don't have to read pages of legalese)
|
||||
|
||||
Freedom 0: The freedom to use: To run the program, for any purpose. Free of Charge.
|
||||
Freedom 1: The freedom to study and help yourself. This freedom guarantees your right to study and learn from the source code of the program, and to fix it if it is broken. If you're not a programmer yourself the developers will generally be happy to fix it for you, often even for free. Failing that you can always pay someone from the money you saved on not having to pay for it.
|
||||
Freedom 2: The freedom to be a decent human being and help your neighbour: I don't threaten you with lawsuits or jail time if you share with your friends and neighbours, subject to the very modest restrictions of the AGPL3.
|
||||
Freedom 3: The freedom to improve the program and release your improvements to the public (or parts thereof) so that the whole community benefits. Note that you are PERMITTED, but not REQUIRED to distribute your changes. If you do distribute your changes you must do so under the terms of the AGPL3 however.
|
||||
|
||||
Note that this is the license - I retain full copyright over my code, including the right to change the license for future versions. I do not intend to do this however. In any case, any version I released under AGPL3 remains available under that license forever, or more accurately until my copyright expires at which point it goes into the public domain.
|
||||
|
||||
I reject the concept of software patents as a crime and under the European Patent Agreement software patents - even if you mislabel them as "computer-implemented inventions" or whatever - are explicitly prohibited.
|
||||
|
||||
Can I get/use this under a different license?
|
||||
=============================================
|
||||
The short answer: Maybe.
|
||||
The long one: As detailed, I fully support what the FSF does and aims to achieve with the GPL. However, I realise that many free software developers don't object to closed source, some don't even object to closed source profiteering of their charity, and I don't think I have any right to go and tell them they're wrong.
|
||||
So if anyone wishes to use all or part of my code in another free software/open source project with an AGPL3-incompatible license such as BSD then let me know and we'll figure out a solution that makes everyone happy.
|
||||
If you wish to use all or part of this in closed source let me know how much if anything that is worth to you and I'm sure we'll be able to reach an agreement. Note that you are NOT permitted to just use fpdb code in closed source development whether in-house or by an independent software developer, you will NEED an additionally agreement with me to get fpdb under different licensing conditions.
|
||||
|
||||
|
||||
License of this Document
|
||||
========================
|
||||
The views expressed in this document are those of Steffen Jobbagy-Felso, other members of the fpdb team and external contributors may or may not agree.
|
||||
|
||||
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
|
||||
|
|
@ -1,80 +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
|
||||
|
||||
For all support please note that the tables WILL be changed, almost certainly without keeping backwards compatibility. Therefore you should keep your history files after import so you can re-import when necessary. Should you lose history files and need a "database updater" let me know.
|
||||
|
||||
If support for another site/game would encourage you to help with this software please let me know at steffen@sycamoretest.info.
|
||||
|
||||
IMPORTANT: There appears to be a bug in at least up to git34 in reading WtSD/W$wsF/W$SD
|
||||
|
||||
Holdem/Omaha ring games on PokerStars
|
||||
======================================
|
||||
Works, quite well tested, works in table viewer and is useful now. Functionality is quite limited so far though. This includes the holdem/omaha parts of HORSE, HOSE and any other mixed game
|
||||
|
||||
Stud/Razz ring games on PokerStars
|
||||
==================================
|
||||
Broken - used to work, hardly tested. Needs to be updated to new infrastructure using a HudData table rather than hands_players_flags. Will fix this shortly.
|
||||
|
||||
Tournaments/SnGs
|
||||
================
|
||||
Broken - used to work, hardly tested. Needs to be updated to new infrastructure.. Will probably fix this shortly
|
||||
|
||||
Full Tilt Poker
|
||||
===============
|
||||
Might work - used to work and was very well test. It should import them (except HudData), but I believe the table viewer won't work. Would be easy to fix I think, volunteers welcome. This used to work in a pre-alpha but basically was left behind during updates to the other stuff.
|
||||
|
||||
Other Sites
|
||||
===========
|
||||
Patches/Volunteers welcome. Should be quite easy.
|
||||
|
||||
GUI
|
||||
===
|
||||
Alpha - the infrastructure stands and is fast enough, now "just" need to add more functionality.
|
||||
|
||||
HUD
|
||||
===
|
||||
Not started - volunteers welcome. I found a *nix utility based on xlib that does half the work for this (most of the other half is already in the table viewer), see http://www.roard.com/docs/cookbook/cbsu19.html. There's also a python implementation of xlib which should run even on Windows.
|
||||
|
||||
Packaging
|
||||
=========
|
||||
Gentoo GNU/Linux: I'll make ebuilds, if you want one now let me know.
|
||||
Other free/libre systems (e.g. other GNU/Linux-Distros, *BSD, and I'd love to help in getting this to work on any Hurd based system): Let me know what you use (Distribution, version and CPU type) and I'll make a package.
|
||||
Windows/MacOSX: Manual installation of dependencies for now, integrated installer would be nice - volunteers welcome, but I'll do it eventually in any case.
|
||||
|
||||
Regression Testing
|
||||
==================
|
||||
The query scripts are done-ish, need to verify more data so it can be used in automated regression testing.
|
||||
|
||||
Database Backends
|
||||
=================
|
||||
- MySQL InnoDB is the default
|
||||
- PostgreSQL should work but I haven't tried it. If it doesn't please let me know.
|
||||
- MySQL ISAM won't be supported since it is not transactional
|
||||
|
||||
Legal
|
||||
=====
|
||||
General: This will offer more or less the same kind of functionality as HM and PT so there shouldn't be any problem on any site that allows tracking.
|
||||
PS: I have asked them and they said that due to the fast changing nature
|
||||
of pre-release software they don't review that. However, looking at their
|
||||
posted guidelines we're fine
|
||||
FTP: I sent them an email and what I described there was ok for them.
|
||||
I will write them again for "certification" on release of 1.0
|
||||
|
||||
To avoid any misunderstandings, PS and FTP obviously do not sponsor, endorse, or support fpdb. They allow using it, that's all. Any problems with fpdb should be reported to us, not the poker site.
|
||||
|
||||
A note on viewing/tracking mucked hands. Many people will say this is cheating. I agree. However, I don't make the rules on these sites. The sites that store mucked hands into the history file clearly think that being able to see other people's mucked hands is ok. This software - like HM and PT - merely takes info provided by the poker site and makes it more easily accessible.
|
||||
Apparently PS has now turned this off :)
|
||||
|
||||
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
|
||||
Loading…
Reference in New Issue
Block a user