ALEXCELI.ORG

DOCUMENT PURPOSE
This purpose of this project plan is to outline the tasks and deliverables required to reach various developmental milestones . With this plan we will be able to better gauge what progress has been made as well as what tasks and deliverables need to be completed.

DOCUMENT HISTORY
***IF YOU EDIT THIS DOCUMENT IN ANY WAY WHATSOEVER PLEASE ADD AN ENTRY HERE ***

*** IF YOU EDIT THIS POST PLEASE DON’T SCREW UP THE SPACING OR FORMATTING. THANKS IN ADVANCE ***

July 30, 2006 (Anzel): This is the initial project plan for SWG EMU. It is meant to be a framework for the other members of the EMU team as well as the EMU community to build upon. PLEASE NOTE: This first draft is subject to revisions by other members of the team based solely on their subjectivity and digretion.

July 31, 2006 (Anzel): Added information regarding EMU TRE.

July 31, 2006 (Antman): Zone and Login Servers ARE separated as much as need be.

I. PROJECT ARCHITECTURE:

a. TIERS: The EMU is currently a 3 tier application (see below).

i. TIER 1: Zone Server
ii. TIER 2: Login Server
iii. TIER 3: Database Server

b. LAYERS: Perhaps the most important aspect of this plan is to better define the logical layers that the EMU implements.

i. Database Layer (DB Layer): This is currently a MySQL database. The purpose of this layer will be to store and manage galaxy data for the EMU. The MySQL database will contain all of the tables and stored procedures necessary to support the remaining layers.
ii. Data Access Layer (DAL): The DAL will be the only interface between the DB layer and the rest of the application. For the MySQL implementation of the EMU the DAL should make use of SQL Stored Procedures rather than the use of inline SQL. All layers above the DAL should NOT have any data access code whatsoever.
iii. Packet Delivery Layer (PDL): All of the network packets required to be sent between the EMU client and server are to be defined in the PDL. Any other module or object that has a need to deliver or receive network packets should reference the PDL.
iv. Galaxy Definition Layer (GDL): All of the objects required for the login server and galaxy server tier should be contained in the GDL. GDL objects should reference the PDL and DAL in order to maintain complete functionality.

c. SUPPORTING APPLICATIONS: In addition to the server distribution we will also need two key support applications in order to achieve our development goals.

i. EMU Launcher: This application will allow a user to manage a list of Galaxies to connect to. Currently our official EMU Launcher is Jump To Freedom by Ravatar.
ii. EMU Administrator: This application will allow a server administrator to control the galaxy database through the use of a forms application rather than directly editing the MySQL database.
iii. EMU TRE: We will need a small application to pack resources into a SWG .tre file which the client will recognize and read. This will allow servers to repackage assests from other publishes such as faction armor and expansion rewards as well as custom paintings, clothing, etc.

II. PROJECT SCOPE:
Since the goal of this project is to emulate publish 13 of SWG the items which are considered to be in scope will be defined by the TASKS AND DELIVERABLES section below. SWG publish 13 was a product that had undergone over 4 years of development and it would be impossible to recreate all of its systems and features in a reasonable amount of time. Therefore we are going to need to be judicious when choosing which systems to include in the first version of the EMU.

a. EXCLUSIONS: The following systems and features will be explicitly excluded in the first version of SWG EMU.

i. Crafting
ii. Creature Handler / Pets
iii. Vehicles
iv. Shuttles
v. Resource Mining
vi. Entertainer Buffs
vii. Image Design (as a profession)
viii. Politician
ix. Player Cities
x. Jump To Light Speed
xi. Dungeons
xii. JEDI

III. TASKS AND DELIVERABLES

a. Login Server

i. DB Layer Tasks
ii. DAL Tasks
iii. PDL Tasks
iv. GDL Tasks

b. Character Creation

i. DB Layer Tasks
ii. DAL Tasks
iii. PDL Tasks
iv. GDL Tasks

c. Zone Server

i. Zone Insertion and Removal
ii. Zone Range
iii. Zone Update
iv. Zone Stability and Load
v. Movement
vi. Chat System
vii. Tells
viii. Emotes
ix. System Messages
x. System Broadcast
xi. Player Attributes (HAM)
xii. Player Skills and Skill Modifications
xiii. Player Titles

1. Set title using /setcurrentSkilltitle
2. Set title using UI
3. Restrict titles based on player skills

xiv. Player Items (Inventory)

1. Clothing

a. Clothing Customization

i. Set Color
2. Consumables
3. Buffs
4. Weapons
5. Tangible Items
6. Containers (Backpacks)
xv. Waypoints

1. Create Waypoints
2. Auto-warp/Shuttle?

