DSP Wiki - User contributions [en]

Building the Server

2017-12-14T16:33:41Z

Demolish: fuck symlinks

== Installing & Setting up the DS Server on Windows ==

=== Prerequisites ===

In this section we will download every program/tool we will need to setup and maintain the servers. Do not install these yet.

[http://dev.mysql.com/downloads/mysql/ MySQL Community Server] (flag)
-Or-
[http://dev.mysql.com/downloads/installer/5.6.html/ MySQL Community Server 5.6 (Updated)] (flag)
-Or-
[https://downloads.mariadb.org/ MariaDB]

[http://dev.mysql.com/downloads/workbench/ MySQL Workbench]

[https://www.visualstudio.com/downloads/ Visual Studio 2017 (Community is fine)]

[https://git-for-windows.github.io/ Git For Windows]

[https://tortoisegit.org/ TortoiseGit]

[https://www.microsoft.com/en-ca/download/details.aspx?id=48145 Visual C++ Redistributable Runtimes 2015]

[http://www.microsoft.com/download/en/details.aspx?id=21 .Net 3.5 Runtime] (already comes with Win 7)

[http://www.microsoft.com/download/en/details.aspx?id=22 .Net 3.5sp1 Runtime] (already comes with Win 7)

[http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=17851 .Net 4 Runtime]

=== Installation ===

==== MySql ====
(flag)

Choose Typical Installation

After the main installation, select Launch the MySQL Instance Configuration Wizard

Select Detailed Configuration

Select Developer Machine

Select Multi-functional Database

Standard Installation Directory

Select Manual Setting and 1000 Concurrent connections

Select Enable TCP/IP Networking, Port Number 3306, and Enable Strict Mode

Select Best Support for Multilingualism

Select Install as Windows Service, Launch the MySQL Server automatically, and Include Bin Directory in Windows PATH.

Select Modify Security Settings, and enter a new password twice. Write down the MySQL password.
(DO NOT LEAVE BLANK.)

Select Next, Execute, then Finish

==== MySQL 5.6 '''(Updated)'''====
Note: Server is x86, but will install 32-bit and 64-bit binaries.

Accept License Terms

Skip Check for updates

Select Developer Default

Check requirements and click Execute - will launch installers for anything you're missing

Default Installation - ~5min

Default Configuration - Check box for "Show Advance Options" - Click Next

Enter MySQL Root Password, twice. Remember it! - Click Next

It will show windows service details, leave as default and Click Next

It will show Logging options, leave as default and Click Next

Configuration will complete, Click Next

Samples and examples will configure - ~5min - Click Next

Click Finish

==== MySQL Workbench ====

Use default installation options. This can still be installed and will still function even if you use MariaDB instead of stock MySQL. It will generate a few warnings from by a version number check that you can safely ignore.

==== Visual Studio 2017 ====

Any edition works. Community is free.

Make sure you install Desktop development with C++ when selecting development packages.

==== Git for Windows ====

Use default installation options.

==== TortoiseGit ====

Use default installation options. You can skip the step to reboot since we'll reboot once everything else is installed.

==== Visual C++ Redistributable Runtime 2015 ====

Use default installation options.

==== .Net 4.6 (or higher) ====

Use default installation options. It probably comes with your Visual Studio install anyway. Dot Net Frameworks always come with all prior versions packed in, so you never need to install multiple versions.

At this point everything should be installed that needs to be and you can restart your PC to finalize them.

=== Downloading the Server Source Code ===

'''In this section we will use TortoiseGit to download the latest git source code for the server.'''

Open Windows Explorer (right click the start button and choose Windows Explorer)

Right click on any folder select Git Clone

In the "URL" field put in the following url:

<code><nowiki>http://github.com/DarkstarProject/darkstar.git</nowiki></code>

Set the "Directory" to your choice (blank will default to current location /darkstar

Click OK.

Wait for the download to finish.

Click OK to close TortoiseGit.

Close windows explorer

At this point you have downloaded all of the source code for the latest version.

If you are not planning on doing any development, it's advised to use the stable branch instead of master. Right click on your darkstar folder, and go to TortoiseGit -> Switch/Checkout.
Change the branch dropdown to remotes/origin/stable and hit OK.

=== Setting up the Database ===

'''In this section we will use the data that you downloaded to build a database in MySQL.'''

==== Using a bat script ====

If you follow this step, you may skip the next one.

Paste the following into notepad and save it as DSP_Import.bat in your dsp\sql folder:

<pre>
@ECHO OFF
REM =============================================================================
REM =============================================================================
REM ====== =========
REM ====== THis script will drop the DB specificed, then create the DB =========
REM ====== specified, and then load all .sql tables from its run dir to =========
REM ====== the the DB. =========
REM ====== =========
REM ====== File needs to be run from within the \dsp\sql folder (same =========
REM ====== folder with all the .sql files. Please edit as needed. By =========
REM ====== default it WILL DROP the standard dspdb DB, loosing all =========
REM ====== accounts and characters. If this is not desired, then update =========
REM ====== the file to load the new DB into a new DB name. =========
REM ====== =========
REM ====== Update -p with MySQL password. If you password is 'foo', =========
REM ====== then change '-pMYSQLPASS' to '-pfoo' (3 places). =========
REM ====== =========
REM ====== If you want to use a different database name, change 'dspdb' =========
REM ====== with a database name of your choosing. =========
REM ====== =========
REM =============================================================================
REM =============================================================================
REM ====== =========
REM ====== by Thrydwolf 9/8/2012 =========
REM ====== Updated with status by bluekirby0 3/30/2012 =========
REM ====== Updated by Thrydwolf 9/18/2012 =========
REM ====== =========
REM =============================================================================
REM =============================================================================

ECHO Creating Database dspdb
"c:\program files\mysql\mysql server 5.6\bin\mysqladmin"-h localhost -u root -pMYSQLPASS DROP dspdb

ECHO Creating Database dspdb
"c:\program files\mysql\mysql server 5.6\bin\mysqladmin"-h localhost -u root -pMYSQLPASS CREATE dspdb

ECHO Loading dspdb tables into the database
cd c:\darkstar\sql
FOR %%X IN (*.sql) DO ECHO Importing %%X & "c:\program files\mysql\mysql server 5.6\bin\mysql" dspdb -h localhost -u root -pMYSQLPASS < %%X

ECHO Finished!
</pre>

At a minimum you will need to change -pMYSQLPASS in the script to where root is your mysql root password. If your password is 'foo' then you would use '-pfoo' instead. You may also have to change the path of your mysql installation as well (for example, if you installed a different version of mysql)

You can use this script any time the repository is updated, but it will drop the table and thus delete all your player data. You may want to make manual changes instead unless you are using it purely as a test server.

After you've done your initial load, you can use the following script that will preserve character data
<pre>
cd c:\darkstar\sql
del auction_house.sql
del chars.sql
del accounts.sql
del accounts_banned.sql
del char_effects.sql
del char_equip.sql
del char_exp.sql
del char_inventory.sql
del char_jobs.sql
del char_look.sql
del char_pet.sql
del char_pet_name.sql
del char_points.sql
del char_profile.sql
del char_skills.sql
del char_spells.sql
del char_stats.sql
del char_storage.sql
del char_vars.sql
del char_weapon_skill_points.sql
del chars.sql
del conquest_system.sql
del delivery_box.sql
del linkshells.sql
FOR %%X IN (*.sql) DO ECHO Importing %%X & "c:\program files\mysql\mysql server 5.6\bin\mysql" dspdb -h localhost -u root -pMYSQLPASS < %%X
</pre>

==== Using Navicat ====

'''NOTE:''' ''The free edition of Navicat was discontinued ages ago. No more support or bugfixes are released for it. And even if you use the latest commercial release, it will do annoying things like surround every field of a dump in single quotes. If you pull request an sql change that places single quotes on number fields on 30,000 lines Teo reserves the right to main you. Just kidding. Or am I?'' ''':)''' ''Alternatives include Heidisql, mysql workbench, and many others that are free and open sourced. Same functionality, different layout on screen.''

This is the more hands-on approach, and being comfortable doing it this way may make it easier to update individual tables later without having to learn the mysql command-line interface.

Open Navicat

Click Connection (or File, New Connection)

Connection name: DarkStar

Host Name/IP: localhost

Port: 3306

User Name: root

Password: Enter the password you wrote down during the mySQL installation.

Check Save Password

Click OK

In the connections pane double click DarkStar

Right click on DarkStar and select New Database...

Name it dspdb

Use the Default character set

Select OK.

Double click dspdb

Right click on dspdb and select Execute SQL File...

Browse to C:\dsp\sql and select abilities.sql

Click Start

Continue this process for each file in the folder.

If you have an issue with the triggers.sql file then follow this step. If not, proceed to the next step (IP address for the map server):

In Navicat Open accounts table

Click File, Design Table

Click the Triggers tab

There should a line already listed with account_delete in the Name field

If not:

click Add Trigger

Name column should be account_delete

Fires column should be Before

Check the box in the Delete column

In the definition box below add the following code:

<pre>
DELETE FROM `accounts_banned` WHERE `accid` = OLD.id;
DELETE FROM `chars` WHERE `accid` = OLD.id;
</pre>

Select Save and then close the table.

Open the chars table

Click File, Design Table

Click the Triggers tab

There should already be a line listed with char_delete in the name field.

If not:

click Add Trigger

Name column should be char_delete

Fires column should be Before

Check the box in the Delete column

In the definition box below add the following code:

<pre>
DELETE FROM `char_exp` WHERE `charid` = OLD.charid;
DELETE FROM `char_jobs` WHERE `charid` = OLD.charid;
DELETE FROM `char_equip` WHERE `charid` = OLD.charid;
DELETE FROM `char_effects` WHERE `charid` = OLD.charid;
DELETE FROM `char_look` WHERE `charid` = OLD.charid;
DELETE FROM `char_stats` WHERE `charid` = OLD.charid;
DELETE FROM `char_skills` WHERE `charid` = OLD.charid;
DELETE FROM `char_titles` WHERE `charid` = OLD.charid;
DELETE FROM `char_inventory` WHERE `charid` = OLD.charid;
DELETE FROM `char_vars` WHERE `charid` = OLD.charid;
</pre>

Select Save and then close the table.

Note: Leave Navicat open for the next section.

==== Configure the ZoneIP for the Map Server ====

Now you need to determine what IP address that will be used for the Map Server, then update MySQL with it.

Most devs & enthusiasts will not have a separate map server, but will run both map server and login server on the same PC.

1. Determine what IP address will be used for the map server.

If the server will be public, then use your external IP in the next step. (Looks really random like 173.194.43.104)

If the server will be internal and you want it available on other PCs in your internal network, use the internal network IP (192.168.x.x) in the next step.

If you only plan to run the client and the server on the same PC, you can use the localhost address (127.0.0.1) in the next step.

2. Update the zone_settings table with the ip
(flag)
In Navicat double click on the table dspdb and expand

Click on Query

Right click and select New Query

Add the following code into the empty space, inserting the value calculated above. The value in the code below (127.0.0.1) would be used if only running the client from the same PC as the server.

<pre>
UPDATE zone_settings SET zoneip = '127.0.0.1';
</pre>

Select Run. You should get a message stating that many (280+) records were changed.

I recommend you save the Query in case you need to run it again later after updating the server.

Close Navicat.

=== Building the Servers ===

'''In this section we will be building the Dark Star servers.'''

Dark Star uses 3 separate servers. A Login server, a Map/Game server, and an optional Search/Auction House server. Using the ZoneIP mentioned earlier, every map could run on its own server at a different IP address. If you have 4 computers each computer could run different areas, as long as they were all connected to the same MySQL database server.

==== Build the Server ====

Open Visual Studio

Click File, Open, Project/Solution (or Ctrl+Shift+O)

Navigate to C:\dsp\win32

Select darkstar.sln

It may take a few minutes to load files.

Optional: if your cpu can handle it, enable multi-core compiling like so http://i.imgur.com/GCjdsdG.png (do this for all 3, or just DSGameServer since that's where most the compile time goes).

Click Debug then Build Server (or Ctrl+Shift+B)

Building will take a few minutes.

Once complete, validate that there are no Errors listed in the summary line at the bottom. It should look like this:

<pre>========== Build: 3 succeeded, 0 failed, 0 up-to-date, 0 skipped ==========</pre>

If there are any SQL errors it is probably caused by the SQL dev package was extracted to the wrong folder.

If there is a #include error, change that #include to say #include <mysql/mysql.h>

==== When all of the Servers are built ====

Verify in the C:\dsp directory that the servers you built are there:

DSConnect-server.exe for the Login Server

DSGame-server.exe for the Map Server

DSSearch-server.exe for the Search Server

=== Configuring the Servers ===

'''Now you will configure the Login Server and Map Server to connect to the MySQL database.'''

Do not mess with any other settings in these files unless you know what they are for and what they do.

==== Login Server Settings ====

In windows explorer navigate to c:\dsp\conf

Open login_darkstar.conf in a text editer (notepad)

Scroll down to the bottom and validate/update the following lines:

<pre>
mysql_host: 127.0.0.1
mysql_port: 3306
mysql_login: root
mysql_password: root <-- change this to your password you wrote down during the MySQL install (flag)
mysql_database: dspdb
</pre>

==== Map Server Settings ====

In windows explorer navigate to c:\dsp\conf

Open map_darkstar.conf in a text editer (notepad)

Scroll down to the bottom and validate/update the following lines:

<pre>
mysql_host: 127.0.0.1
mysql_port: 3306
mysql_login: root
mysql_password: root <-- change this to your password you wrote down during the MySQL install (flag)
mysql_database: dspdb
</pre>

==== Search Server Settings ====

In windows explorer navigate to c:\dsp\conf

Open search_server.conf in a text editer (notepad)

Scroll down to the bottom and validate/update the following lines:

<pre>
mysql_host: 127.0.0.1
mysql_port: 3306
mysql_login: root
mysql_password: root <-- change this to your password you wrote down during the MySQL install (flag)
mysql_database: dspdb
</pre>

At this point we have configured the servers to connect to the SQL database.

=== Starting the Servers ===

'''In this section we will launch our new servers.'''

Navigate to c:\dsp

Run DSConnect-server.exe as Admin

Run DSGame-server.exe as Admin

(Optional) Run DSSearch-server.exe as Admin

At this point if your servers fail to load, you probably missed a step. Go back through the steps and try to find out what you missed. It may also be helpful to look at the log files located in c:\dsp\log.

=== Forward Ports to Allow Others to Join (& Firewall) ===

'''In this section we will provide the port numbers that need to be forwarded to the server. This is only needed to allow people outside your local intranet to join your server.'''

In your router and firewall the following ports need to be opened/forwarded to your server:

<pre>
TCP Ports:
54230
54231
54001
54002

UDP Port:
54230
</pre>

If still having trouble, disable any firewall software completely for testing. This includes the Windows firewall that comes on all modern Windows systems, which can be found in the Control Panel.

== Installing & Setting up the DS Server on Linux ==

The server is known to build in recent [http://www.ubuntu.com/ Ubuntu] versions (14.04), and is tested regularly against it.

Generic build instructions for most POSIX (GNU/Linux, and possibly FreeBSD, NetBSD, UNIX or even OSX with some additional work) systems follow. Some knowledge of how to compile software on your distribution is assumed. You may find it helpful to reference the Windows guide above if something is unclear.

=== Prerequisites: ===

==== Install on Ubuntu ====

sudo apt-get install git mysql-server libmysqlclient-dev libluajit-5.1-dev libzmq3-dev autoconf pkg-config

'''Ubuntu 14.04 needs gcc 7'''.
sudo su -
apt-get update
apt-get install -y software-properties-common
add-apt-repository -y ppa:ubuntu-toolchain-r/test
apt-get update
apt-get install -y luajit-5.1-dev libzmq3-dev g++-7 mysql-client-core-5.6 mysql-server-5.6 mysql-client-5.6
update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-7 90

==== Other Distros ====

A compiler with C++17 support. Currently tested with GCC and G++, and requires a minimum version of 7

Git to retrieve the source code.

Autotools (automake autoconf m4sh) and pkg-config to generate the configure script and Makefile

mysql server

mysql client library (select the developer version if your distro has on)

luajit library version 5.1 or higher (select the developer version if your distro has one)

libzmq (select the developer version if your distro has one)

If you plan to run from a console, you may also wish to install "screen" as there is no daemon mode for the servers yet.

=== Preparing the Source Code ===

Once you have everything mentioned above installed, grab the latest source from the repository via the command:
<nowiki>git clone http://github.com/DarkstarProject/darkstar.git/</nowiki>

If you are not planning on doing development, it's advised to checkout the stable branch:
<nowiki>git checkout stable</nowiki>

=== Compiling ===

Next is a typical autotools build. Run the autogen script, followed by configure, and then make (GNU make: if your cpu has multiple cores and you wish to utilise them to speed up the build, use '''make -j#CoresMultipliedBy1.5''' e.g. '''make -j4''' if it has 3 cores instead of just '''make''' in the step below):
sh autogen.sh
./configure --enable-debug=gdb
make

You can choose not to configure with debug enabled, but there is very little potential gain in this and it prevents many useful break statements from triggering. The Makefile also has separate targets to build each server named "dsconnect" "dsgame" and "dssearch" but will build all 3 if none are specified.

=== Setting Up the Database ===

If you do not know your mysql root password, the default on most systems is blank. It is a good idea to change this for security reasons, as your mysql root user has full permissions on all databases. The first time you run the mysql client, you should be prompted to change the password. After doing so, you will want to create a user specifically for dealing with the darkstar server database. Run mysql as follows:
mysql -u root -p

Enter your root password at the prompt. Next, create a new user as follows:
CREATE USER 'darkstar'@'localhost' IDENTIFIED BY 'password';

Substitute "password" with a password of your choice. Next, we want to create a database, and set up our new user with permissions to work with it.
CREATE DATABASE dspdb;
USE dspdb;
GRANT ALL PRIVILEGES ON dspdb.* TO 'darkstar'@'localhost';
exit

This will make it to where your new user can do anything necessary, but can only connect from localhost, so even if your password is compromised, it will be difficult to mess with the database remotely. If you need to be able to access the database remotely (like if the database is stored on a separate machine from the server), change the configuration according to the host that will be accessing the database.

Now, you need to populate the database.
cd sql
for f in *.sql
do
echo -n "Importing $f into the database..."
mysql dspdb -u darkstar -ppassword < $f && echo "Success"
done
cd ..

To set up your ZoneIP, see the related windows section [[Building_the_Server#Configure_the_ZoneIP_for_the_Map_Server]] above for how to calculate it, and then run:
mysql -u darkstar -ppassword
USE dspdb;
UPDATE zone_settings SET zoneip = '127.0.0.1';
exit

replacing "127.0.0.1" with the value you determined in your calculation. You should see a message that at least 256 changes have occured after the update command.

=== Configuring the Server ===
Before running your new servers, you will need to update the configuration files to tell it how to talk to the database. You will need to update the files in the conf/ sub-folder named "login_darkstar.conf" "map_darkstar.conf" and "search_server.conf" at a minimum. Find the mysql settings in each and change as appropriate, using the new user, password and database you created earlier.

You may also wish to browse through the various configuration files for any settings that might be of interest to you, but more details on server customization can be found at [[Customizing Your Server]].

=== Starting the Servers ===
You may now start your new servers. If you are using a desktop environment, you may wish to open 3 separate terminals and run each server in a separate one to monitor them efficiently. Otherwise, you will want to run them in screen sessions as follows:
screen -d -m -S dsconnect ./dsconnect
screen -d -m -S dsgame ./dsgame
screen -d -m -S dssearch ./dssearch

This will start and auto-detach all three servers, assigning them meaningful names to make it easy to reattach later by using the commands:
screen -r dsconnect

or
screen -r dsgame

or
screen -r dssearch

to monitor a given server. Once you've attached to a screen, you can detach by first pressing "ctrl+a" and then "d". There are many other useful ways to use screen, so do whatever suits yoru preference.

Your server is now up-and-running, and a client should be able to connect as long as there are no obvious errors on any of the server screens. If the search server is having issues, it is not vital for basic game functionality, but you will be unable to use search functions or the auction house. If you have run into any major issues, contact bluekirby0 (the current maintainer of the linux port as of the time of this writing) on Discord or in the [http://forums.dspt.info forums].

== Automatic Server Restarts & Crash Logs ==

If your server goes down, no one can connect. If it goes down when you're not looking, it can be down for an extended period of time. To fix this, you probably want to have a way to have your server auto-restart. In addition, it's good to know when the server crashed.
===Getting the software===
First, you'll want to download Knas Restarter here: [http://www.knas.se/Applications/Restarter.aspx].
===Creating the Logging files===
In the dsp directory where your game, connect, and search server reside, create a 'tools' folder. In the folder create 4 new text files by right clicking, and going to New > Text Document

Make sure you have file extension view turned on so that you can see the .txt at the end.

Rename the 4 files to the following:

connect_crash.bat <Change the file type to bat file, deleting .txt

connect_crash_log.txt

game_crash.bat <Change the file type to bat file, deleting .txt

game_crash_log.txt

Right click on connect_crash.bat and click 'edit'
Place the following inside:
echo %date% %time% >> connect_crash_log.txt
Save and close

Right click on game_crash.bat and click 'edit'
Place the following inside:
echo %date% %time% >> game_crash_log.txt
Save and close

===Connect Server Restart===
Launch Knas Restarter
Find DSConnect-server.exe and click on it
Click "Select"
Change itnerval to 10 seconds
Under "Restart Paramters";
Check Keep restarter minimized
in "Working Directory" enter the directory where dsp is installed
Under Actions;
Check "External Script" and browse to your tools folder and select connect_crash.bat
Click "Create Shortcut" and save to your desktop

===Game Server Restart===
Launch Knas Restarter
Find DSGame-server.exe and click on it
Click "Select"
Change itnerval to 10 seconds
Under "Restart Paramters";
Check Keep restarter minimized
in "Working Directory" enter the directory where dsp is installed
Under Actions;
Check "External Script" and browse to your tools folder and select game_crash.bat
Click "Create Shortcut" and save to your desktop

===Launching===
Open the shortcuts you created on your desktop, and open the search server as you normally would.

Crash logs will be found in the text files you created in the tools directory showing the date and time the crash occurred.
===Problems===
In some Windows opperating systems, a window will pop up saying the program has crashed, leaving the crashed program up and preventing an auto-restart. This can be avoided by disabling the user interface for critical errors. To do this follow these steps:

Start > Run gpedit.msc

Computer Configuration > Administrative Templates > Windows Components > Windows Error Reporting
Set Prevent Display of the user interface for critical errors" to Enabled

== Common Errors ==

=== Getting Errors on Load / In Game ===

You have to run all changed sql files! Be careful you keep zoneip correct in zone_settings.sql.

=== Can't Connect to Game Server ===

Make sure your zoneip in zone_settings table is correct. Also make sure packets can reach the 53445 port.

Restart server after changing zoneip.

=== Packet or key is invalid: ===

Restart login server, game server and game client.

=== make: *** No rule to make target ===

Delete .deps

<pre>
source autogen.sh
./configure
make
</pre>

=== MySQL Error 1067 Invalid default value for 'timecreate' or whatever time related ===
<pre>
mysql -uUSER -pPASS -hlocalhost dspdb -e "set sql_mode = '';"
</pre>
and try again

== Credits ==
The original windows guide was written by thrydwolf, and has been formatted for the wiki and updated by bluekirby0

Building the Server

2017-09-26T07:40:16Z

Demolish: /* Common Errors */

== Installing & Setting up the DS Server on Windows ==

=== Prerequisites ===

In this section we will download every program/tool we will need to setup and maintain the servers. Do not install these yet.

[http://dev.mysql.com/downloads/mysql/ MySQL Community Server] (flag)
-Or-
[http://dev.mysql.com/downloads/installer/5.6.html/ MySQL Community Server 5.6 (Updated)] (flag)
-Or-
[https://downloads.mariadb.org/ MariaDB]

[http://dev.mysql.com/downloads/workbench/ MySQL Workbench]

[https://www.visualstudio.com/downloads/ Visual Studio 2017 (Community is fine)]

[https://git-for-windows.github.io/ Git For Windows]

[https://tortoisegit.org/ TortoiseGit]

[https://www.microsoft.com/en-ca/download/details.aspx?id=48145 Visual C++ Redistributable Runtimes 2015]

[http://www.microsoft.com/download/en/details.aspx?id=21 .Net 3.5 Runtime] (already comes with Win 7)

[http://www.microsoft.com/download/en/details.aspx?id=22 .Net 3.5sp1 Runtime] (already comes with Win 7)

[http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=17851 .Net 4 Runtime]

=== Installation ===

==== MySql ====
(flag)

Choose Typical Installation

After the main installation, select Launch the MySQL Instance Configuration Wizard

Select Detailed Configuration

Select Developer Machine

Select Multi-functional Database

Standard Installation Directory

Select Manual Setting and 1000 Concurrent connections

Select Enable TCP/IP Networking, Port Number 3306, and Enable Strict Mode

Select Best Support for Multilingualism

Select Install as Windows Service, Launch the MySQL Server automatically, and Include Bin Directory in Windows PATH.

Select Modify Security Settings, and enter a new password twice. Write down the MySQL password.
(DO NOT LEAVE BLANK.)

Select Next, Execute, then Finish

==== MySQL 5.6 '''(Updated)'''====
Note: Server is x86, but will install 32-bit and 64-bit binaries.

Accept License Terms

Skip Check for updates

Select Developer Default

Check requirements and click Execute - will launch installers for anything you're missing

Default Installation - ~5min

Default Configuration - Check box for "Show Advance Options" - Click Next

Enter MySQL Root Password, twice. Remember it! - Click Next

It will show windows service details, leave as default and Click Next

It will show Logging options, leave as default and Click Next

Configuration will complete, Click Next

Samples and examples will configure - ~5min - Click Next

Click Finish

==== MySQL Workbench ====

Use default installation options. This can still be installed and will still function even if you use MariaDB instead of stock MySQL. It will generate a few warnings from by a version number check that you can safely ignore.

==== Visual Studio 2017 ====

Any edition works. Community is free.

Make sure you install Desktop development with C++ when selecting development packages.

==== Git for Windows ====

Use default installation options.

==== TortoiseGit ====

Use default installation options. You can skip the step to reboot since we'll reboot once everything else is installed.

==== Visual C++ Redistributable Runtime 2015 ====

Use default installation options.

==== .Net 4.6 (or higher) ====

Use default installation options. It probably comes with your Visual Studio install anyway. Dot Net Frameworks always come with all prior versions packed in, so you never need to install multiple versions.

At this point everything should be installed that needs to be and you can restart your PC to finalize them.

=== Downloading the Server Source Code ===

'''In this section we will use TortoiseGit to download the latest git source code for the server.'''

Open Windows Explorer (right click the start button and choose Windows Explorer)

Right click on any folder select Git Clone

In the "URL" field put in the following url:

<code><nowiki>http://github.com/DarkstarProject/darkstar.git</nowiki></code>

Set the "Directory" to your choice (blank will default to current location /darkstar

Click OK.

Wait for the download to finish.

Click OK to close TortoiseGit.

Close windows explorer

At this point you have downloaded all of the source code for the latest version.

If you are not planning on doing any development, it's advised to use the stable branch instead of master. Right click on your darkstar folder, and go to TortoiseGit -> Switch/Checkout.
Change the branch dropdown to remotes/origin/stable and hit OK.

=== Setting up the Database ===

'''In this section we will use the data that you downloaded to build a database in MySQL.'''

==== Using a bat script ====

If you follow this step, you may skip the next one.

Paste the following into notepad and save it as DSP_Import.bat in your dsp\sql folder:

<pre>
@ECHO OFF
REM =============================================================================
REM =============================================================================
REM ====== =========
REM ====== THis script will drop the DB specificed, then create the DB =========
REM ====== specified, and then load all .sql tables from its run dir to =========
REM ====== the the DB. =========
REM ====== =========
REM ====== File needs to be run from within the \dsp\sql folder (same =========
REM ====== folder with all the .sql files. Please edit as needed. By =========
REM ====== default it WILL DROP the standard dspdb DB, loosing all =========
REM ====== accounts and characters. If this is not desired, then update =========
REM ====== the file to load the new DB into a new DB name. =========
REM ====== =========
REM ====== Update -p with MySQL password. If you password is 'foo', =========
REM ====== then change '-pMYSQLPASS' to '-pfoo' (3 places). =========
REM ====== =========
REM ====== If you want to use a different database name, change 'dspdb' =========
REM ====== with a database name of your choosing. =========
REM ====== =========
REM =============================================================================
REM =============================================================================
REM ====== =========
REM ====== by Thrydwolf 9/8/2012 =========
REM ====== Updated with status by bluekirby0 3/30/2012 =========
REM ====== Updated by Thrydwolf 9/18/2012 =========
REM ====== =========
REM =============================================================================
REM =============================================================================

ECHO Creating Database dspdb
"c:\program files\mysql\mysql server 5.6\bin\mysqladmin"-h localhost -u root -pMYSQLPASS DROP dspdb

ECHO Creating Database dspdb
"c:\program files\mysql\mysql server 5.6\bin\mysqladmin"-h localhost -u root -pMYSQLPASS CREATE dspdb

ECHO Loading dspdb tables into the database
cd c:\darkstar\sql
FOR %%X IN (*.sql) DO ECHO Importing %%X & "c:\program files\mysql\mysql server 5.6\bin\mysql" dspdb -h localhost -u root -pMYSQLPASS < %%X

ECHO Finished!
</pre>

At a minimum you will need to change -pMYSQLPASS in the script to where root is your mysql root password. If your password is 'foo' then you would use '-pfoo' instead. You may also have to change the path of your mysql installation as well (for example, if you installed a different version of mysql)

You can use this script any time the repository is updated, but it will drop the table and thus delete all your player data. You may want to make manual changes instead unless you are using it purely as a test server.

After you've done your initial load, you can use the following script that will preserve character data
<pre>
cd c:\darkstar\sql
del auction_house.sql
del chars.sql
del accounts.sql
del accounts_banned.sql
del char_effects.sql
del char_equip.sql
del char_exp.sql
del char_inventory.sql
del char_jobs.sql
del char_look.sql
del char_pet.sql
del char_pet_name.sql
del char_points.sql
del char_profile.sql
del char_skills.sql
del char_spells.sql
del char_stats.sql
del char_storage.sql
del char_vars.sql
del char_weapon_skill_points.sql
del chars.sql
del conquest_system.sql
del delivery_box.sql
del linkshells.sql
FOR %%X IN (*.sql) DO ECHO Importing %%X & "c:\program files\mysql\mysql server 5.6\bin\mysql" dspdb -h localhost -u root -pMYSQLPASS < %%X
</pre>

==== Using Navicat ====

'''NOTE:''' ''The free edition of Navicat was discontinued ages ago. No more support or bugfixes are released for it. And even if you use the latest commercial release, it will do annoying things like surround every field of a dump in single quotes. If you pull request an sql change that places single quotes on number fields on 30,000 lines Teo reserves the right to main you. Just kidding. Or am I?'' ''':)''' ''Alternatives include Heidisql, mysql workbench, and many others that are free and open sourced. Same functionality, different layout on screen.''

This is the more hands-on approach, and being comfortable doing it this way may make it easier to update individual tables later without having to learn the mysql command-line interface.

Open Navicat

Click Connection (or File, New Connection)

Connection name: DarkStar

Host Name/IP: localhost

Port: 3306

User Name: root

Password: Enter the password you wrote down during the mySQL installation.

Check Save Password

Click OK

In the connections pane double click DarkStar

Right click on DarkStar and select New Database...

Name it dspdb

Use the Default character set

Select OK.

Double click dspdb

Right click on dspdb and select Execute SQL File...

Browse to C:\dsp\sql and select abilities.sql

Click Start

Continue this process for each file in the folder.

If you have an issue with the triggers.sql file then follow this step. If not, proceed to the next step (IP address for the map server):

In Navicat Open accounts table

Click File, Design Table

Click the Triggers tab

There should a line already listed with account_delete in the Name field

If not:

click Add Trigger

Name column should be account_delete

Fires column should be Before

Check the box in the Delete column

In the definition box below add the following code:

<pre>
DELETE FROM `accounts_banned` WHERE `accid` = OLD.id;
DELETE FROM `chars` WHERE `accid` = OLD.id;
</pre>

Select Save and then close the table.

Open the chars table

Click File, Design Table

Click the Triggers tab

There should already be a line listed with char_delete in the name field.

If not:

click Add Trigger

Name column should be char_delete

Fires column should be Before

Check the box in the Delete column

In the definition box below add the following code:

<pre>
DELETE FROM `char_exp` WHERE `charid` = OLD.charid;
DELETE FROM `char_jobs` WHERE `charid` = OLD.charid;
DELETE FROM `char_equip` WHERE `charid` = OLD.charid;
DELETE FROM `char_effects` WHERE `charid` = OLD.charid;
DELETE FROM `char_look` WHERE `charid` = OLD.charid;
DELETE FROM `char_stats` WHERE `charid` = OLD.charid;
DELETE FROM `char_skills` WHERE `charid` = OLD.charid;
DELETE FROM `char_titles` WHERE `charid` = OLD.charid;
DELETE FROM `char_inventory` WHERE `charid` = OLD.charid;
DELETE FROM `char_vars` WHERE `charid` = OLD.charid;
</pre>

Select Save and then close the table.

Note: Leave Navicat open for the next section.

==== Configure the ZoneIP for the Map Server ====

Now you need to determine what IP address that will be used for the Map Server, then update MySQL with it.

Most devs & enthusiasts will not have a separate map server, but will run both map server and login server on the same PC.

1. Determine what IP address will be used for the map server.

If the server will be public, then use your external IP in the next step. (Looks really random like 173.194.43.104)

If the server will be internal and you want it available on other PCs in your internal network, use the internal network IP (192.168.x.x) in the next step.

If you only plan to run the client and the server on the same PC, you can use the localhost address (127.0.0.1) in the next step.

2. Update the zone_settings table with the ip
(flag)
In Navicat double click on the table dspdb and expand

Click on Query

Right click and select New Query

Add the following code into the empty space, inserting the value calculated above. The value in the code below (127.0.0.1) would be used if only running the client from the same PC as the server.

<pre>
UPDATE zone_settings SET zoneip = '127.0.0.1';
</pre>

Select Run. You should get a message stating that many (280+) records were changed.

I recommend you save the Query in case you need to run it again later after updating the server.

Close Navicat.

=== Building the Servers ===

'''In this section we will be building the Dark Star servers.'''

Dark Star uses 3 separate servers. A Login server, a Map/Game server, and an optional Search/Auction House server. Using the ZoneIP mentioned earlier, every map could run on its own server at a different IP address. If you have 4 computers each computer could run different areas, as long as they were all connected to the same MySQL database server.

==== Build the Server ====

Open Visual Studio

Click File, Open, Project/Solution (or Ctrl+Shift+O)

Navigate to C:\dsp\win32

Select darkstar.sln

It may take a few minutes to load files.

Optional: if your cpu can handle it, enable multi-core compiling like so http://i.imgur.com/GCjdsdG.png (do this for all 3, or just DSGameServer since that's where most the compile time goes).

Click Debug then Build Server (or Ctrl+Shift+B)

Building will take a few minutes.

Once complete, validate that there are no Errors listed in the summary line at the bottom. It should look like this:

<pre>========== Build: 3 succeeded, 0 failed, 0 up-to-date, 0 skipped ==========</pre>

If there are any SQL errors it is probably caused by the SQL dev package was extracted to the wrong folder.

If there is a #include error, change that #include to say #include <mysql/mysql.h>

==== When all of the Servers are built ====

Verify in the C:\dsp directory that the servers you built are there:

DSConnect-server.exe for the Login Server

DSGame-server.exe for the Map Server

DSSearch-server.exe for the Search Server

=== Configuring the Servers ===

'''Now you will configure the Login Server and Map Server to connect to the MySQL database.'''

Do not mess with any other settings in these files unless you know what they are for and what they do.

==== Login Server Settings ====

In windows explorer navigate to c:\dsp\conf

Open login_darkstar.conf in a text editer (notepad)

Scroll down to the bottom and validate/update the following lines:

<pre>
mysql_host: 127.0.0.1
mysql_port: 3306
mysql_login: root
mysql_password: root <-- change this to your password you wrote down during the MySQL install (flag)
mysql_database: dspdb
</pre>

==== Map Server Settings ====

In windows explorer navigate to c:\dsp\conf

Open map_darkstar.conf in a text editer (notepad)

Scroll down to the bottom and validate/update the following lines:

<pre>
mysql_host: 127.0.0.1
mysql_port: 3306
mysql_login: root
mysql_password: root <-- change this to your password you wrote down during the MySQL install (flag)
mysql_database: dspdb
</pre>

==== Search Server Settings ====

In windows explorer navigate to c:\dsp\conf

Open search_server.conf in a text editer (notepad)

Scroll down to the bottom and validate/update the following lines:

<pre>
mysql_host: 127.0.0.1
mysql_port: 3306
mysql_login: root
mysql_password: root <-- change this to your password you wrote down during the MySQL install (flag)
mysql_database: dspdb
</pre>

At this point we have configured the servers to connect to the SQL database.

=== Starting the Servers ===

'''In this section we will launch our new servers.'''

Navigate to c:\dsp

Run DSConnect-server.exe as Admin

Run DSGame-server.exe as Admin

(Optional) Run DSSearch-server.exe as Admin

At this point if your servers fail to load, you probably missed a step. Go back through the steps and try to find out what you missed. It may also be helpful to look at the log files located in c:\dsp\log.

=== Forward Ports to Allow Others to Join (& Firewall) ===

'''In this section we will provide the port numbers that need to be forwarded to the server. This is only needed to allow people outside your local intranet to join your server.'''

In your router and firewall the following ports need to be opened/forwarded to your server:

<pre>
TCP Ports:
54230
54231
54001
54002

UDP Port:
54230
</pre>

If still having trouble, disable any firewall software completely for testing. This includes the Windows firewall that comes on all modern Windows systems, which can be found in the Control Panel.

== Installing & Setting up the DS Server on Linux ==

The server is known to build in recent [http://www.ubuntu.com/ Ubuntu] versions (14.04), and is tested regularly against it.

Generic build instructions for most POSIX (GNU/Linux, and possibly FreeBSD, NetBSD, UNIX or even OSX with some additional work) systems follow. Some knowledge of how to compile software on your distribution is assumed. You may find it helpful to reference the Windows guide above if something is unclear.

=== Prerequisites: ===

==== Install on Ubuntu ====

sudo apt-get install git mysql-server libmysqlclient-dev libluajit-5.1-dev libzmq3-dev autoconf pkg-config

'''Ubuntu 14.04 needs gcc 7'''.
sudo su -
apt-get update
apt-get install -y software-properties-common
add-apt-repository -y ppa:ubuntu-toolchain-r/test
apt-get update
apt-get install -y luajit-5.1-dev libzmq3-dev g++-7 mysql-client-core-5.6 mysql-server-5.6 mysql-client-5.6
update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-7 90

cd /usr/bin
rm gcc g++ cpp
ln -s gcc-5 gcc
ln -s g++-5 g++
ln -s cpp-5 cpp

==== Other Distros ====

A compiler with C++17 support. Currently tested with GCC and G++, and requires a minimum version of 7

Git to retrieve the source code.

Autotools (automake autoconf m4sh) and pkg-config to generate the configure script and Makefile

mysql server

mysql client library (select the developer version if your distro has on)

luajit library version 5.1 or higher (select the developer version if your distro has one)

libzmq (select the developer version if your distro has one)

If you plan to run from a console, you may also wish to install "screen" as there is no daemon mode for the servers yet.

=== Preparing the Source Code ===

Once you have everything mentioned above installed, grab the latest source from the repository via the command:
<nowiki>git clone http://github.com/DarkstarProject/darkstar.git/</nowiki>

If you are not planning on doing development, it's advised to checkout the stable branch:
<nowiki>git checkout stable</nowiki>

=== Compiling ===

Next is a typical autotools build. Run the autogen script, followed by configure, and then make (GNU make: if your cpu has multiple cores and you wish to utilise them to speed up the build, use '''make -j#CoresMultipliedBy1.5''' e.g. '''make -j4''' if it has 3 cores instead of just '''make''' in the step below):
sh autogen.sh
./configure --enable-debug=gdb
make

You can choose not to configure with debug enabled, but there is very little potential gain in this and it prevents many useful break statements from triggering. The Makefile also has separate targets to build each server named "dsconnect" "dsgame" and "dssearch" but will build all 3 if none are specified.

=== Setting Up the Database ===

If you do not know your mysql root password, the default on most systems is blank. It is a good idea to change this for security reasons, as your mysql root user has full permissions on all databases. The first time you run the mysql client, you should be prompted to change the password. After doing so, you will want to create a user specifically for dealing with the darkstar server database. Run mysql as follows:
mysql -u root -p

Enter your root password at the prompt. Next, create a new user as follows:
CREATE USER 'darkstar'@'localhost' IDENTIFIED BY 'password';

Substitute "password" with a password of your choice. Next, we want to create a database, and set up our new user with permissions to work with it.
CREATE DATABASE dspdb;
USE dspdb;
GRANT ALL PRIVILEGES ON dspdb.* TO 'darkstar'@'localhost';
exit

This will make it to where your new user can do anything necessary, but can only connect from localhost, so even if your password is compromised, it will be difficult to mess with the database remotely. If you need to be able to access the database remotely (like if the database is stored on a separate machine from the server), change the configuration according to the host that will be accessing the database.

Now, you need to populate the database.
cd sql
for f in *.sql
do
echo -n "Importing $f into the database..."
mysql dspdb -u darkstar -ppassword < $f && echo "Success"
done
cd ..

To set up your ZoneIP, see the related windows section [[Building_the_Server#Configure_the_ZoneIP_for_the_Map_Server]] above for how to calculate it, and then run:
mysql -u darkstar -ppassword
USE dspdb;
UPDATE zone_settings SET zoneip = '127.0.0.1';
exit

replacing "127.0.0.1" with the value you determined in your calculation. You should see a message that at least 256 changes have occured after the update command.

=== Configuring the Server ===
Before running your new servers, you will need to update the configuration files to tell it how to talk to the database. You will need to update the files in the conf/ sub-folder named "login_darkstar.conf" "map_darkstar.conf" and "search_server.conf" at a minimum. Find the mysql settings in each and change as appropriate, using the new user, password and database you created earlier.

You may also wish to browse through the various configuration files for any settings that might be of interest to you, but more details on server customization can be found at [[Customizing Your Server]].

=== Starting the Servers ===
You may now start your new servers. If you are using a desktop environment, you may wish to open 3 separate terminals and run each server in a separate one to monitor them efficiently. Otherwise, you will want to run them in screen sessions as follows:
screen -d -m -S dsconnect ./dsconnect
screen -d -m -S dsgame ./dsgame
screen -d -m -S dssearch ./dssearch

This will start and auto-detach all three servers, assigning them meaningful names to make it easy to reattach later by using the commands:
screen -r dsconnect

or
screen -r dsgame

or
screen -r dssearch

to monitor a given server. Once you've attached to a screen, you can detach by first pressing "ctrl+a" and then "d". There are many other useful ways to use screen, so do whatever suits yoru preference.

Your server is now up-and-running, and a client should be able to connect as long as there are no obvious errors on any of the server screens. If the search server is having issues, it is not vital for basic game functionality, but you will be unable to use search functions or the auction house. If you have run into any major issues, contact bluekirby0 (the current maintainer of the linux port as of the time of this writing) on Discord or in the [http://forums.dspt.info forums].

== Automatic Server Restarts & Crash Logs ==

If your server goes down, no one can connect. If it goes down when you're not looking, it can be down for an extended period of time. To fix this, you probably want to have a way to have your server auto-restart. In addition, it's good to know when the server crashed.
===Getting the software===
First, you'll want to download Knas Restarter here: [http://www.knas.se/Applications/Restarter.aspx].
===Creating the Logging files===
In the dsp directory where your game, connect, and search server reside, create a 'tools' folder. In the folder create 4 new text files by right clicking, and going to New > Text Document

Make sure you have file extension view turned on so that you can see the .txt at the end.

Rename the 4 files to the following:

connect_crash.bat <Change the file type to bat file, deleting .txt

connect_crash_log.txt

game_crash.bat <Change the file type to bat file, deleting .txt

game_crash_log.txt

Right click on connect_crash.bat and click 'edit'
Place the following inside:
echo %date% %time% >> connect_crash_log.txt
Save and close

Right click on game_crash.bat and click 'edit'
Place the following inside:
echo %date% %time% >> game_crash_log.txt
Save and close

===Connect Server Restart===
Launch Knas Restarter
Find DSConnect-server.exe and click on it
Click "Select"
Change itnerval to 10 seconds
Under "Restart Paramters";
Check Keep restarter minimized
in "Working Directory" enter the directory where dsp is installed
Under Actions;
Check "External Script" and browse to your tools folder and select connect_crash.bat
Click "Create Shortcut" and save to your desktop

===Game Server Restart===
Launch Knas Restarter
Find DSGame-server.exe and click on it
Click "Select"
Change itnerval to 10 seconds
Under "Restart Paramters";
Check Keep restarter minimized
in "Working Directory" enter the directory where dsp is installed
Under Actions;
Check "External Script" and browse to your tools folder and select game_crash.bat
Click "Create Shortcut" and save to your desktop

===Launching===
Open the shortcuts you created on your desktop, and open the search server as you normally would.

Crash logs will be found in the text files you created in the tools directory showing the date and time the crash occurred.
===Problems===
In some Windows opperating systems, a window will pop up saying the program has crashed, leaving the crashed program up and preventing an auto-restart. This can be avoided by disabling the user interface for critical errors. To do this follow these steps:

Start > Run gpedit.msc

Computer Configuration > Administrative Templates > Windows Components > Windows Error Reporting
Set Prevent Display of the user interface for critical errors" to Enabled

== Common Errors ==

=== Getting Errors on Load / In Game ===

You have to run all changed sql files! Be careful you keep zoneip correct in zone_settings.sql.

=== Can't Connect to Game Server ===

Make sure your zoneip in zone_settings table is correct. Also make sure packets can reach the 53445 port.

Restart server after changing zoneip.

=== Packet or key is invalid: ===

Restart login server, game server and game client.

=== make: *** No rule to make target ===

Delete .deps

<pre>
source autogen.sh
./configure
make
</pre>

=== MySQL Error 1067 Invalid default value for 'timecreate' or whatever time related ===
<pre>
mysql -uUSER -pPASS -hlocalhost dspdb -e "set sql_mode = '';"
</pre>
and try again

== Credits ==
The original windows guide was written by thrydwolf, and has been formatted for the wiki and updated by bluekirby0

Building the Server

2017-09-26T07:19:32Z

Demolish: /* Installing & Setting up the DS Server on Linux */

== Installing & Setting up the DS Server on Windows ==

=== Prerequisites ===

In this section we will download every program/tool we will need to setup and maintain the servers. Do not install these yet.

[http://dev.mysql.com/downloads/mysql/ MySQL Community Server] (flag)
-Or-
[http://dev.mysql.com/downloads/installer/5.6.html/ MySQL Community Server 5.6 (Updated)] (flag)
-Or-
[https://downloads.mariadb.org/ MariaDB]

[http://dev.mysql.com/downloads/workbench/ MySQL Workbench]

[https://www.visualstudio.com/downloads/ Visual Studio 2017 (Community is fine)]

[https://git-for-windows.github.io/ Git For Windows]

[https://tortoisegit.org/ TortoiseGit]

[https://www.microsoft.com/en-ca/download/details.aspx?id=48145 Visual C++ Redistributable Runtimes 2015]

[http://www.microsoft.com/download/en/details.aspx?id=21 .Net 3.5 Runtime] (already comes with Win 7)

[http://www.microsoft.com/download/en/details.aspx?id=22 .Net 3.5sp1 Runtime] (already comes with Win 7)

[http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=17851 .Net 4 Runtime]

=== Installation ===

==== MySql ====
(flag)

Choose Typical Installation

After the main installation, select Launch the MySQL Instance Configuration Wizard

Select Detailed Configuration

Select Developer Machine

Select Multi-functional Database

Standard Installation Directory

Select Manual Setting and 1000 Concurrent connections

Select Enable TCP/IP Networking, Port Number 3306, and Enable Strict Mode

Select Best Support for Multilingualism

Select Install as Windows Service, Launch the MySQL Server automatically, and Include Bin Directory in Windows PATH.

Select Modify Security Settings, and enter a new password twice. Write down the MySQL password.
(DO NOT LEAVE BLANK.)

Select Next, Execute, then Finish

==== MySQL 5.6 '''(Updated)'''====
Note: Server is x86, but will install 32-bit and 64-bit binaries.

Accept License Terms

Skip Check for updates

Select Developer Default

Check requirements and click Execute - will launch installers for anything you're missing

Default Installation - ~5min

Default Configuration - Check box for "Show Advance Options" - Click Next

Enter MySQL Root Password, twice. Remember it! - Click Next

It will show windows service details, leave as default and Click Next

It will show Logging options, leave as default and Click Next

Configuration will complete, Click Next

Samples and examples will configure - ~5min - Click Next

Click Finish

==== MySQL Workbench ====

Use default installation options. This can still be installed and will still function even if you use MariaDB instead of stock MySQL. It will generate a few warnings from by a version number check that you can safely ignore.

==== Visual Studio 2017 ====

Any edition works. Community is free.

Make sure you install Desktop development with C++ when selecting development packages.

==== Git for Windows ====

Use default installation options.

==== TortoiseGit ====

Use default installation options. You can skip the step to reboot since we'll reboot once everything else is installed.

==== Visual C++ Redistributable Runtime 2015 ====

Use default installation options.

==== .Net 4.6 (or higher) ====

Use default installation options. It probably comes with your Visual Studio install anyway. Dot Net Frameworks always come with all prior versions packed in, so you never need to install multiple versions.

At this point everything should be installed that needs to be and you can restart your PC to finalize them.

=== Downloading the Server Source Code ===

'''In this section we will use TortoiseGit to download the latest git source code for the server.'''

Open Windows Explorer (right click the start button and choose Windows Explorer)

Right click on any folder select Git Clone

In the "URL" field put in the following url:

<code><nowiki>http://github.com/DarkstarProject/darkstar.git</nowiki></code>

Set the "Directory" to your choice (blank will default to current location /darkstar

Click OK.

Wait for the download to finish.

Click OK to close TortoiseGit.

Close windows explorer

At this point you have downloaded all of the source code for the latest version.

If you are not planning on doing any development, it's advised to use the stable branch instead of master. Right click on your darkstar folder, and go to TortoiseGit -> Switch/Checkout.
Change the branch dropdown to remotes/origin/stable and hit OK.

=== Setting up the Database ===

'''In this section we will use the data that you downloaded to build a database in MySQL.'''

==== Using a bat script ====

If you follow this step, you may skip the next one.

Paste the following into notepad and save it as DSP_Import.bat in your dsp\sql folder:

<pre>
@ECHO OFF
REM =============================================================================
REM =============================================================================
REM ====== =========
REM ====== THis script will drop the DB specificed, then create the DB =========
REM ====== specified, and then load all .sql tables from its run dir to =========
REM ====== the the DB. =========
REM ====== =========
REM ====== File needs to be run from within the \dsp\sql folder (same =========
REM ====== folder with all the .sql files. Please edit as needed. By =========
REM ====== default it WILL DROP the standard dspdb DB, loosing all =========
REM ====== accounts and characters. If this is not desired, then update =========
REM ====== the file to load the new DB into a new DB name. =========
REM ====== =========
REM ====== Update -p with MySQL password. If you password is 'foo', =========
REM ====== then change '-pMYSQLPASS' to '-pfoo' (3 places). =========
REM ====== =========
REM ====== If you want to use a different database name, change 'dspdb' =========
REM ====== with a database name of your choosing. =========
REM ====== =========
REM =============================================================================
REM =============================================================================
REM ====== =========
REM ====== by Thrydwolf 9/8/2012 =========
REM ====== Updated with status by bluekirby0 3/30/2012 =========
REM ====== Updated by Thrydwolf 9/18/2012 =========
REM ====== =========
REM =============================================================================
REM =============================================================================

ECHO Creating Database dspdb
"c:\program files\mysql\mysql server 5.6\bin\mysqladmin"-h localhost -u root -pMYSQLPASS DROP dspdb

ECHO Creating Database dspdb
"c:\program files\mysql\mysql server 5.6\bin\mysqladmin"-h localhost -u root -pMYSQLPASS CREATE dspdb

ECHO Loading dspdb tables into the database
cd c:\darkstar\sql
FOR %%X IN (*.sql) DO ECHO Importing %%X & "c:\program files\mysql\mysql server 5.6\bin\mysql" dspdb -h localhost -u root -pMYSQLPASS < %%X

ECHO Finished!
</pre>

At a minimum you will need to change -pMYSQLPASS in the script to where root is your mysql root password. If your password is 'foo' then you would use '-pfoo' instead. You may also have to change the path of your mysql installation as well (for example, if you installed a different version of mysql)

You can use this script any time the repository is updated, but it will drop the table and thus delete all your player data. You may want to make manual changes instead unless you are using it purely as a test server.

After you've done your initial load, you can use the following script that will preserve character data
<pre>
cd c:\darkstar\sql
del auction_house.sql
del chars.sql
del accounts.sql
del accounts_banned.sql
del char_effects.sql
del char_equip.sql
del char_exp.sql
del char_inventory.sql
del char_jobs.sql
del char_look.sql
del char_pet.sql
del char_pet_name.sql
del char_points.sql
del char_profile.sql
del char_skills.sql
del char_spells.sql
del char_stats.sql
del char_storage.sql
del char_vars.sql
del char_weapon_skill_points.sql
del chars.sql
del conquest_system.sql
del delivery_box.sql
del linkshells.sql
FOR %%X IN (*.sql) DO ECHO Importing %%X & "c:\program files\mysql\mysql server 5.6\bin\mysql" dspdb -h localhost -u root -pMYSQLPASS < %%X
</pre>

==== Using Navicat ====

'''NOTE:''' ''The free edition of Navicat was discontinued ages ago. No more support or bugfixes are released for it. And even if you use the latest commercial release, it will do annoying things like surround every field of a dump in single quotes. If you pull request an sql change that places single quotes on number fields on 30,000 lines Teo reserves the right to main you. Just kidding. Or am I?'' ''':)''' ''Alternatives include Heidisql, mysql workbench, and many others that are free and open sourced. Same functionality, different layout on screen.''

This is the more hands-on approach, and being comfortable doing it this way may make it easier to update individual tables later without having to learn the mysql command-line interface.

Open Navicat

Click Connection (or File, New Connection)

Connection name: DarkStar

Host Name/IP: localhost

Port: 3306

User Name: root

Password: Enter the password you wrote down during the mySQL installation.

Check Save Password

Click OK

In the connections pane double click DarkStar

Right click on DarkStar and select New Database...

Name it dspdb

Use the Default character set

Select OK.

Double click dspdb

Right click on dspdb and select Execute SQL File...

Browse to C:\dsp\sql and select abilities.sql

Click Start

Continue this process for each file in the folder.

If you have an issue with the triggers.sql file then follow this step. If not, proceed to the next step (IP address for the map server):

In Navicat Open accounts table

Click File, Design Table

Click the Triggers tab

There should a line already listed with account_delete in the Name field

If not:

click Add Trigger

Name column should be account_delete

Fires column should be Before

Check the box in the Delete column

In the definition box below add the following code:

<pre>
DELETE FROM `accounts_banned` WHERE `accid` = OLD.id;
DELETE FROM `chars` WHERE `accid` = OLD.id;
</pre>

Select Save and then close the table.

Open the chars table

Click File, Design Table

Click the Triggers tab

There should already be a line listed with char_delete in the name field.

If not:

click Add Trigger

Name column should be char_delete

Fires column should be Before

Check the box in the Delete column

In the definition box below add the following code:

<pre>
DELETE FROM `char_exp` WHERE `charid` = OLD.charid;
DELETE FROM `char_jobs` WHERE `charid` = OLD.charid;
DELETE FROM `char_equip` WHERE `charid` = OLD.charid;
DELETE FROM `char_effects` WHERE `charid` = OLD.charid;
DELETE FROM `char_look` WHERE `charid` = OLD.charid;
DELETE FROM `char_stats` WHERE `charid` = OLD.charid;
DELETE FROM `char_skills` WHERE `charid` = OLD.charid;
DELETE FROM `char_titles` WHERE `charid` = OLD.charid;
DELETE FROM `char_inventory` WHERE `charid` = OLD.charid;
DELETE FROM `char_vars` WHERE `charid` = OLD.charid;
</pre>

Select Save and then close the table.

Note: Leave Navicat open for the next section.

==== Configure the ZoneIP for the Map Server ====

Now you need to determine what IP address that will be used for the Map Server, then update MySQL with it.

Most devs & enthusiasts will not have a separate map server, but will run both map server and login server on the same PC.

1. Determine what IP address will be used for the map server.

If the server will be public, then use your external IP in the next step. (Looks really random like 173.194.43.104)

If the server will be internal and you want it available on other PCs in your internal network, use the internal network IP (192.168.x.x) in the next step.

If you only plan to run the client and the server on the same PC, you can use the localhost address (127.0.0.1) in the next step.

2. Update the zone_settings table with the ip
(flag)
In Navicat double click on the table dspdb and expand

Click on Query

Right click and select New Query

Add the following code into the empty space, inserting the value calculated above. The value in the code below (127.0.0.1) would be used if only running the client from the same PC as the server.

<pre>
UPDATE zone_settings SET zoneip = '127.0.0.1';
</pre>

Select Run. You should get a message stating that many (280+) records were changed.

I recommend you save the Query in case you need to run it again later after updating the server.

Close Navicat.

=== Building the Servers ===

'''In this section we will be building the Dark Star servers.'''

Dark Star uses 3 separate servers. A Login server, a Map/Game server, and an optional Search/Auction House server. Using the ZoneIP mentioned earlier, every map could run on its own server at a different IP address. If you have 4 computers each computer could run different areas, as long as they were all connected to the same MySQL database server.

==== Build the Server ====

Open Visual Studio

Click File, Open, Project/Solution (or Ctrl+Shift+O)

Navigate to C:\dsp\win32

Select darkstar.sln

It may take a few minutes to load files.

Optional: if your cpu can handle it, enable multi-core compiling like so http://i.imgur.com/GCjdsdG.png (do this for all 3, or just DSGameServer since that's where most the compile time goes).

Click Debug then Build Server (or Ctrl+Shift+B)

Building will take a few minutes.

Once complete, validate that there are no Errors listed in the summary line at the bottom. It should look like this:

<pre>========== Build: 3 succeeded, 0 failed, 0 up-to-date, 0 skipped ==========</pre>

If there are any SQL errors it is probably caused by the SQL dev package was extracted to the wrong folder.

If there is a #include error, change that #include to say #include <mysql/mysql.h>

==== When all of the Servers are built ====

Verify in the C:\dsp directory that the servers you built are there:

DSConnect-server.exe for the Login Server

DSGame-server.exe for the Map Server

DSSearch-server.exe for the Search Server

=== Configuring the Servers ===

'''Now you will configure the Login Server and Map Server to connect to the MySQL database.'''

Do not mess with any other settings in these files unless you know what they are for and what they do.

==== Login Server Settings ====

In windows explorer navigate to c:\dsp\conf

Open login_darkstar.conf in a text editer (notepad)

Scroll down to the bottom and validate/update the following lines:

<pre>
mysql_host: 127.0.0.1
mysql_port: 3306
mysql_login: root
mysql_password: root <-- change this to your password you wrote down during the MySQL install (flag)
mysql_database: dspdb
</pre>

==== Map Server Settings ====

In windows explorer navigate to c:\dsp\conf

Open map_darkstar.conf in a text editer (notepad)

Scroll down to the bottom and validate/update the following lines:

<pre>
mysql_host: 127.0.0.1
mysql_port: 3306
mysql_login: root
mysql_password: root <-- change this to your password you wrote down during the MySQL install (flag)
mysql_database: dspdb
</pre>

==== Search Server Settings ====

In windows explorer navigate to c:\dsp\conf

Open search_server.conf in a text editer (notepad)

Scroll down to the bottom and validate/update the following lines:

<pre>
mysql_host: 127.0.0.1
mysql_port: 3306
mysql_login: root
mysql_password: root <-- change this to your password you wrote down during the MySQL install (flag)
mysql_database: dspdb
</pre>

At this point we have configured the servers to connect to the SQL database.

=== Starting the Servers ===

'''In this section we will launch our new servers.'''

Navigate to c:\dsp

Run DSConnect-server.exe as Admin

Run DSGame-server.exe as Admin

(Optional) Run DSSearch-server.exe as Admin

At this point if your servers fail to load, you probably missed a step. Go back through the steps and try to find out what you missed. It may also be helpful to look at the log files located in c:\dsp\log.

=== Forward Ports to Allow Others to Join (& Firewall) ===

'''In this section we will provide the port numbers that need to be forwarded to the server. This is only needed to allow people outside your local intranet to join your server.'''

In your router and firewall the following ports need to be opened/forwarded to your server:

<pre>
TCP Ports:
54230
54231
54001
54002

UDP Port:
54230
</pre>

If still having trouble, disable any firewall software completely for testing. This includes the Windows firewall that comes on all modern Windows systems, which can be found in the Control Panel.

== Installing & Setting up the DS Server on Linux ==

The server is known to build in recent [http://www.ubuntu.com/ Ubuntu] versions (14.04), and is tested regularly against it.

Generic build instructions for most POSIX (GNU/Linux, and possibly FreeBSD, NetBSD, UNIX or even OSX with some additional work) systems follow. Some knowledge of how to compile software on your distribution is assumed. You may find it helpful to reference the Windows guide above if something is unclear.

=== Prerequisites: ===

==== Install on Ubuntu ====

sudo apt-get install git mysql-server libmysqlclient-dev libluajit-5.1-dev libzmq3-dev autoconf pkg-config

'''Ubuntu 14.04 needs gcc 7'''.
sudo su -
apt-get update
apt-get install -y software-properties-common
add-apt-repository -y ppa:ubuntu-toolchain-r/test
apt-get update
apt-get install -y luajit-5.1-dev libzmq3-dev g++-7 mysql-client-core-5.6 mysql-server-5.6 mysql-client-5.6
update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-7 90

cd /usr/bin
rm gcc g++ cpp
ln -s gcc-5 gcc
ln -s g++-5 g++
ln -s cpp-5 cpp

==== Other Distros ====

A compiler with C++17 support. Currently tested with GCC and G++, and requires a minimum version of 7

Git to retrieve the source code.

Autotools (automake autoconf m4sh) and pkg-config to generate the configure script and Makefile

mysql server

mysql client library (select the developer version if your distro has on)

luajit library version 5.1 or higher (select the developer version if your distro has one)

libzmq (select the developer version if your distro has one)

If you plan to run from a console, you may also wish to install "screen" as there is no daemon mode for the servers yet.

=== Preparing the Source Code ===

Once you have everything mentioned above installed, grab the latest source from the repository via the command:
<nowiki>git clone http://github.com/DarkstarProject/darkstar.git/</nowiki>

If you are not planning on doing development, it's advised to checkout the stable branch:
<nowiki>git checkout stable</nowiki>

=== Compiling ===

Next is a typical autotools build. Run the autogen script, followed by configure, and then make (GNU make: if your cpu has multiple cores and you wish to utilise them to speed up the build, use '''make -j#CoresMultipliedBy1.5''' e.g. '''make -j4''' if it has 3 cores instead of just '''make''' in the step below):
sh autogen.sh
./configure --enable-debug=gdb
make

You can choose not to configure with debug enabled, but there is very little potential gain in this and it prevents many useful break statements from triggering. The Makefile also has separate targets to build each server named "dsconnect" "dsgame" and "dssearch" but will build all 3 if none are specified.

=== Setting Up the Database ===

If you do not know your mysql root password, the default on most systems is blank. It is a good idea to change this for security reasons, as your mysql root user has full permissions on all databases. The first time you run the mysql client, you should be prompted to change the password. After doing so, you will want to create a user specifically for dealing with the darkstar server database. Run mysql as follows:
mysql -u root -p

Enter your root password at the prompt. Next, create a new user as follows:
CREATE USER 'darkstar'@'localhost' IDENTIFIED BY 'password';

Substitute "password" with a password of your choice. Next, we want to create a database, and set up our new user with permissions to work with it.
CREATE DATABASE dspdb;
USE dspdb;
GRANT ALL PRIVILEGES ON dspdb.* TO 'darkstar'@'localhost';
exit

This will make it to where your new user can do anything necessary, but can only connect from localhost, so even if your password is compromised, it will be difficult to mess with the database remotely. If you need to be able to access the database remotely (like if the database is stored on a separate machine from the server), change the configuration according to the host that will be accessing the database.

Now, you need to populate the database.
cd sql
for f in *.sql
do
echo -n "Importing $f into the database..."
mysql dspdb -u darkstar -ppassword < $f && echo "Success"
done
cd ..

To set up your ZoneIP, see the related windows section [[Building_the_Server#Configure_the_ZoneIP_for_the_Map_Server]] above for how to calculate it, and then run:
mysql -u darkstar -ppassword
USE dspdb;
UPDATE zone_settings SET zoneip = '127.0.0.1';
exit

replacing "127.0.0.1" with the value you determined in your calculation. You should see a message that at least 256 changes have occured after the update command.

=== Configuring the Server ===
Before running your new servers, you will need to update the configuration files to tell it how to talk to the database. You will need to update the files in the conf/ sub-folder named "login_darkstar.conf" "map_darkstar.conf" and "search_server.conf" at a minimum. Find the mysql settings in each and change as appropriate, using the new user, password and database you created earlier.

You may also wish to browse through the various configuration files for any settings that might be of interest to you, but more details on server customization can be found at [[Customizing Your Server]].

=== Starting the Servers ===
You may now start your new servers. If you are using a desktop environment, you may wish to open 3 separate terminals and run each server in a separate one to monitor them efficiently. Otherwise, you will want to run them in screen sessions as follows:
screen -d -m -S dsconnect ./dsconnect
screen -d -m -S dsgame ./dsgame
screen -d -m -S dssearch ./dssearch

This will start and auto-detach all three servers, assigning them meaningful names to make it easy to reattach later by using the commands:
screen -r dsconnect

or
screen -r dsgame

or
screen -r dssearch

to monitor a given server. Once you've attached to a screen, you can detach by first pressing "ctrl+a" and then "d". There are many other useful ways to use screen, so do whatever suits yoru preference.

Your server is now up-and-running, and a client should be able to connect as long as there are no obvious errors on any of the server screens. If the search server is having issues, it is not vital for basic game functionality, but you will be unable to use search functions or the auction house. If you have run into any major issues, contact bluekirby0 (the current maintainer of the linux port as of the time of this writing) on Discord or in the [http://forums.dspt.info forums].

== Automatic Server Restarts & Crash Logs ==

If your server goes down, no one can connect. If it goes down when you're not looking, it can be down for an extended period of time. To fix this, you probably want to have a way to have your server auto-restart. In addition, it's good to know when the server crashed.
===Getting the software===
First, you'll want to download Knas Restarter here: [http://www.knas.se/Applications/Restarter.aspx].
===Creating the Logging files===
In the dsp directory where your game, connect, and search server reside, create a 'tools' folder. In the folder create 4 new text files by right clicking, and going to New > Text Document

Make sure you have file extension view turned on so that you can see the .txt at the end.

Rename the 4 files to the following:

connect_crash.bat <Change the file type to bat file, deleting .txt

connect_crash_log.txt

game_crash.bat <Change the file type to bat file, deleting .txt

game_crash_log.txt

Right click on connect_crash.bat and click 'edit'
Place the following inside:
echo %date% %time% >> connect_crash_log.txt
Save and close

Right click on game_crash.bat and click 'edit'
Place the following inside:
echo %date% %time% >> game_crash_log.txt
Save and close

===Connect Server Restart===
Launch Knas Restarter
Find DSConnect-server.exe and click on it
Click "Select"
Change itnerval to 10 seconds
Under "Restart Paramters";
Check Keep restarter minimized
in "Working Directory" enter the directory where dsp is installed
Under Actions;
Check "External Script" and browse to your tools folder and select connect_crash.bat
Click "Create Shortcut" and save to your desktop

===Game Server Restart===
Launch Knas Restarter
Find DSGame-server.exe and click on it
Click "Select"
Change itnerval to 10 seconds
Under "Restart Paramters";
Check Keep restarter minimized
in "Working Directory" enter the directory where dsp is installed
Under Actions;
Check "External Script" and browse to your tools folder and select game_crash.bat
Click "Create Shortcut" and save to your desktop

===Launching===
Open the shortcuts you created on your desktop, and open the search server as you normally would.

Crash logs will be found in the text files you created in the tools directory showing the date and time the crash occurred.
===Problems===
In some Windows opperating systems, a window will pop up saying the program has crashed, leaving the crashed program up and preventing an auto-restart. This can be avoided by disabling the user interface for critical errors. To do this follow these steps:

Start > Run gpedit.msc

Computer Configuration > Administrative Templates > Windows Components > Windows Error Reporting
Set Prevent Display of the user interface for critical errors" to Enabled

== Common Errors ==

=== Getting Errors on Load / In Game ===

You have to run all changed sql files! Be careful you keep zoneip correct in zone_settings.sql.

=== Can't Connect to Game Server ===

Make sure your zoneip in zone_settings table is correct. Also make sure packets can reach the 53445 port.

Restart server after changing zoneip.

=== Packet or key is invalid: ===

Restart login server, game server and game client.

=== make: *** No rule to make target ===

Delete .deps

<pre>
source autogen.sh
./configure
make
</pre>

== Credits ==
The original windows guide was written by thrydwolf, and has been formatted for the wiki and updated by bluekirby0

Configuring Your Client

2017-08-23T13:28:52Z

Demolish:

Configuring Your Client

2017-08-23T13:26:47Z

Demolish: /* xiloader instantly closes after entering username and password */

Demolish: /* Finishing off the Mission */

In this page you will learn how to script a mission from scratch as well as some other useful information.

= Getting Started =
This guide assumes you already have a basic understanding of writing quests, if not then I highly recommend reading BlueKirby0's guide: "[http://wiki.dspt.info/index.php/How_to_Make_a_Quest How to Make a Quest]".
If you're too lazy to read over that then don't worry, i'll be going over most things in his guide (but in a lot less detail).

== onTrigger ==

To keep things simple, let's start off with '''Windurst Mission 7-1''' (''The Sixth Ministry'') as it covers most of what we need to go through.

After accepting the Mission, we must go to '''Tosuka-Porika''' in '''Windurst Waters''' for a cutscene, so go ahead open up his script :<code>scripts/zones/Windurst_Waters/Tosuka-Porika.lua</code>.

I recommend using [http://notepad-plus-plus.org Notepad++] to open scripts as it has syntax highlighting and helps keep track of 'if' statements and their 'end's.

Scroll down to the '''onTrigger''' section and we see this:
<pre>
function onTrigger(player,npc)

-- NOTE: cut out lines that are not needed for this guide to keep things simple

if (player:getCurrentMission(COP) == THE_ROAD_FORKS and player:getVar("MEMORIES_OF_A_MAIDEN_Status")==10)then
player:startEvent(0x036B);--COP event

-- NOTE: cut out lines that are not needed for this guide to keep things simple

elseif(chasingStatus == QUEST_ACCEPTED and player:getVar("CHASING_TALES_TRACK_BOOK") > 0) then
player:startEvent(0x019c);
elseif(player:hasKeyItem(149) ==true) then
player:startEvent(0x019c);
elseif(chasingStatus == QUEST_ACCEPTED) then
player:startEvent(0x0196); -- Add follow up cutscene
else
player:startEvent(0x0172); -- Standard Conversation
end

end;
</pre>

Now that we've got his script open, we need to add a check for Windurst Mission 7-1 before starting the cutscene to progress in the mission so let's add that check:
<pre>
elseif(chasingStatus == QUEST_ACCEPTED) then
player:startEvent(0x0196); -- Add follow up cutscene
----> Windurst Mission 7-1 <----
elseif(player:getCurrentMission(WINDURST) == THE_SIXTH_MINISTRY and player:getVar("MissionStatus") == 0) then
-- player:startEvent()
else
player:startEvent(0x0172); -- Standard Conversation
</pre>

The code simplified:
<pre>
elseif <--- if the above code isn't true then if...
player:getCurrentMission(WINDURST) == THE_SIXTH_MINISTRY <--- The player's Current Mission (in Windurst) is THE_SIXTH_MINISTRY
and player:getVar("MissionStatus") == 0) <--- and "MissionStatus" var is equal to 0 (they haven't progressed in the mission)
then <--- then carry out the block of code til you see 'end' or another 'elseif' statement.
</pre>
Notice how we not only check the player's current mission, we also check the ''variable'' '''"MissionStatus"'''.
This is done so we know that the player has just received the mission and has not made any progress in it which is why the variable "MissionStatus" has a value of 0.
The reason we've commented out <code>player:startEvent()</code> is because we don't know the correct EventID yet.
Okay we've got the correct logic/checks in there; now what?
Now it's time to find the correct cutscene with the correct parameters (e.g. cutscenes that have items/keyitems/numbers/values returned as part of text).

== Finding the correct cutscene (with parameters) ==

Now we must find the correct cutscene for this mission.
To do this you can [http://wiki.ffxiclopedia.org/wiki/The_Sixth_Ministry find the mission on ffxiclopedia] and scroll down to the spoiler and click [show].
<pre>SPOILER WARNING: Details about a quest, mission or other Final Fantasy XI in-game storyline follow. [show]</pre>

You then find the [http://wiki.dspt.info/index.php/Event_IDs Event IDs] for that NPC in that particular zone (in our case it's [http://wiki.dspt.info/index.php/Windurst_Waters_Event_IDs Windurst Waters Event IDs] and the NPC is Tosuka-Porika and find the cutscene matching that dialog using the "@cs" command on a GM char e.g.

'''Note:''' ''Cutscenes linked to each other are usually have similar IDs e.g. @cs 830 @cs 831 @cs 832 are most likely related to the same mission/questline''
<pre>
@cs 830
</pre>
Once you find the correct cutscene you must [http://www.binaryhexconverter.com/decimal-to-hex-converter convert it from decimal to hexadecimal] before using it for "player:startEvent( )".

Okay so now we've found the correct cutscene (0x02cb) but it's showing this:

'''SCRIPT:'''
<pre>
player:startEvent(0x02cb);
</pre>

Script looks fine, lets have a look at how it displays client-sided/in-game.

'''Client-side cutscene triggered:'''
<pre>
Tosuka-Porika: Ah, yes, I mustaru give you this.
You should be able to enter the Animastery using this ring.
It is the ' '. Try your bestaru not to lose it.
</pre>

That doesn't look right!

This is because this cutscene requires a special parameter.
In our case the parameter is the value of the ''keyitem'' '''Optistery Ring'''.

To add this we can either call the keyitems script at the top of the file like so:
<pre>
require("scripts/globals/settings");
require("scripts/globals/titles");
require("scripts/globals/missions");
require("scripts/globals/quests");
require("scripts/zones/Windurst_Walls/TextIDs");
require("scripts/globals/keyitems"); --<----- require keyitems
</pre>
After we require the ''keyitems'' script we can then add this:
<code>
player:startEvent(0x02cb,0,OPTISTERY_RING);
</code>

Or we can go into the '''keyitems.lua''' file, find the id of OPTISTERY_RING and add the following to player:startEvent
<pre>
player:startEvent(0x02cb,0,250); -- cutscene(0x02cb),idk what this parm does(0),keyitemparam(250) keyitem = OPTISTERY_RING
</pre>

Alright, time to see if this works!

'''SCRIPT:'''
<code>
player:startEvent(0x02cb,0,250); -- cutscene, param1, keyitemid
</code>
Looks good; we got the correct cutscene and params. Lets see if it displays correctly in-game (client sided).

'''Client-side cutscene triggered:'''
<pre>
Tosuka-Porika: Ah, yes, I mustaru give you this.
You should be able to enter the Animastery using this ring.
It is the Optistery Ring. Try your bestaru not to lose it.
</pre>
Success!
Alright now we've got the cutscene to trigger so we need to tell the script what to do when the cutscene is finished.

== onEventFinish ==

This is where you tell the script what to do when that cutscene is finished and since we haven't told the script to do anything once the cutscene is triggered, we need to scroll down to '''onEventFinish''' and tell it what to do.
<pre>
-----------------------------------
-- onEventFinish
-----------------------------------

function onEventFinish(player,csid,option)
--printf("CSID: %u",csid);
--printf("RESULT: %u",option);

if(csid == 0x0037) then -- Show Off Hat
player:setVar("QuestHatInHand_var",player:getVar("QuestHatInHand_var")+32);
player:setVar("QuestHatInHand_count",player:getVar("QuestHatInHand_count")+1);
elseif(csid == 0x00a0) then
player:setVar("MissionStatus",1);
elseif(csid == 0x00a8) then
finishMissionTimeline(player,1,csid,option);
elseif(csid == 0x0183 and option == 0) then -- Early Bird Gets The Bookworm
player:addQuest(WINDURST,EARLY_BIRD_CATCHES_THE_BOOKWORM);
elseif(csid == 0x0193 and option == 0) then
player:addQuest(WINDURST,CHASING_TALES);
elseif(csid ==0x036B)then
player:setVar("MEMORIES_OF_A_MAIDEN_Status",11);
end

end;
</pre>

Alright so what does this mean?
<pre>
--printf("CSID: %u",csid);
--printf("RESULT: %u",option);
</pre>
When ''not'' commented out, (two hyphens "--" comments out whatever is after it on the same line) these "''printf''"s tell the script to show a message on DSGame-Server.exe window showing the CutsceneID of the cutscene that just finished and shows which option the user selected e.g. if the cutscene has a multi-choice option like:
<pre>
Do you wish to teleport to Windurst Walls?
[Yes]
[No]
</pre>
When triggering a cutscene with multi-choice options you need to comment out the line <code>--printf("RESULT: %u",option);</code> and when triggering the cutscene (from script, not @cs) it'll show a message in DSGameServer.exe like this:
<pre>
[Lua Script]RESULT: 0
</pre>

Ok now that the boring explanation is out of the way we need to tell it what to do once the cutscene is finished.
Now since we dont have a cutscene with multi-choice options, what we need to do is add a line like so:
<pre>
elseif(csid == 0x02cb) then
</pre>
We then need to tell it what to do upon finishing that cutscene.
Alright wiki says to give the ''keyitem'' '''Optistery Ring''' so lets add that to our code.
<pre>
elseif(csid == 0x02cb) then
player:addKeyItem(OPTISTERY_RING);
player:messageSpecial(KEYITEM_OBTAINED,OPTISTERY_RING);
</pre>

Looking good.

Time to test out the script so far; on your [GM] char use @addmission 2 17 (2 = Windurst, 17 = THE_SIXTH_MINISTRY) and then talk to '''Tosuka-Porika'''.

'''Client-sided (in-game)'''
<pre>
Tosuka-Porika: Ah, yes, I mustaru give you this.
You should be able to enter the Animastery using this ring.
It is the Optistery Ring. Try your bestaru not to lose it.
</pre>

Doesn't look like there are any issues but wait. Lets talk to him again and see what happens...
<pre>
Tosuka-Porika: Ah, yes, I mustaru give you this.
You should be able to enter the Animastery using this ring.
It is the Optistery Ring. Try your bestaru not to lose it.
</pre>
That shouldn't be happening... Ah wait, we forgot to set the variable for <code>"MissionStatus"</code>.
Lets add that to our '''onEventFinish''' code:
<pre>
elseif(csid == 0x02cb) then
player:addKeyItem(OPTISTERY_RING);
player:messageSpecial(KEYITEM_OBTAINED,OPTISTERY_RING);
player:setVar("MissionStatus",1);
</pre>

Alright so now that we've ''set the variable'' '''MissionStatus''' to '''1''' using <code>player:setVar("MissionStatus",1);</code> we need to trigger the cutscene before the '''onEventFinish''' code is called.

This is what your code should look like so far:

'''onTrigger'''
<pre>
-- NOTE: cut out lines that are not needed for this guide to keep things simple

elseif(chasingStatus == QUEST_ACCEPTED) then
player:startEvent(0x0196); -- Add folllow up cutscene

-- Windurst Mission 7-1 --
elseif(player:getCurrentMission(WINDURST) == THE_SIXTH_MINISTRY and player:getVar("MissionStatus") == 0) then
player:startEvent(0x02cb,0,OPTISTERY_RING);

else
player:startEvent(0x0172); -- Standard Conversation
end
</pre>

'''onEventFinish'''
<pre>
-- NOTE: cut out lines that are not needed for this guide to keep things simple
elseif(csid ==0x036B)then
player:setVar("MEMORIES_OF_A_MAIDEN_Status",11);

-- Windurst Mission 7-1 --
elseif(csid == 0x02cb) then
player:addKeyItem(OPTISTERY_RING);
player:messageSpecial(KEYITEM_OBTAINED,OPTISTERY_RING);
player:setVar("MissionStatus",1);
</pre>

Alright so we've got that working but we're missing the cutscene that reminds the player what they need to do next in the mission/questline.
This is usually the next cutscene up from the 'starting cutscene' and adding this check is simple;
<pre>
-- NOTE: cut out lines that are not needed for this guide to keep things simple

elseif(chasingStatus == QUEST_ACCEPTED) then
player:startEvent(0x0196); -- Add folllow up cutscene

-- Windurst Mission 7-1 --
elseif(player:getCurrentMission(WINDURST) == THE_SIXTH_MINISTRY and player:getVar("MissionStatus") == 0) then
player:startEvent(0x02cb,0,OPTISTERY_RING);

elseif(player:getCurrentMission(WINDURST) == THE_SIXTH_MINISTRY and player:getVar("MissionStatus") == 1) then -- reminder cs
player:startEvent(0x02cc,0,OPTISTERY_RING);

else
player:startEvent(0x0172); -- Standard Conversation
end
</pre>

Notice how we haven't added anything to '''onEventFinish'''.
This is because we don't need the script to do anything other than trigger the cutscene to remind the player what to do.

== Tracking progress through variables ==

You made it this far, good.

The Mission Walkthrough (on ffxiclopedia) is telling us (in short):
<pre>
- Travel to Toraimarai Canal
- go to (G-8)(Second Map), where there is a large room with 4 Hinge Oils accompanied by a few bats
- If even one of the oils re-spawn before you click the Marble Door, it will be "locked" until all oils are defeated again.
</pre>

Now lets navigate to <code>scripts/zones/Toraimarai_Canal/mobs</code> since the script we're modifying is a mob's script.

Save the following code as <code>hinge_oil.lua</code>

[[#Hinge_Oil_Template|[Click here to go to the Hinge Oil Template]]]

This script is called whenever there's a change in the mob's current action (as far as i know)

Since we need to track how many '''Hinge Oils''' the player has killed; we need the variable to increase on each mob's death til it reaches the value of 4 (4 is the number of Hinge Oils in the room and they all need to be killed).

To do this we add the following code to '''onMobDeath''':
<pre>
function onMobDeath(mob, killer)

local CurrentMission = killer:getCurrentMission(WINDURST);
local WindyKills = killer:getVar("Windurst_7-1Kills");

if(CurrentMission == THE_SIXTH_MINISTRY and player:getVar("MissionStatus") == 1) then
if(WindyKills < 4) then
killer:setVar("Windurst_7-1Kills",WindyKills+1);
end
end
end;
</pre>
Breakdown of the code we just added:

<pre>
local WindyKills = killer:getVar("Windurst_7-1Kills");
</pre>
We declare this as a <code>local</code> variable.

This means that the variable is contained only in the script within this <code>function</code>.

This is useful for when you have a long-ass check like <code>killer:getVar("Windurst_7-1Kills")</code> and want to use an alias for that instead; it also helps make the code more readable.

<pre>
if(CurrentMission == THE_SIXTH_MINISTRY and player:getVar("MissionStatus") == 1) then
</pre>
The reason we check killers current mission first and the stage they're at is because we don't want every player to get the variable added to their character since they don't need it.

<pre>
if(WindyKills < 4) then
killer:setVar("Windurst_7-1Kills",WindyKills+1);
end
</pre>
WindyKills was declared above as <code>killer:getVar("Windurst_7-1Kills")</code>

This checks if WindyKills''(killer:getVar("Windurst_7-1Kills"))'' variable is under 4 and adds 1 for each kill you get to "Windurst_7-1Kills" until the value reaches 4.

Notice how it's <code>killer:</code> and not <code>player:</code>.
The <code>function</code> tells you whether to use ''player'' or ''killer'' like so:
<pre>
-- THIS IS AN EXAMPLE, your script should NOT look like this, it's for demonstration purposes only.
function onMobDeath(mob, killer);
--^ killer, not player

function onTrigger(npc, player)
--^ player, not killer
</pre>

Alright now that we've got that code added let's test it by throwing in a <code>print</code> to return the value like so:
<pre>
if(WindyKills < 4) then
killer:setVar("Windurst_7-1Kills",WindyKills+1);
print("Windurst_7-1Kills value is"..WindyKills); -- WindyKills = killer:getVar("Windurst_7-1Kills);
end
</pre>
In DSGame-Server.exe console window you'll see <code>[Lua Script]Windurst_7-1Kills value is 1 </code> etc til the value reaches 4.

Once you're done testing to see if the code is working correctly, take out the line with the <code>print</code> in it.

== Adding special checks ==

Lets head up to the Marble Door first in-game and trigger it to see what happens.
The door is opening (which is normal for most doors but ours is special) so lets check <code>DSGame-Server.exe</code>.
[ ! ]''(Insert MGS Alert here)''
DSGameServer is reporting an error!
<pre>
[Error]luautils::OnTrigger: cannot open scripts/zones/Toraimarai_Canal/npcs/_4pc.lua: No such file or directory
</pre>
For any other door we'd ignore this error but ours is special.
So lets paste the following code as a template

[[#Marble_Door_Template|[Click here to go to Marble Door Template]]]

Lets add a check to the NPC for the player's current mission and check to see if they've killed the 4 <code>Hinge Oils</code> like so:
<pre>
function onTrigger(player,npc)

local CurrentMission = player:getCurrentMission(WINDURST);
local WindyKills = player:getVar("Windurst_7-1Kills");

if(CurrentMission == THE_SIXTH_MINISTRY and WindyKills == 4) then
end
end;
</pre>
''We did not need to include <code>MissionStatus</code> as that check has already been checked by the mobs <code>onMobDeath</code> before counting the kill. The other reason for this is because we don't want the door to remain locked after the player passes through and triggers the cutscene by talking to the Tome of Magic''

Alright we've got the check for the Mission and the check to see if all 4 <code>Hinge Oils</code> have been defeated by the player but the door doesn't open.
For the door to open we need to use <code>GetNPCByID():openDoor()</code> (but we first need the NPC's ID).

=== GetNPCByID ===

[[#NPC_IDs|[Click here to see how to get the NPC ID]]]

Now that we've got the correct ID, lets add this into the script.
<pre>
function onTrigger(player,npc)

local CurrentMission = player:getCurrentMission(WINDURST);
local WindyKills = player:getVar("Windurst_7-1Kills");

if(CurrentMission == THE_SIXTH_MINISTRY and WindyKills == 4) then
GetNPCByID(17469795):openDoor(2.5);
-- (NPCid) :openDoor(2.5) seconds
end
end;
</pre>
Doesn't seem like there's any issues but wait!
Remember we not only have to check to see if all the Hinge Oils have been killed by the player, but we also need to make sure all the mobs are de-spawned before the player can enter through the door.

=== Mob Action ===

Here's how we check if the mob is de-spawned.
<code>
GetMobAction(mobId)
</code>
[[#Mob_IDs|[Click here to find out how to obtain the mobId]]] otherwise continue reading.

Add the following to <code>_4pc.lua</code> (Marble Door) once finding out the Mob Action:

''Note: [[#Print_Mob_Action|[Click here for info on obtaining Mob Action]]] otherwise continue reading.''
<pre>
function onTrigger(player,npc)
local CurrentMission = player:getCurrentMission(WINDURST);
local MissionStatus = player:getVar("MissionStatus");
local WindyKills = player:getVar("Windurst_7-1Kills");

-- NOTE: MobAction is 25(ACTION_SPAWN) when they're dead/despawned and 16(ACTION_ROAMING) when spawned.
-- Not really sure why but this seems to work.
-- print("HingeOil 1 Action: "..GetMobAction(17469666)); -- etc

if(CurrentMission == THE_SIXTH_MINISTRY and WindyKills == 4) then
if((GetMobAction(17469666) == 25) and
(GetMobAction(17469667) == 25) and
(GetMobAction(17469668) == 25) and
(GetMobAction(17469669) == 25)) then

GetNPCByID(17469795):openDoor(2.5);
else
player:messageSpecial(3); -- It's sealed shut with incredibly strong magic
end

end

end;
</pre>

This checks if the player's Current Mission is THE SIXTH MINISTRY and they've got the kills required AND the following mobs are de-spawned/dead then open the door.

== Finishing off the Mission ==

We're almost done!
Now we just need to talk to the Tome of Magic and finish off the Mission when returning to Tosuka-Porika.
Upon 'talking' to the Tome(s) of Magic, we discover it doesn't have a script so go ahead and [[#Tome_of_Magic_Template|[copy the template]]] and save the file as <code>Tome_of_Magic.lua</code>.

''Note: All the Tomes of Magic have got the same name in npc_list.sql... For this to work correctly you need to find the correct NPCs ID. You then add the following code and talk to that NPC.

Ok now lets open up the script for <code>Tome_of_Magic</code>, add the checks for the mission, check which Tome it is and what stage the player is at like so:
<pre>
function onTrigger(player,npc)
local CurrentMission = player:getCurrentMission(WINDURST);
local WindyKills = player:getVar("Windurst_7-1Kills");
local MissionStatus = player:getVar("MissionStatus");
local npcId = npc:getID(); -- This is how we get the NPCs ID.

print("This Tome's ID is "..npcId);

if(CurrentMission == THE_SIXTH_MINISTRY and WindyKills == 4 and MissionStatus == 1) then

local cutscene = math.random(0x041,0x044); -- Selects a cutscene (from 0x041 to 0x044)

player:startEvent(cutscene); -- plays the cutscene chosen (changes each time)

end

end;
</pre>
Now lets talk to the correct Tome (on the floor to the left of the Marble Door you entered through) and find it's ID.
Check DSGameServer and see what this NPCs ID is.

Once you got the correct ID; add the following code to check if we're talking to the correct Tome:
<pre>
function onTrigger(player,npc)

local CurrentMission = player:getCurrentMission(WINDURST);
local WindyKills = player:getVar("Windurst_7-1Kills");
local MissionStatus = player:getVar("MissionStatus");
local npcId = npc:getID(); -- Get the NPCs ID

if(npcId == 17469825) then -- If it's this NPC then check the players mission and
if(CurrentMission == THE_SIXTH_MINISTRY and WindyKills == 4 and MissionStatus == 1) then
player:startEvent(0x0045);
end

else
local cs = math.random(0x041,0x044);
player:startEvent(cs);

end
end;
</pre>
Now remember, these are the other Tomes that just give information but aren't needed for the mission.
Since all the un-needed 'fake' Tomes have the same names (in-game and in npc_list) I decided to be lazy and have them play either cutscene <code>0x041, 0x042, 0x043</code> or <code>0x044</code>(these cutscenes are general info cutscenes). This was so I didn't need to add extra scripts by renaming the NPCs. (I don't recommend doing this in any other case but it doesn't matter for these).

The player now has two options to get out of this room; use the Transporter or exit through the door they entered.

Since i'm feeling generous, you can have the [[#Transporter_Script|[Transporter script]]].

Okay done that, now what?
<pre>
After the cutscene, you can exit through the Marble Door on the South end of the room.

This will take you back to Heavens Tower in Windurst.
</pre>
Transporter added, player can exit through that as well as the Marble Door they entered through; next!
<pre>
Head back to the Optistery and speak with Tosuka-Porika to finish the mission and to receive the key item Blank Book of the Gods.
</pre>

Seems easy enough, lets get to it!

== Final Stage and Missions.lua ==
Thought it'd be as simple as adding the checks and cutscenes to the NPC? Well you're in for a surprise; it's not!

This is how it's done:

Add the code that checks the player's progress (if it's sufficient to finish the mission):
<code>scripts/zones/Windurst_Waters/npc/'''Tosuka-Porika.lua'''</code>:
<pre>
function onTrigger(player,npc)

-- cut out lines not relevant to our mission

if (player:getCurrentMission(COP) == THE_ROAD_FORKS and player:getVar("MEMORIES_OF_A_MAIDEN_Status")==10)then
player:startEvent(0x036B);--COP event

-- cut out lines not relevant to our mission
-- WINDURST MISSION 7-1 --
elseif(player:getCurrentMission(WINDURST) == THE_SIXTH_MINISTRY and player:getVar("MissionStatus") == 0) then
player:startEvent(0x02cb,0,OPTISTERY_RING);

elseif(player:getCurrentMission(WINDURST) == THE_SIXTH_MINISTRY and player:getVar("MissionStatus") == 1) then
player:startEvent(0x02cc,0,OPTISTERY_RING);

elseif(player:getCurrentMission(WINDURST) == THE_SIXTH_MINISTRY and player:getVar("MissionStatus") == 2) then
player:startEvent(0x02d4);
else
player:startEvent(0x0172); -- Standard Conversation
end
end
</pre>
(Remember we set MissionStatus to 2 upon triggering the correct cutscene with the Tome of Magic so we set the script above to check if that's happened)

onEventFinish:
<pre>
function onEventFinish(player,csid,option)
--printf("CSID: %u",csid);
--printf("RESULT: %u",option);

if(csid == 0x0037) then -- Show Off Hat
player:setVar("QuestHatInHand_var",player:getVar("QuestHatInHand_var")+32);
player:setVar("QuestHatInHand_count",player:getVar("QuestHatInHand_count")+1);

-- cut out lines not relevant to our mission

elseif(csid == 0x02cb) then
player:addKeyItem(OPTISTERY_RING);
player:messageSpecial(KEYITEM_OBTAINED,OPTISTERY_RING);
player:setVar("MissionStatus",1);

elseif(csid == 0x02d4) then
finishMissionTimeline(player,4,csid,option); -- See.. Not as simple as you first thought!
player:setVar("Windurst_7-1Kills",0) -- Delete this variable, we don't need it anymore.
end

end;
</pre>
Now what does this mean?

Read on and find out!

=== Missions.lua ===

Navigate to <code>scripts/globals/</code> and open <code>missions.lua</code>.
Scroll down to around ''Line 790'' or ''Ctrl+F'' for <code>finishMissionTimeline</code>.
You'll see something like this:
<pre>
function finishMissionTimeline(player,guard,csid,option)

nation = player:getNation();

-- To prevent the cs conflict, use the 1st and 2nd for guard and 3/4 for npc
-- missionid, {Guard1CS,option}, {Guard2CS,option}, {NPC1 CS,option}, {NPC2 CS,option}, {{function,value},...},
-- 1: player:addMission(nation,mission);
</pre>
For now lets ignore this part and skip to Line 888-ish (<code>elseif(nation == WINDURST)</code>)

You'll see something like this:
<pre>
timeline = {

-- NOTE: CUT OUT THE LINES NOT RELEVANT TO OUR MISSION

15,{0x00D8,0},{0,0}, {0,0}, {0,0}, {{11,6},{14,0},{9,74},{8,20000},{6},{12}}, -- MISSION 5-2 (Finish (Star Sibyl))

16,{0,0}, {0,0}, {0x0032,0},{0,0}, {{14,0},{5,650},{0,0},{0,0},{0,0},{12}}, -- MISSION 6-1 (Finish (Zone: Full Moon Fountain))

17,{0,0}, {0,0}, {0x0138,0},{0,0}, {{14,0},{11,7},{8,40000},{6},{0,0},{12}} -- MISSION 6-2 (Finish (Star Sibyl))

}
</pre>
Now you may be thinking: "This is confusing as fuck." but don't worry, it's not.

Here's what it means:
<pre>
17, {0,0}, {0,0}, {0x0138,0}, {0,0}, {{14,0},{11,7},{8,40000},{6},{0,0},{12}}
-- ^^ ^^^^ ^^^^ ^ ^
--missionid^|guard1csid^| guard2csid^| guard3csid^|NPC1csid^ | ^ function list ^|
</pre>

That probably didn't make a lot of sense but lets just add the code to finish the mission and you'll understand how this works (hopefully)...

Scroll to the code for Windurst Mission 6-2 and add a comma after the <code>{12}}</code> like so:
<pre>
17,{0,0},{0,0},{0x0138,0},{0,0},{{14,0},{11,7},{8,40000},{6},{0,0},{12}}, -- MISSION 6-2 (Finish (Star Sibyl))
</pre>
This tells the script "We've got an addition to the array, keep looking!".

Now add a new line (keeping the previous line intact) with the following code:
<pre>
18,{0,0},{0,0},{0,0},{0,0},{{0,0},{0,0},{0,0},{0},{0,0},{0}}
</pre>

So far your code should look like this:
<pre>
17,{0,0},{0,0},{0x0138,0},{0,0},{{14,0},{11,7},{8,40000},{6},{0,0},{12}}, -- MISSION 6-2 (Finish (Star Sibyl))
18,{0,0},{0,0},{0,0},{0,0},{{0,0},{0,0},{0,0},{0},{0,0},{0}} -- MISSION 7-1 (Finish (Tosuka-Porika))
</pre>
Notice how there's no comma after the last set of }'s for the line we just added. This is because we've now reached the end of the array so we show that by leaving the comma out.

Now here's what we do to the line we've just added.
First we need to add the NPC's mission finishing csid (<code>0x02d4</code> for Tosuka-Porika in our case) like so:
<pre>
18,{0,0},{0,0},{0,0},{0x02d4,0},{{0,0},{0,0},{0,0},{0},{0,0},{0}} -- MISSION 7-1 (Finish (Tosuka-Porika))
</pre>
(changed the 4th pair of {}'s to the npcs csid)
Notice how the NPCs csid is the 4th param after the Mission ID. This is where we get the <code>4</code> from in <code>finishMissionTimeline(player,4,csid,option)</code> in Tosuka-Porika's script.

Next we tell the 'function list' (pair of {}'s after npc's csid) what to do;

''IMPORTANT:[[#Function_List|[Here's the full list of functions for 'function list']]]'' e.g. how you'd setRank or addGil etc.

First we need to set the variable "MissionStatus" to 0 by changing the first pair of {}'s to <code>{14,0}</code> inside the function list like so:
<pre>
18,{0,0},{0,0},{0,0},{0x02d4,0},{{14,0},{0,0},{0,0},{0},{0,0},{0}} -- MISSION 7-1 (Finish (Tosuka-Porika))
</pre>
Next we need to add the Rank Points reward (5,RankPointsValue) like so:
''Note: The Rank Points awarded is +50 from whatever the previous mission (that awarded rank points) gave out (from Mission 2 onwards)
<pre>
18,{0,0},{0,0},{0,0},{0x02d4,0},{{14,0},{5,700},{0,0},{0},{0,0},{0}} -- MISSION 7-1 (Finish (Tosuka-Porika))
</pre>

After that we need to award the keyitem/item/gil reward for completing the mission; Book of Gods (KeyItem 251) like so:
<pre>
18,{0,0},{0,0},{0,0},{0x02d4,0},{{14,0},{5,700},{10,251},{0},{0,0},{0}} -- MISSION 7-1 (Finish (Tosuka-Porika))
</pre>

Lastly we'll add the mission completing function like so:
<pre>
18,{0,0},{0,0},{0,0},{0x02d4,0},{{14,0},{5,700},{10,251},{0},{0,0},{12}} -- MISSION 7-1 (Finish (Tosuka-Porika))
</pre>
''Note: It does NOT matter what order you carry out the functions so long as they're contained within the function list. Remember to clear un-needed player variables by using <code>player:setVar("VariableName",0)</code> on the final NPC/stage of the mission. ''

Now test your mission to see if everything is working correctly and...

We're done.
Congratulations on scripting your first mission!
If you have any issues with adding missions or this guide please contact 'demolish' on our IRC channel.

=== Function List ===
<pre>
-- To be used within the function list {{0,0},{0,0}, etc.. }
-- 1: player:addMission(nation,mission);
-- 2: player:messageSpecial(YOU_ACCEPT_THE_MISSION);
-- 3: player:setVar(variablename,value);
-- 4: player:tradeComplete();
-- 5: player:addRankPoints(number);
-- 6: player:setRankPoints(0);
-- 7: player:addPoint(player:getNation(),number); player:messageSpecial(YOUVE_EARNED_CONQUEST_POINTS);
-- 8: player:addGil(GIL_RATE*number); player:messageSpecial(GIL_OBTAINED,GIL_RATE*number);
-- 9: player:delKeyItem(number);
-- 10: player:addKeyItem(number); player:messageSpecial(KEYITEM_OBTAINED,number);
-- 11: player:setRank(number);
-- 12: player:completeMission(nation,mission);
-- 13: player:addTitle(number);
-- 14: player:setVar("MissionStatus",value);
</pre>

= Other info and Templates =

== Marble Door Template ==
For a little more information, read the block of text just under this template while you're here or [[#Adding_special_checks|[Click here to return to the step you were on]]].
<pre>
-----------------------------------
-- Area: Toraimarai Canal
-- NPC: Marble Door
-- Involved In Windurst Mission 7-1
-- @zone 169
-- @pos 132 12 -19 169
-----------------------------------
package.loaded["scripts/zones/Toraimarai_Canal/TextIDs"] = nil;
require("scripts/zones/Toraimarai_Canal/TextIDs");
-----------------------------------

require("scripts/globals/settings");
require("scripts/globals/keyitems");
require("scripts/globals/quests");
require("scripts/globals/missions");

-----------------------------------
-- onTrade Action
-----------------------------------

function onTrade(player,npc,trade)

end;

-----------------------------------
-- onTrigger Action
-----------------------------------

function onTrigger(player,npc)

end;

-----------------------------------
-- onEventUpdate
-----------------------------------

function onEventUpdate(player,csid,option)
--printf("CSID2: %u",csid);
--printf("RESULT2: %u",option);

end;

-----------------------------------
-- onEventFinish
-----------------------------------

function onEventFinish(player,csid,option)
--printf("CSID: %u",csid);
--printf("RESULT: %u",option);

end;
</pre>
''Notice how at the top of the file there is the NPCs name, what it's relevant to, <code>@zone</code> and <code>@pos</code> co-ordinates.
It is very important to include the <code>@pos</code> as it helps test this NPC before the script gets committed and also for anyone else who needs to modify it later.
You can find the <code>@pos</code> of a mob/npc/area by standing in the spot you want to find the co-ordinates of and using the GM command: <code>@where</code>.
The command tells you your character's [X,Y,Z,(rotation)] <code>pos</code> (you dont need to include the rotation).
The last number (after Z pos) is the zoneid.''

[[#Adding_special_checks|[Click here to return to the step you were on]]]

== Hinge Oil Template ==
[[#Tracking_progress_through_variables|[Click here to return to the step you were on]]]
<pre>
-----------------------------------
-- Area: Toraimarai Canal
-- Mob: Hinge Oil
-----------------------------------

require("scripts/globals/titles");
require("scripts/globals/status");
require("scripts/globals/missions");

-----------------------------------
-- OnMobInitialise Action
-----------------------------------

function onMobInitialize(mob)
end;

-----------------------------------
-- onMobFight Action
-----------------------------------

function onMobFight(mob,target)
end;

-----------------------------------
-- onMobDeath
-----------------------------------

function onMobDeath(mob, killer)

end;
</pre>

[[#Tracking_progress_through_variables|[Click here to return to the step you were on]]]

== Tome of Magic Template ==
[[#Finishing_off_the_Mission|[Click here to return to the step you were on]]]
<pre>
-----------------------------------
-- Area: Toraimarai Canal
-- NPC: Tome of Magic ( Optional CS )
-- Involved In Windurst Mission 7-1
-- @zone 169
-- @pos 140 13 -22 169
-----------------------------------
package.loaded["scripts/zones/Toraimarai_Canal/TextIDs"] = nil;
require("scripts/zones/Toraimarai_Canal/TextIDs");
-----------------------------------

require("scripts/globals/settings");
require("scripts/globals/keyitems");
require("scripts/globals/quests");
require("scripts/globals/missions");

-----------------------------------
-- onTrade Action
-----------------------------------

function onTrade(player,npc,trade)

end;

-----------------------------------
-- onTrigger Action
-----------------------------------

function onTrigger(player,npc)

end;

-----------------------------------
-- onEventUpdate
-----------------------------------

function onEventUpdate(player,csid,option)
--printf("CSID2: %u",csid);
--printf("RESULT2: %u",option);

end;

-----------------------------------
-- onEventFinish
-----------------------------------

function onEventFinish(player,csid,option)
--printf("CSID: %u",csid);
--printf("RESULT: %u",option);
end;
</pre>
[[#Finishing_off_the_Mission|[Click here to return to the step you were on]]]

== Transporter Script ==
[[#Other_info_and_Templates|[Click here (and scroll up a bit) to return to the step you were on]]]
<pre>
-----------------------------------
-- Area: Toraimarai Canal
-- NPC: Transporter
-- Involved In Windurst Mission 7-1
-- @zone 169
-- @pos 182 11 -60 169
-----------------------------------
package.loaded["scripts/zones/Toraimarai_Canal/TextIDs"] = nil;
require("scripts/zones/Toraimarai_Canal/TextIDs");
-----------------------------------

require("scripts/globals/settings");
require("scripts/globals/keyitems");
require("scripts/globals/quests");
require("scripts/globals/missions");

-----------------------------------
-- onTrade Action
-----------------------------------

function onTrade(player,npc,trade)

end;

-----------------------------------
-- onTrigger Action
-----------------------------------

function onTrigger(player,npc)
player:startEvent(0x0047);
end;

-----------------------------------
-- onEventUpdate
-----------------------------------

function onEventUpdate(player,csid,option)
--printf("CSID2: %u",csid);
--printf("RESULT2: %u",option);
end;

-----------------------------------
-- onEventFinish
-----------------------------------

function onEventFinish(player,csid,option)
--printf("CSID: %u",csid);
--printf("RESULT: %u",option);

if(csid == 0x0047 and option == 1) then
player:setPos(0,0,-22,192,242);
end
end;
</pre>
[[#Other_info_and_Templates|[Click here (and scroll up a bit) to return to the step you were on]]]

== NPC IDs ==
To get the NPC's ID you first need to open '''npc_list.sql''' (in Notepad++) and look for the NPCs name (and zone).
Luckily for us, DSGameServer console reported the NPC's name and the zone it's in so after a quick search for that NPC we find the following in '''npc_list.sql''':
<pre>
|npcId| |zoneid|
( 355,'_4pc', 0,138.749,11.350,-19.995,1,40,40,9,0,0,0,3,0x0200000000000000000000000000000000000000,0, 169);
</pre>
Unfortunately it isn't as simple as that.
<code>GetNPCByID</code> requires the long NPC ID (17469795).

To get the long (or 'old style') NPC ID you can either use '''[https://forums.dspt.info/viewtopic.php?f=16&p=8103 this tool]''' or convert it to the old style like so:

NPC ID + 0x1000000 (that's 5 zeros) + (4096 * zoneId)
e.g.
<code>
355 + 0x1000000 + (4096 * 169) = 17469795
</code>
[[#GetNPCByID|[Click here to return to the step you were on]]]

== Mob IDs ==
To find the Mob ID, open <code>mob_spawn_points.sql</code> and search for the mob's name (in our case Hinge Oil):
<pre>
| mobid | mobname |groupid|
('17469666', 'Hinge_Oil', '8829', '86.554', '24.000', '-23.048', '127');
</pre>

Once you've found the mobs name, find it's <code>groupid</code> in <code>mob_groups.sql</code> (in our case groupid is 8829).
<pre>
|groupid|poolId|zoneId|
( 8829, 1958, 169,1056,0,0,0,0,65,65);
</pre>

If that mob's id is linked to the correct <code>groupid</code> and has the same <code>zoneId</code> as the zone the mob you're trying to add (in our case the mob is in Toraimarai-Canal zone 169 and everything is matching up) e.g.
<code>Mob ID is 17469666</code> and the <code>ZoneId is 169</code> (found by tracing it's groupid in mob_groups) then [[#Mob_Action|[Click here to return to the step you were on]]].

== Debugging using print ==

=== Print Variables ===
To print the value of a variable simply do this (lets just say that we want the value of MissionStatus):
<pre>
print("Mission Status is ",..player:getVar("MissionStatus");
</pre>
And DSGameServer will print
<pre>
[LUA Script] Mission Status is 2
</pre>

=== Print Mob Action ===
To find the mob's current action, you need the [[#Mob_IDs|[Mob ID]]] and you need add the following code to an '''onTrigger''' of any NPC (in our case it's _4pc):
<pre>
function onTrigger(player,npc)

-- can only check 1 mob per GetMobAction so add multiple lines for multiple mobs like so

print("HingeOil 1 Action: "..GetMobAction(17469666));
print("HingeOil 2 Action: "..GetMobAction(17469667));
print("HingeOil 3 Action: "..GetMobAction(17469668));
print("HingeOil 4 Action: "..GetMobAction(17469669));
end
</pre>
DSGameServer will then 'print' the mob's current action.
You can check the mob's Action once dead by either using @despawnmob mobId e.g. <code>@despawnmob 17469666</code> or killing the mob and then triggering the print.
If the mob is spawned, you'll get a message like this in DSGameServer.exe:
<pre>
[LUA Script]HingeOil 1 Action: 16
</pre>
If it's de-spawned, you'll get a message like this in DSGameServer.exe (you have to wait around 10 secs for it to take effect):
<pre>
[LUA Script]HingeOil 1 Action: 25
</pre>

[[#Mob_Action|[Click here to return to the step you were on]]]