Menu
▾
▴
[csms-cvs] csms-core README.txt,NONE,1.1
|
From: <rga...@us...> - 2002-10-22 17:22:19
|
Update of /cvsroot/csms/csms-core In directory usw-pr-cvs1:/tmp/cvs-serv9664 Added Files: README.txt Log Message: Added a readme to help get users started. --- NEW FILE: README.txt --- Community Sports Management SYstem ================================== Our mission is to build a community and software system to support the growth and development of sports clubs of all types. We aim to bring these valuable real world communities together in the virtual world of the Internet. The objective is to encourage more participation in sports clubs of all types by all people whether they be players, organisers or supporters. About This Release ================== This release is our first public release and emobodies an Automated Scoring System for fantasy sports games. This software *is not* ready for use in the live calculations as yet since it is in alpha form, that is it is undergoing rigourous testing at. When we get to the point that there are no (unreported) automated errors then we will adopt the software as the primary score generator in ou ronline fanatasy football game (see http://www.fanfoot.com). At this point we will begin building the league management software. ===================== Fantasy Sports Module ===================== The fantasy sports module scrapes online sources of information (such as game commentaries) and generates a database of possible scoring events from those sources. Thse events are then processed to generate actual scores for the players according to a scoring configuration file. Installing the application ========================== This application requires a version of Java of at least version 1.4 (available from www.javasoft.com) A zip file of the control centre is available. Unzip the application in a location of your choice. Public CVS access is available, please see http://csms.sourceforge.net/downloadAndInstall for details. Running the Application ======================= To run the application cd to the bin directory inside the install directory. and run the startup script with the command fsm. The User Interface ================== Once running the you should select file|Parse URL (or file|Parse File if you have commentaries saved on your local disk) and wait for about a minute or so. At this stage processing is quite slow as all configuration files are downloaded over the internet and no caching is currently in place. Furthermore, visual feedback is limited to minimal messages in the shell where you executed the fanfoot script. Performance will be improved at a later date, as will the visual feedback. The application currently presents a graphical interface to the system. There are three menus: File - used to point to a local file or an URL of a file to be processed, currently the system only works with BBC commentaries on Barclaycard Premiership Games. However, the system is highly configurable through XML and XSL files and it is easy to enable other sources of information to be scraped for scoring events. See below for more details. Configure - Not currently working (will be used to set paths to configuration files) Debug - runs the system against a standard test file with a single clik, useful when testing changes to configuration files. Interpreting the results ======================== Once the parsing process is complete a number of tabs will appear in the GUI. These will show the events detected in the process, the XML file representing those events, the XML file representing the scores and an HTML representatio of those scores. The most useful tab is by far the HTML summary one. This presents a summary of individual players scores. A list of errors (should any have occurred) and a breakdown of how players scores are calculated. This HTML page is created by passing the scores XML document through an XSL file. Currently this file is fixed as the one located at http://www.fanfoot.com/test/Score2HTML.xsl, in a later release this will become configurable. For now, you can only change this file if you have write access to that file. Support ======= Support is available via our online support request system at https://sourceforge.net/tracker/?atid=509509&group_id=65029&func=browse. Please search this system for an answer to your problem before posting a question. Players Database ================ We have tried to detect all errors in the calculation of points (although we are bound to miss some). These errors are listed in the errors section of the scores XML and HTML documents. They usually relate to being unable to find either a players team or full name in the players database. The database is currently a single XML file located at http://www.fanfoot.com/players.xml. If you have write access to this file, feel free to correct any errors in the database, if you do not have write access to this file please notify us of the bug through the bug reporting system at http://sourceforge.net/tracker/?group_id=65029&atid=509508 and we will address it as soon as we can. In a future release these configuration files will be local to your application and thus you will be able to edit them and provide us with patches. Errors in score Calculations ============================ If a score is calculated incorrectly there are two possible causes of this. The first (and most likely) is that the patterns matching the event description in the commentary is incomplete or incorrect. The other type of problem is in the translation of the events into points. If you come across any of these errors please report the bug on our bug tracking system at http://sourceforge.net/tracker/?group_id=65029&atid=509508. Bug Reporting ============= If you spot any problems at all please report them on our bug tracking system at http://sourceforge.net/tracker/?group_id=65029&atid=509508. Feature Requests ================ We welcome feature requrest from potential users, please post all requests on or Feature Request tracking system at https://sourceforge.net/tracker/?atid=509511&group_id=65029&func=browse Contributing ============ This is an Open Source development effort and as such we encourage your participation. Unfortunately with this release this participation is limited to testing since it is not possible to configure the application to use different configuration files than those on the fanfoot server. This will be resolved very soon. In the meantime you are welcome to join our developer mailing list at http://sourceforge.net/mail/?group_id=65029. If you do wish to contribute please take a look at our project constitution which describes ways that you can contribute positively. ALternatively simply join our mailing list (http://sourceforge.net/mail/?group_id=65029) and ask how you can help, or take a look at the outstanding tasks on our task management system (http://sourceforge.net/pm/?group_id=65029) |
