Add the Core files for Cluster.
[UnsignedByte.git] / README
blob2e6ce1923256011b8be09fb35d35fc61040108c1
1 Build instructions:
2 * Install Sqlite3:
3 This can be done either through the official website (http://sqlite3.org), your distribution's package manager, or by using the Sqlite3 makefile in the src/Sqlite3 subdirectory. If you do, you'll need to rename the resulting libMySqlite3.a (which can then be found in UnsignedByte/lib) to libsqlite3.a, since all projects use that name.
5 * Compile everything
6 This can be done by typing the following:
7 make 
8 This is the makefile exported by CodeLite (see http://codelite.sf.net) and will compile the following:
9 * the Sockets, Anders Hedstrom's socket library.
10 * the Resources, these are general resources needed by UB.
11 * the DAL, The UBDal library, a Database Access Layer for C++.
12 * the Generator, the generator used to create strongly typed fields and tables (although you won't need it).
13 * the DB, the generated strongly typed fields and tables.
14 * the Initializer, which can be used to generate the sqlite3 database with the appropriate structure and some initial values.
15 * the Core, the most important part of the code, this wraps all the somewhat raw stuff from Resources and glues it together.
16 * the Server, this is just the main routine which starts the game at the entry point from Core.
17 * the TestCases, a simple file for testing out UB's features without the Server hassle.
19 * Run the Initializer
20 You can find the Initializer in the bin/ subdirectory after having compiled the Resources.
21 This can be done by typing the following:
22 cd UnsignedByte
23 ./Initialize
25 * Run the Server
26 The Server is located in the same directory as the Initializer.
27 This can be done by typing the following:
28 ./UnsignedByte
30 The default login is 'hp' with password 'qq'. The 'hp' name is defined in GameVersion.h (which can be found in src/Resource) and the 'qq' is defined in Initializer.cpp (which can be found in src/Initializer). A default character has also been created, named 'hp'.
32 Have fun!