[FAQ] HellmouthSource

[pro4never]

So I'm posting this preemptively cause I just know I'm going to be slammed with questions.

Where do I get the source? I WANT MONK!!!!

A: If you haven't already downloaded the source, you can get it from

I'm confused! I've never set up a source before!!!!

A: Angelius was nice enough to post a video of how to set up the source. You can find the video in the spoiler below

NOTE: To edit the source you MUST open the project file using visual studio 2010. Yes, you can configure the database just from the settings file like he did but anything past that you NEED visual studio/other C# compiler installed.

 Spoiler

I get an error when I try to run the database backup

A: The backup works perfectly fine, simply ensure you have innodb activated (IF YOU USE APPSERVER AND GET THIS, RE INSTALL IT AND THIS TIME TICK THE BOX THAT SAYS ENABLE INNODB!). I'd suggest xampp or the official mysql server from the mysql website.

I need a client!

Download one from the official conquer website... or someone who played my server uploaded this one to megaupload... I assume it works.



Mobs aren't working! How do I add monsters?!?!?!?!?!?!?

The monster system IS NOT CODED IN THIS SOURCE. I've gotten so many msgs about this... I try to explain it and they go "so can I copy from lotf???" or something along those lines or just try to get me to add it for them.

To put it bluntly... Monsters (done correctly) can be the most complex system of your server to do right! Handling monster ai/movements/death/re spawning/drops and such is something you have to handle CAREFULLY or else you will run into all sorts of issues.

I will NOT code the system for you...

I do NOT recommend trying to use lotf's mob system... not good.

-Info on the monster system/what is loaded

 Spoiler

