Read this first! Modding Resources

Here are a few resources that may be helpful for understanding and editing code. Angel Script is a scripting language heavily derived from c++ with a small hint of java and it's own unique twist on multiple inheritance. The functions found inside of Angel Script are unique to KAG but the syntax is not. So for one to truly begin to understand Angel Script one must understand c++ and c like syntax. The deeper your knowledge of syntaxing and program structure the more you can accomplish. Here are some online/offline tools and resources.

Text Editors​

In order to be an effective modder you need a text editors that support unix line endings an example of a bad text editor would be notepad this will jumble files into an unreliable mess. The other key component of a good text editor is light weight syntax highlighting. This helps you organize and understand code. The third element that is not necessary but sometimes helpful is completion of variable names. Fourth is the ability to have multiple tabs open at once.

• Sublime Text

Sublime Text editor fits all of these requirements + it has a sleek nice looking skin that is easily customization. There are many different syntaxing schemes available. However the first thing you should do is setup Sublime to read .as files with c++ syntaxing. This will aid you greatly. I prefer Sublime Text for editing Angel Script files. However there are other choices!

• Geany

Geany basically has all the same features as Sublime Text. I only prefer Sublime Text because I have eye strain problems staring at a black on white editor. So Sublime Text with it's nice dark default theme is good for me.

• Wordpad (If you have windows you have this)

Wordpad is basically the dumbed down free version of open office, the one good thing it offers is reading unix line endings. I use Wordpad to read and edit .cfg files. (this can be done by pretty much anything.)

C++ & Angel Script Documentation​

This is pretty self explanatory this may be quite the heavy task to read through these documents if you don't have a background knowledge of programming. But it is the most important thing to do in order to become a modder. I recommend that you read the c++ tutorial before reading the Angel Script documentation as the Angel Script documentation is written for application writers (people implementing Angel Script in their program) So it's very difficult to understand without the knowledge, but none the less helpful when applied to KAG's modding.

• cplusplus.com (pdf) (html, so you don't load the pdf all at once)

I use cplusplus.com very frequently it is a c++ standards documentation website, which has implementation, usage, and documentation on all up to date c++ functions and classes. Now you may be asking why would that be important to me. Well they also provide sufficiently in depth guide to learning c++. I recommend that if you are a beginner you read the chapters called: "Basics of C++" and "Controls Structures" if you are feeling adventurous you can read "Compound Data Types" as some of the stuff found in that section or very important into understanding how KAG interfaces with Angel Script (i.e. pointers). If you someday wish to become modder extraordinaire I suggest reading the entire thing and just becoming a c++ programmer it translates well into Angel Script.

• Angel Script Docs

It is important that before you read this documentation that you have a half decent working knowledge of c++. These documents are meant for application writers intending to use Angel Script in their programs. However they contain useful references to certain data types, structures and how Angle Script is integrated and called.

Misc.​

• IRC

You can join us at #kag and #kag.modding. It is important to be part of an ever growing community of modders and to surround your self with knowledgeable people who can help you. The best of the modding community is on irc nearly 24/7 and some one can help you. Although I my sometimes be grumpy and irritable I will always respond to your questions pertaining to modding. (There are also others.) The worst thing to do is to get stuck on a problem and sit on it by yourself. Bring it up with others so you can get help and solve your problems! Plus we like to see snippets of what people are working on.

• KAG Angel Script API (KAG-Beta>Manual>interface)

In the root folder of KAG-Beta you can find interface files called Objects.txt, Enums.txt, Functions.txt, Variables.txt these give you a rough idea of everything that is available and at your disposal to use. The best documentation of all these things are found directly in the Base folder of KAG inside of all .as files just do some digging and you will find what you need.

• KAG wiki

I'm not a particular fan of this resource even though it is official, it is highly outdated since the devs have not had time to post examples and usages, or even keep up to date with the current functions. I suggest you avoid using KAG wiki for documentation on functions as it will show you old signatures and no longer valid examples. However if you feel confident in your skills feel welcome to edit the wiki and fix entries this is welcomed and appreciated by the devs.
--
KAG Modding API Documentation is now available although it's not complete it is being updated when the devs have time, it is accurate as it is directly from the devs. https://doc.kag2d.com

 

It's cool to see you are doing this stuff. But ye it's best if we keep this thread clean please come to kag.modding in irc and I will help you when I'm available.