********************************************
* Frets on Fire Score Chart v1.3 *
* by Morten Sneftrup Pedersen *
* http://sourceforge.net/projects/fofchart *
********************************************
-------------------------------------------------------------------
| Table of Contents |
-------------------------------------------------------------------
1. Introduction
2. Requirements
3. Installation
- 3.1 Modify Connections
- 3.2 Populate the Database
- 3.3 Copy Files
- 3.4 Edit fretsonfire.ini
4. References
5. Notes
-------------------------------------------------------------------
| 1. Introduction |
-------------------------------------------------------------------
Frets on Fire Score Chart is a series of scripts that allows you
to run your own score chart on your website. It works with the
standard Frets on Fire client, with minor modifications.
-------------------------------------------------------------------
| 2. Requirements |
-------------------------------------------------------------------
This release no longer requires python. Only a webserver, PHP and
MySQL is needed.
- Apache webserver (works on 2.2.4)
- PHP (works on 5.2.1)
- MySQL server (works on 5.0.27)
For an easy solution for local installation, install the Wamp
server. It includes Apache, PHP and MySQL in a single easy to
install package.
See references for links to the required software.
-------------------------------------------------------------------
| 3. Installation |
-------------------------------------------------------------------
This part assumes that you have the webserver running and that PHP
is working. See the installation instructions for the software
for help.
Unzip the archive to some directory. After this, the installation
consists of four parts:
1) Modify connection info in upload.php and chart.php.
2) Populate the database with songs using the supplied script.
3) Copy files to the webserver
4) Edit fretsonfire.ini in your Frets on Fire directory.
3.1 Modify connections:
Locate upload.php and chart.php and change the host, user,
passwd and db variables in both files to the correct info for
your server.
3.2 Populate the database:
Create an empty database in your MySQL database server.
Copy buildDatabase.py from the /tools directory to the root
of your Frets on Fire directory and run it.
Run: buildDatabase.py -init "host" "user" "passwd" "db"
to create the required tables.
After that, you can run buildDatabase -f or -s to either dump
the sql queries to a file that can be imported, or directly
to the database. Run buildDatabase.py without parameters for
more information.
As an option, you can run uploadScores.py to upload all your
scores to you newly created scorechart.
Run: uploadScores.py frets_dir upload_url
e.g. uploadScores.py C:/frets http://www.myhomepage.com/upload.php
3.3 Copy files
Copy upload.php, chart.php, phprealizer.php and
fretscoredisplay.php to the same directory on your webserver.
3.4 Edit fretsonfire.ini
Locate fretsonfire.ini in your fretsonfire directory and change
"uploadurl = http://kempele.fi/~skyostil/python/fretsonfire/upload"
to "uploadurl = http://yourwebserver/fretchartdir/upload.py".
I.E. if you copied the files to the root of your webserver,
and you are running it locally on port 80, you would change it
to "uploadurl = http://localhost/upload.py".
That's it, make sure the webserver and database is running, start
Frets on Fire, set Upload Score to True on the options, and play.
If everything is working, your scores should be added to the
database everytime you finish a song. To see the scores, go to
http://yourwebserver/yourfretsdir/chart.php
chart.php is just a quick example of how you could display the
scores, feel free to use it if you want, or create your own file
in whatever languange you want that can access the database.
-------------------------------------------------------------------
| 4. References |
-------------------------------------------------------------------
Apache webserver: http://www.apache.org
PHP: http://www.php.net
MySQL: http://www.mysql.com
or
Wamp server: http://www.wampserver.com
-------------------------------------------------------------------
| 5. Notes |
-------------------------------------------------------------------
For help, feedback and comments, feel free to email me at:
morten (at) sneftrup (dot) net