xvi. Trade System
xvii. Bazaar System
xviii. Mail System
xix. Combat System

1. Base Combat

a. Trainers
b. Special Attacks
c. States

2. PvP
3. PvE
xx. Mission System

1. Non-Faction Missions
2. Faction Missions
3. Quests

xxi. NPC System

1. NPC Wild Spawns
2. NPC AI
3. NPC Loot System

xxii. GCW

1. Faction Recruiters
2. Faction Ranks
3. Faction Rewards

xxiii. Player Housing

1. Place Structure
2. Name Structure
3. Admin/Entry List
4. Structure Maintenance
5. Decorate Structure
6. Destroy Structure
7. Reclaim Structure
8. Move Structure???

xxiv. Player Guilds

1. Place Guild Hall
2. Create Guild
3. Name Guild
4. Guild Permissions
5. Member Management
6. Disband Guild

Part 1: Getting the Goods

1.) Download all of these files:

http://tortoisesvn.sourceforge.net/downloads
http://msdn.microsoft.com/vstudio/express/visualc/download/
http://www.microsoft.com/downloads/details.aspx?FamilyId=A55B6B43-E24F-4EA3-A93E-40C0EC4F68E5&displaylang=en
http://dev.mysql.com/downloads/mysql/5.0.html
http://www.navicat.com/
http://www.emukettemoor.com/swgemu_client.zip

(You must have Windows SP 2 to install the SDK!)

2.) After downloading all of the files, install them in this order (RECOMMENDED):

Service Pack 2
Windows® Server 2003 Platform SDK Web Install
Tortoise SVN
VStudio 2005
MySQL We will be running this from the auto install! We will also be installing it into the C:\MySQL folder. Don’t forget when installing to choose customize, and install EVERYTHING. That way there cannot be any missing folders. This step is probably vital to not getting any errors.
Navicat

Part 2: Compiling the Core

1.) Create a new folder on your desktop. The name doesn’t matter, but I named mine SWGEmu.

2.) Right click that folder, and press SVN Checkout. When a window comes up, for the “URL of repository box”, paste in: http://opensvn.csie.org/SWGEmuPub/ Next, for revision, make sure head is selected.

3.) After the files are done downloading, run VStudio Compiler. It’s located under Start->All Programs->Visual C++ 2005 Express Edition.

4.) When it opens, go to Tools->Options->Projects and Solutions-> VC++ Directories. Open the dropdown menu under Show Directories for, and select include files.

5.) Under $(VCInstallDir)include add a new line by clicking the folder or pressing Ctrl + Insert. In that line, type C:\MySQL\include

6.) Next, select Library Files from the same dropdown menu, and for the new line, add in C:\MySQL\lib\opt

7.) Go back to the main Visual C++ screen. Go to file -> open -> project / solution.

8.) Browse to the SWGEmu root directory (The folder you Tortoise SVN-d) and then go to Win32. Open up swgemu-vc8.sln

9.) Press F7 or go to the Build menu, then build solution.

10.) If there are ANY errors, here are the solutions (Thanks ramsey and users!)

Q) fatal error LNK1104: cannot open file ‘libmysql.lib’
A) Tools -> Options -> Projects and Solutions -> VC++ Directorys
Then at the top right, click on library files
Add a path to the library which should be here: C:\MySQL\MySQL Server 5.0\lib\opt
If you installed it in the default path, it should be here:
C:\Program Files\MySQL\MySQL Server 5.0\lib\opt

~~~~~~~~~~~~

Q) mysql.h couldnt be found.
A) Tools -> Options -> Projects and Solutions -> VC++ Directorys
Then at the top right, click on include files
Add a path to the library which should be here: C:\MySQL\MySQL Server 5.0\include
If you installed it in the default path, it should be here:
C:\Program Files\MySQL\MySQL Server 5.0\include

Still getting the error? Go to Database_Mysql.h. Find: #include
Replace with: #include

~~~~~~~~~~~~

Q) winsock2.h missing
A) Make sure you install the platform sdk which can be found here:
http://forums.swgemu.com/viewtopic.php?t=2701

~~~~~~~~~~~~

Q) libmysql.dll is missing when i try to run the server.
A) \MySQL\MySQL Server 5.0\lib\opt
There should be a libmysql.dll. Drag that to your C:\WINDOWS\system folder. NOT system32. system.

~~~~~~~~~~~~

Part 3: MySQL and you!

1.) The first thing you want to do, is take note of the password you entered in when you were installing MySQL. If you didn’t enter one that’s fine, but if you did you WILL have to use that.

2.) Okay, you’re server should be up, since the MySQL should be the autoinstaller version.

3.) Open up Navicat, which is in the Premiumsoft folder in All Programs.

