Updated readme file.

This commit is contained in:
Znote 2014-02-06 10:46:12 +01:00
parent ff29e40256
commit 29a7de9751

View File

@ -1,17 +1,60 @@
ZnoteAAC ZnoteAAC
======== ========
Developement repository for the Znote AAC project. ### What is Znote AAC?
TODO 1.5:
- TFS 1.0 House system
- TFS 1.0 Guilds
- TFS 1.0 Livestream
- TFS 1.0 LUA scripts (Shop system, first items)
TODO 1.6: Znote AAC is a full-fledged website used together with an Open Tibia(OT) server.
- Recovery key It aims to be super easy to install and compatible with all the popular OT distributions.
- Email system It is created in PHP with a simple custom procedural framework.
- Character auction house for shop points
- Database shop offers ### Where do I download?
- Manage shop offers without touching code
- Live TFS 1.0 integration The stable version is available on otland, while the developement version is here on github.
* [Stable: Znote AAC 1.4](http://otland.net/threads/znote-aac-1-4-tfs-0-2-13-tfs-0-3-6-0-4.166722/)
* [Developement: Znote AAC 1.5] (https://github.com/Znote/ZnoteAAC/archive/master.zip)
**NOTE:** Developement version supports TFS 1.0, but you can expect bugs to occur.
### Compatible OT distributions
Znote AAC primarily aims to be compatible with [Forgotten Server] (https://github.com/otland/forgottenserver)
Forgotten Server is commonly known as TFS (The Forgotten Server) and Znote AAC supports these versions:
* TFS 0.2.13+ (Since initial release)
* TFS 0.3.6+ (Since Znote AAC 1.2)
* TFS 1.0+ (Since Znote AAC 1.5)
### Installation instructions
1: Extract the .zip file to your web directory (Example: C:\UniServ\www\ )
Without modifying config.php, enter the website and wait for mysql connection error.
This will show you the rest of the instructions as well as the mysql schema.
2: Edit config.php and:
- modify $config['TFSVersion'] with correct TFS version you are running. (TFS_02, TFS_03, TFS_10).
- modify $config['page_admin_access'] with your admin account username(s).
- modify $config['salt'] with true or false if you have salt activated in config.lua(On the OT server) for password security.
3: Before inserting correct SQL connection details, visit the website ( http://127.0.0.1/ ), it will generate a mysql schema you should import to your OT servers database.
4: Follow the steps on the website and import the SQL schema for Znote AAC, and edit config.php with correct mysql details.
5: IF you have existing database from active OT server, enter the folder called "special" and convert the database for Znote AAC support ( http://127.0.0.1/special/ )
6: Enjoy Znote AAC. You can look around [HERE] (http://otland.net/forums/website-applications.118/) for plugins and resources to Znote AAC, for instance various free templates to use.
### This is the developement repository for the Znote AAC project.
# TODO 1.5:
* TFS 1.0 House system
* TFS 1.0 Guilds
* TFS 1.0 LUA scripts (Shop system, first items)
# TODO 1.6:
* Recovery key
* Email system
* Character auction house for shop points
* Database shop offers
* Manage shop offers without touching code
* Live TFS 1.0 integration
# Removed from TODO:
* TFS 1.0 Livestream (Since Hani rejected to release sources for this I have no intention of adding support for it).