The database is already set up properly... you simply need to start loading from database (it's commented out)

public static void GetSpawns()

Remove the comments.

There are a number of monster variables not currently being initialized. You should fix that

There are a number of typos in the db/spawn code which need to be corrected.


All in all it's about 10 lines that you need to change/add and monsters will spawn properly... I will NOT be posting the full fix. You guys need to get off your ass and do it yourself.

Once you have fixed the typo in the load db section and made it try to load you need to modify the spawn class.

Right click the mob spawn and go to definition... You now need to re-code this section so it WORKS.

-Go to the map files and make sure that the add/remove/move for monsters is working correctly

-Make sure that the player move code spawns/removes the monsters to screen

-You now need to make some sort of thread system to control monster actions/movements

-You need to make monsters respawn after being killed (removed it atm)

Npcs aren't working! Help!
A: Most are not coded. I was leaving that for other people to do. There are two ways to edit/add npcs!

-Expand for more information on npc scripting.

 Spoiler

Option one.... npc external python scripts. /bin/debug/NPCs contains NpcID.npc files. Simply make a new one and code away

"Basic" npc example (I build a .npc dumper for real conquer into my proxy to build these)

 Spoiler

def npc(Client, Option):
    if(Option == 0):
        Text("You are powerful now. I suggest you to go to the Captain of Desert City, because I heard that he is annoyed by the")
        Text(" rampant monsters there. I believe you can help him a lot. I will teleport you to Desert City, so you can reach there")
        Text(" very soon.")
        Link("Please send me to Desert City.", 0)
        Link("I don`t want to go there.", 255)
        Face(57)
    return 0

"Advanced" npc (unbound gear merch). Thanks to devnull for his work on it during pre beta

 Spoiler

def npc(Client, Option):    
    COST = 20000
    LEVEL = "33"
    QUALITY = "9"
    Type = 0
    Gem = 13
    FinalID = 0
    if(Option == 0):
        Text("I can sell you an unbound weapon for 20,000 arena points. ")
        Text("What weapon do you desire?")
        Link("One-handed.", 1)
        Link("Two-handed.", 2)
        Link("Katana.", 27)
        Link("Beads.", 28)
        Link("Forget it.", 255)            
        Finish()   
    if(Option == 1): 
        Text("Please select your weapon from the list")        
        Link("Blade", 10)
        Link("Sword", 11)
        Link("Backsword", 12)
        Link("Hook", 13)
        Link("Whip", 14)
        Link("Axe", 15)
        Link("Hammer", 16) 
        Link("Next page", 3)        
        Finish()
    if(Option == 2):
        Text("Please select your weapon from the list")        
        Link("Bow", 20)
        Link("Glaive", 21)
        Link("Poleaxe", 22)
        Link("Longhammer", 23)
        Link("Spear", 24)
        Link("Wand", 25)
        Link("Halbert", 26)        
        Finish()        
    if(Option == 3):
        Text("Please select your weapon from the list")
        Link("Club", 17)
        Link("Scepter", 18)
        Link("Dagger", 19)
        Link("Back", 1)        
        Finish()
    if(Option > 3):
        if(Option == 10): Type = 410
        if(Option == 11): Type = 420
        if(Option == 12): 
             Type = 421
             Gem = 3
        if(Option == 13): Type = 430
        if(Option == 14): Type = 440
        if(Option == 15): Type = 450
        if(Option == 16): Type = 460
        if(Option == 17): Type = 480
        if(Option == 18): Type = 481
        if(Option == 19): Type = 490
        if(Option == 20): Type = 500
        if(Option == 21): Type = 510
        if(Option == 22): Type = 530
        if(Option == 23): Type = 540
        if(Option == 24): Type = 560
        if(Option == 25): Type = 561
        if(Option == 26): Type = 580
        if(Option == 27): Type = 601
        if(Option == 28): Type = 610        
        if(Client.ArenaPoints > COST):
            Client.ArenaPoints -= COST
            FinalID = str(Type) + LEVEL + QUALITY
            Text("A hero is only as good as his blade. Use this weapon wisely and you will become an unstopable force ")
            Link("I Shall", 255)
            Finish()
            AddProf(Type, 20)
            AddItem(int(FinalID), 0,3,0,Gem,Gem,0)
        else: 
            Text("You do not have enough arena points")
            Link("Thanks", 255)
            Finish()
    return 0

So as you can see we have access to some methods here including... Text, Link, Finish, AddProf, AddItem and all character methods (anything in Client.cs that is public can be accessed cause we are passing the client object into the script!)

All other methods are contained in Handler>NpcTalk.cs

Example

scope.SetVariable("Text", new Func<string, int>(delegate(string text)
            {
                Text(text, Client);
                return 0;
            }));

That adds the Function to our ironpython... we still need the actual Text(text, Client); part though!

which refers to

        public static void Text(string text, Client Client)
        {
            Packets.Send(Packets.NpcText(255, text), Client);
        }

You can add in any new methods you wanted to give new functionality to your python external scripts.


If you are more comfortable writing scripts in C# and don't care if they cannot be modified while the server is running then you can add new npcs to the Handler.NpcTalk.cs file!

That's where I have my code for the capture the flag bases just because there were so many different checks and actions based around them that I found writing it this way just much easier. I could have done it all in python if I wanted to though.

How do I Create an account!?

A: By default the source creates accounts when you first try to log in with an unknown username. Alternatively open up navicat or your favorite sql management program and open the accounts table and enter a username/password. Everything else should work all by itself. Now simply log in.

-Expand for information on removing the auto account creation

 Spoiler

Doesn't really need its own spoiler but w/e! To remove the auto account creation simply push ctrl+f and make sure you have "Entire solution" selected under the Look In: field.

Now search for "Database.CreateAccount(Client);"

Simply delete this entire section

   if (Client.UID == 0)
                        {
                            Database.CreateAccount(Client);
                            Thread.Sleep(50);
                            Client.UID = Database.PullUID(Client.Username);
                        }

Once that is done users MUST have an account already made to log in.

How do I make Gm/Pm?

A: Permission field in the accounts table (255 = banned, 1 = normal user. I was using like 6 as full permission but just look at the commands file to find what permission you really want to assign people.


Guilds/Mentor/friends/etc is not working!! HELP

A: They are not coded... log packets and write it yourself. Most of it is quite simple so shouldn't be too hard to add.

Skill X doesn't work!

A: many skills are not coded... Mostly lazyness on my part but they are not too hard to add. The only targeting method not added currently is arc attacks I think... Line, LineW/Target, AOE and single attacks are all added.

-Expand for information on where spell type stuff is stored!

 Spoiler

Handlers/Attack/ contains most of the stuff you will be interested in!

To start lets go to Handlers/Attack/Magic.cs

Search for "case Enum.Skills.TwoFoldBlades:"

Now simply add your own case ID for the skill to add

Example... lets code team healing spells!

(HealingRain is not enumerated yet... right click TwoFoldBlades and click go to definition)
Somewhere in this section add in
"HealingRain = 1055,"


Now go back to your Magic.cs and do

 case Enum.Skills.HealingRain:
                        {
                            break;
                        }

Our skill is now "handled". We just haven't had it cause any effects!

First off... we need to know if we can afford to cast the spell... If we can't we have no reason to continue checking other conditions.


Much of my code doesn't currently use this method but new ones SHOULD!


Search for

public static bool CheckCost(Client Client, Struct.Skill S)

now add a new case...

case Enum.Skills.HealingRain:
                    switch (S.Level)
                    {
                        case 0: break;
                        case 1: break;
                        case 2: break;
                        case 3: break;
                    }
                    if (Client.Mana > Cost)
                        return true;
                    break;

NOTE: Simply add in the cost to each spell level case... I left it out so you have to do SOMETHING here You can find proper costs on tq website or make up your own.

Now we need to know what the target 'is'. For now lets only allow healing on Players (no healing tnpc or monsters).

Personally I'd do this by doing...

if (!Client.LocalClients.ContainsKey(Target))
                                break;
                            Client Attacked = Client.LocalClients[Target];

So now we have who is being targeted...

We need to know how much to heal which in this case I'm not going to bother writing anything fancy for.. Lets just do Spell Level + 1 * 100 (so level 1 heals 100 hp, level 4 heals 500 hp)

uint HpHeal = (uint)(S.Level + 1) * 100;

Lets now see if we are in a team... and if that team contains the target. If so we need to heal the entire team if not we wanna heal just the target.

if (Client.Team != null && Client.Team.Members.ContainsKey(Target))
                            {
                                foreach (Client T in Client.Team.Members.Values)
                                {
                                    if (Calculations.Distance(T.X, T.Y, Client.X, Client.Y) < 18)
                                    {
                                        T.Hp = (ushort)Math.Min(T.MaxHp, T.Hp + HpHeal);
                                    }
                                }
                            }
                            else
                            {
                                Attacked.Hp = (ushort)Math.Min(Attacked.MaxHp, Attacked.Hp + HpHeal);
                            }

That should work perfectly fine... we also need to send the actual effect to the client using a spell packet so lets add that in! (Note: I'm separating these things on purpose so ppl can't just copy/paste cause that bugs me)

So... above the targeting code lets create a new SendSpell class...

Packets.SendSpell Pack = new Packets.SendSpell(Client, 0,0, S);

This makes sending skills sooo much easier cause we can build as we go.

In the team targeting...

Pack.AddTarget(new Packets.Target(T.UID, HpHeal, true));

In the single targeting...

Pack.AddTarget(new Packets.Target(Attacked.UID, HpHeal, true));

Once the spell is all complete (IE: end of the skill handler for this spell) just Pack.Send(); and it should be displayed to all people on the screen.

NOTE: I know, I know it may not be sent to EVERYONE as it uses the main target as the 'center' for the distances but w/e. This is just an example.

What are the cmds/How do I make items/Etc

A: Commands are all located in Handler/Commands.cs

They are sorted into permission type (I never bothered writing out a full system but w/e!)

You can find all the stuff you need there including how to structure things like item cmd

/item ID + - Enchant Gem1 Gem2

There's a decrypted itemtype in the bin folder (items.txt)


How do I change starting items/make non bound

A: By default the source is using the "public void ChangeProff(byte Proff)" method in the client class to handle all starting items/statistics. It's using the "public void StartingItem(uint ID, byte Gem1 = 0, byte Gem2 = 0, byte Location = 0)" method to handle awarding the starting items. If you look in the startingitem code, by default the items have a bless value of 3, are bound and have +5. You can change that however you want quite easily.

Items gained from npcs and from the /item cmd are NOT bound. It was only the starting items cause I didn't want people trying to farm them for composition or w/e.

Console keeps saying general Data 76!

A: Split up the request skills/request proff general datas... I thought I'd done this before but apparently not.

 Spoiler

Simply search "case 75://show hotkeys/items?"

Right above that you will find the combined version. Split them into two separate case numbers and have one do skills and one profs.

Split version...

 case 74:
                                Database.GetProfs(Client);
                                foreach (KeyValuePair<uint, Struct.Proff> Proff in Client.Profs)
                                    Packets.Send(Packets.Proff(Proff.Value), Client);                               
                                Handler.AddBlack(Client);
                                Handler.AddRed(Client);
                                break;
                             case 76:
                                Database.GetSkills(Client);
                                foreach (KeyValuePair<uint, Struct.Skill> Skill in Client.Skills)
                                    Packets.Send(Packets.Skill(Skill.Value), Client);
                                break;

[pro4never]

#RESERVED


I plan on expanding on things as I go... this one post may look short but expand things and you'll realize it doesn't have much room left. Simplest way is just me reserving another post right now to help where I can.


If you have any questions, please post them here and I'll add them to the faq as soon as possible including any possible examples and code snippets.


I still don't understand npcs!!!

A:

This will serve as a full guide to coding npcs in EXTERNAL NPC SCRIPTS!!

Step 1: Add the npc to the server!

You can do this from the database itself but there's a simpler way! COMMANDS!

For those of you who actually bothered to read the commands in the source you would have noticed there is an /addnpc command. You MUST be a gm to use these commands (open the accounts table and set permission to like 5 or something.)

Reading through this command we see we have 3 values to enter...

The Npc ID (script number)
The Npc Mesh (the look of the npc)
The Npc Name (the name of it! *duh*)

So we can do /addnpc ID Mesh Name

But what if we don't know mesh numbers?

Well. There's a command for that too!

/npc Mesh

Will spawn a npc of mesh of our choice where we are located.

NOTE: for those who don't know.. the last digit = direction (IE: 10-19 are same npc... they just change direction)


For this example we'll do... /addnpc 1337 2697 ElitePVPers

So now that we have our npc placed via our cmd we need to create a script! (Notice it shows instantly and is instantly usable but has no script. There is no need to ever restart server in this example!)



(yes... I enabled mobs on mine, deal with it :P)

So... lets go to our debug/npcs folder!

You should see lots of different external scripts in here (notepad works fine for editing, they are plain text). Try opening one and look around if you want.

Lets create our own 1337.npc file using notepad or by copy/pasting an existing npc and renaming the ID.

Lets now paste this text into it for our first simple test.

def npc(Client, Option):
    if(Option == 0):
        Text("This is a blank npc which we can now code any way we like!")
        Link("Cool", 255)
        Finish()
    return 0

Save the file and click the npc again



OOH MY GOD IT TALKS!

There's no reason to need to re-compile the server or anything like that. They work instantly which lets you keep your server running while you fix any bugs in the npc and you still have full access to your character attributes.


So lets go over some main differences in python...

Instead of brackets we will be using tabs to indicate what goes with what (keep sections of code together essentially)

Instead of && / || or w/e we will be using actual words so like...

if (Client.Level > 120 and Client.Level < 130):

Further note that... if statements are different. After the if you MUST place a colon (':')

The statements instead of flowing as

if
else if
else

are now

if
elif
else

It's simple changes but could save you some problems with debugging.


Now, lets write our npc to be a bit more advanced... how about we have it tell us our level and then if over level 120 ask us if we want a free dragon ball?

Here's the full code I'd use personally... Try to break it down and learn from it

def npc(Client, Option):
    if(Option == 0):
        Text("Hey there " + Client.Name + " you are level " + str(Client.Level)+" ")
        if(Client.Level > 120):
            Text("This makes you able to get free db's! Would you like one?")
            Link("Yes Please", 1)
            Link("No thanks", 255)
        else:
            Text("Come back when over 120 to get free dragonballs!")
            Link("I'll be back", 255)
        Finish()
    if(Option == 1):
        if(Client.Inventory.Count < 40):
            Client.AddItem(1088000)
            Text("Check your inventory! You have your free db!")
        else:  
            Text("You do not have enough inventory space!")
        Link("Thanks", 255)
        Finish()
    return 0

[GIANT WARNING]

These python scripts are picky with a few different things you may not be used to!

YOU MUST DO ALL SPACING USING ACTUAL SPACES! 5 SPACES PER INDENTATION. IF YOU DO NOT LIKE THIS THEN USE A PYTHON EDITOR SUCH AS IDLE WHICH DOES IT FOR YOU

YOU MUST CAST ALL NON STRINGS TO STRINGS WHEN PRINTING OUT IN TEXT!

Eg: if you tried to use...
Text("you are level " + Client.Level)

you will get an error.

You must use

Text("you are level " + str(Client.Level))

This is because python, unlike C# does not immediately consider it a string so in this case it's trying to do a mathematical addition vs a string addition. This will obviously cause a problem (think about it... if I said "add 'yes' and 1 and give me the answer", chances are you'd ask me what yes was... is it a number? am I just saying 'yes1', etc.

Yes, python scripts will take a bit of getting used to but they are really cool once you get the hang of them.

*cough* IDLE can be downloaded from the python website... there is also some AWESOME documentation/guides on there.



Mini guide to using Idle:

[HackProvider]

is it possible to make something like a NPCDialog.cs because Im used to that >< and I dont know how to implent it :P
your way of adding NPC's is kinda diffrent than im used to.


thanks

[BioHazarxPaul]

there is a npctalk.cs that you can code npcs using c# in the handler folder

[pro4never]

Originally Posted by HackProvider

is it possible to make something like a NPCDialog.cs because Im used to that >< and I dont know how to implent it :P
your way of adding NPC's is kinda diffrent than im used to.


thanks

I suggest you read the section of the thread on npcs... You can already do it both ways.

[HackProvider]

and how much do you want for some features ??

But I mean I can't add my old NPC coded in that newestcoserver NPCDialog right?

with # alex
case 23423:
additem blabla

#endregion

[pro4never]

Originally Posted by HackProvider

But I mean I can't add my old NPC coded in that newestcoserver NPCDialog right?

with # alex
case 23423:
additem blabla

#endregion

Depends what feature it is.

Yes, yes you can.

Example npc from npctalk.cs

 case 50023:
                        {
                            switch (LinkBack)
                            {
                                case 0:
                                    if (Program.CTF == null || Program.CTF.Red.Members.Count > 0)
                                    {
                                        Text("Capture the flag is not currently running. Check back soon", Client);
                                        Link("Awww", 255, Client);
                                        Finish(Client);

                                    }
                                    else
                                    {
                                        Text("Capture the flag is about to start! would you like to enter the waiting area?", Client);
                                        Link("Yes Please", 9, Client);
                                        Link("No Thanks", 255, Client);
                                        Finish(Client);
                                    }
                                    return;
                                case 9:
                                    if (Program.CTF != null)
                                    {
                                        Teleport(Client, 53, 64, 1616);
                                    }
                                    return;
                            }
                        }
                        return;

[HackProvider]

2 more questions, Why did you release it? and why did you quit your p-server

and you said you would sell features,( create ) could you gimme an example how much you want..

thanks

[pro4never]

I released it to try to move people away from lotf.


The project is not quit. We are simply writing a newer/far better source that we can code things properly from the start. Me and saint were working on the base lastnight actually.


As for selling features it really depends on how much time it takes me.

For example if you wanted a few skills added... maybe broadcast... IE: fairly basic stuff like 25-50 bux but if it was some large system like the new guild system, full monsters system then it would be quite a bit cause it would take a good chunk of my time to do properly. In the case of very large features I'd probably just refuse cause I don't have quite that level of free time.

[HackProvider]

But this source is stable right? so I could use it , and expand it :P do you guys need more members in your team?

thanks

[co-mex]

gOOD tHANK yOU gOOD sOURCE tHANKS fOR sHARE =D!!!

[Iron~Man]

I have only one question, Why you released this?

[{ Angelius }]

Originally Posted by Iron~Man

I have only one question, Why you released this?

lol stop being noisey

its already out there take it or leave it :P

[Kiyono]

Originally Posted by Iron~Man

I have only one question, Why you released this?

Read? He answered it, he said that it was to let people move from LOTF and he had no use for it anyway.

[ßøøm]

Well i have only 17 errors and 11 warnings when i build the source
The 17 errors are all the same "Default parameter specifiers are not permitted" in client.cs the warnings are different just check the spoiler for the warnings.

 Spoiler

"Warning 18 Could not read state file "obj\x86\Debug\ResolveAssemblyReference.cache" . Unable to find assembly 'Microsoft.Build.Tasks.v4.0, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a'. Hellmouth
"

"Warning 19 Resolved file has a bad image, no metadata, or is otherwise inaccessible. Could not load file or assembly 'C:\Users\JD\Desktop\COPhoenix Project\bin\Debug\Microsoft.Dynamic.dll' or one of its dependencies. This assembly is built by a runtime newer than the currently loaded runtime and cannot be loaded. Hellmouth"

"Warning 20 Resolved file has a bad image, no metadata, or is otherwise inaccessible. Could not load file or assembly 'C:\Users\JD\Desktop\COPhoenix Project\bin\Debug\Microsoft.Scripting.dll' or one of its dependencies. This assembly is built by a runtime newer than the currently loaded runtime and cannot be loaded. Hellmouth"

"Warning 21 Resolved file has a bad image, no metadata, or is otherwise inaccessible. Could not load file or assembly 'C:\Users\JD\Desktop\COPhoenix Project\bin\Debug\IronPython.Modules.dll' or one of its dependencies. This assembly is built by a runtime newer than the currently loaded runtime and cannot be loaded. Hellmouth"

"Warning 22 Resolved file has a bad image, no metadata, or is otherwise inaccessible. Could not load file or assembly 'C:\Users\JD\Desktop\COPhoenix Project\bin\Debug\IronPython.dll' or one of its dependencies. This assembly is built by a runtime newer than the currently loaded runtime and cannot be loaded. Hellmouth"

"Warning 23 Could not resolve this reference. Could not locate the assembly "System.Numerics". Check to make sure the assembly exists on disk. If this reference is required by your code, you may get compilation errors. Hellmouth"

"Warning 24 The referenced component 'IronPython' could not be found. "

"Warning 25 The referenced component 'IronPython.Modules' could not be found. "

"Warning 26 The referenced component 'Microsoft.Dynamic' could not be found. "

"Warning 27 The referenced component 'Microsoft.Scripting' could not be found. "

"Warning 28 The referenced component 'System.Numerics' could not be found. "