4.) Click the connections button in the semi-top left hand part of the screen. The connection name doesn’t matter too much, but I set mine as SWGEmu. Leave the hostname to localhost and the port to default (3306). The username will be root, (Unless you entered in a username for your mysql, which I’m not sure is possible since I can’t remember ) and the password will be blank or the password you entered in whilst installing MySQL. Press test connection. If it doesn’t connect, you either have a firewall messing stuff up, or you typed the username and password wrong.

5.) A new server should show up! Yay! Now, right click on it and press new database. You’ll want to name it swgemu (I believe it’s case-sensitive) and leave the character set to default.

6.) On the new database, you want to right click, then press execute batch file. Select swgemu.sql from MySQL in your SWGEmu folder.

7.) Go do debug, then config in your SWGEmu folder, edit config and enter in the information listed. If you’re running on your home PC you probably only need to change the password that you entered in when you installed MySQL.

8.) With the unused zip, currently named as swgemu_client.zip you have sitting on your computer, it is now time to finally get into the game! Open up that zip and copy it into your LEGIT (I hope ) SWG directory. Mine is C:\Program Files\StarWarsGalaxies. Copy all the files located in that zip to your directory. Now, if you are up to date on the patches, or have at least patch 13 installed, you’ll be set. If you don’t have any patches or something under 13, you’ll have to get them off the SWG website. If you’re OVER, take out ANY file with the prefix patch. Don’t delete them if you plan on going back into NGE. (If you even wanted to ). It’s pretty sad that a game that only has the function of walking around the environment is more compelling to play than the NGE.

9.) If you’ve played the NGE or any other version of SWG lately, you can just take out anything but the files patch_00.tre – patch_13_00.tre. Take all the other patch files out.

10.) Make a shortcut of SWGEmu.exe somewhere. Right click it, then choose properties. After that, add this to the target field.

11.) Run SWGEmu_Setup.exe to set up your screen resolution, etc. After you’re done, press okay and get out of that. Now, run the SWGEmu.exe in your emu folder under debug. Then, open the SWGEmu shortcut you modified the target of. Wait till the login screen shows, then log in under test. The password will be test. You can now run around. Yay! Or in a better looking phrase

YOU CAN NOW PLAY PRE-CU SWG! Yay! Oh…and just incase you didn’t notice…YOU CAN ALSO STOP SPAMMING “I NEED HELP ZOMG!!1” IN THE IRC. thx.

Have fun, please, read this before you ask any questions.

Troubleshooting:

Compiling Errors:
If you are getting errors such as winsock.h/windows.h and have reinstalled the SDK, follow the steps on this link:

http://msdn.microsoft.com/vstudio/express/visualc/usingpsdk/

Ignore step 5.

Next, You need to copy the files in the SDK’s include folder into VC’s include folder and copy the files in SDK’s lib folder into VC’s lib-folder.

The SDK’s director is C:\Program Files\Microsoft Platform SDK\

-------------------------------------------------------------------------
SWGEmu - Setting up and running the Publish 12.1/13 Client. By Ultyma.
(c)2006 SWGEmu Team. www.swgemu.com
-------------------------------------------------------------------------

1) Download the client from somewhere....

SWG TRES IF YOU NEED THEM
-------------------------
http://forums.station.sony.com/swg/board/message?board.id=Techsupport&message.id=295177

2) Extract the archive to your SWG directory. (Usually c:program filesStarWarsGalaxies)

3) Open up swgemu_login.cfg in notepad, and change the loginServerAddress0 IP address
to the server address that you would like to play on. (Or leave it at 127.0.0.1 for local).

4) Right click swgemu.exe and create a shortcut to it.

5) Right click the newly created shortcut, and change the Target field to the following:
"C:Program FilesStarWarsGalaxiesSWGEmu.exe" -- -s Station  subscriptionFeatures=1 gameFeatures=255

Note: If your SWG directory is different just modify that to the correct path. Leave the quotes on!

6) To run the game, just double click the shortcut. Voila. That simple. Login, and have fun.

NOTE:
If you are having problems getting the skill/emote/mood list to show up, its because its an error
between publish 12.1 and publish 13.

If you have SWG Explorer, open up the patch_12_00.tre. And extra ui_skill.inc from /ui to /ui in your
StarWarsGalaxies directory.

That SHOULD fix the skills/emotes not showing up in the command browser.

CRASHES
--------------
ERROR: unknown location : FATAL 82674e4e: unsupported SlotIdManager file format [0004]
CAUSE: You dont have all of the patches.
SOLUTION: Patch your SWG installation to AT LEAST publish 13.

-------------------------------------------------------------------------------------------------------
www.swgemu.com