Leadwerks User Guide - LUG

[AggrorJorn]

I'm putting together a Leadwerks 2.3 User Guide. It has all the basic functions inside and outside the editor explained. I

 

Download the LUG here.

 

Current version: 1.01

 

106 pages of useful information that helps you getting around with the Leadwerks engine 2.3. This user guide is ideal for beginners but can also be used by advanced members as a reference guide.

 

*new in version 1.01

fixed several typos

fixed incorrect explanations

updating the light and shadow options (Leadwerks 2.31)

Camera path

road node

corona

edit menu

better mat file explanation

Explanation about shaders

shader usage

 

Things that need to be added in LUG:

 

sounds

ini file and lua representative

[carlb]

I like the looks of that, can not wait till you up load to read

[Hans]

great resource , thanks for ya hard work

[Argorius]

- Under models, it might be helpful to show step by step how to convert some of the purchased models (like Dexsoft) so that they function in the editor correctly. For the most part I figured it out but it would have been helpful to have.

- Explain some of the possibilities that certain scripts/features/functions have and how they would be used in a game environment. An experienced user may look at a set of functions and right away see what they can do with it - a noob looks at it and says...nice...what do I do with it.

- Make sure it is written for noobs...assume they dont know anything...it is easy to end up with a guide that is not detailed enough or "too advanced" for the total noob and the persons who do understand it, know enough already so that they dont really need a guide hehe. Half the time when I see a noob question and then see the answer - it is like a riddle to figure out what they mean...if you know a lot it is hard to imagine how little a noob knows! Anyway, it is probably too much work but osmething to keep in mind!!!

[AggrorJorn]

Thanks for the comments

 

- I don't buy models from Dexsoft so I wouldn't know how this works. Maybe someone else has experience with this. This can be added later though because there a lot of people who buy these assets.

- I can't program, I just try some code and see if it works. Although I understand LUA a bit better then C++, I sometimes don't know exactly how commando's work. However, when Josh makes some new tutorials I might get better at it. I think I'll make a separate Lua user Guide for this.

- I'm trying to make this User guide at a way so that every one can work with the engine. It doesn't mater whether you can program, model, animate or texture. When there are chapters that are unclear to users they can report that and I'll make some adjustments. B)

[macklebee]

I like the concept and its very generous of you to take the time and even open yourself to the inevitable onslaught of questions. Perhaps just focus on LUA since its the common language that most of us will be using alongside whatever other language. As for the dexsoft models, eh... actually it would apply to basically any model... the problem is there are so many different possible conversion methods... so do you just focus on the model after its been converted to gmf or do you try to cover all of the conversion processes?

[AggrorJorn]

I like the concept and its very generous of you to take the time and even open yourself to the inevitable onslaught of questions. Perhaps just focus on LUA since its the common language that most of us will be using alongside whatever other language. As for the dexsoft models, eh... actually it would apply to basically any model... the problem is there are so many different possible conversion methods... so do you just focus on the model after its been converted to gmf or do you try to cover all of the conversion processes?

At first I''l just try to make a non-coding User guide. There are a few lines of code in it, but they are not explained in usage. They are just examples.

I will probably only make somehting Lua. Going into another language would be suïcidale.

I see that conversion of models needs more attention then I originally thought. I wrote a few lines about the conversion tools, but that probably isn't enough. I'll spend some time on how the conversions work, but i'm goign to finish the guide first, so that I can release it this weekend.

[Marleys Ghost]

At first I''l just try to make a non-coding User guide. There are a few lines of code in it, but they are not explained in usage. They are just examples.

I will probably only make somehting Lua. Going into another language would be suïcidale.

I see that conversion of models needs more attention then I originally thought. I wrote a few lines about the conversion tools, but that probably isn't enough. I'll spend some time on how the conversions work, but i'm goign to finish the guide first, so that I can release it this weekend.

 

 

I think Mack has a good point, I'd just stick to the LE specific tools and their use, otherwise you'll end up being expected to "debug" peoples entire workflow from start to finish.

[Pixel Perfect]

A concise guide like this sounds great. I'm sure a lot of people will be very grateful, thanks Aggror.

[Canardia]

We should have 3 kinds of tutorials:

1) How to start with LE (doesn't exist yet, although the official tutorials cover an essential part of that)

2) How to use LE (looks like this tutorial is gonna do that)

3) How to make a game with LE as fast and efficient as possible (Power Tutorial tries to cover that)

[AggrorJorn]

We should have 3 kinds of tutorials:

1) How to start with LE (doesn't exist yet, although the official tutorials cover an essential part of that)

2) How to use LE (looks like this tutorial is gonna do that)

3) How to make a game with LE as fast and efficient as possible (Power Tutorial tries to cover that)

When Josh is back from his weekend of I will ask him what kind of tutorials he is making. I hope to see some updated videos instead of new feature tutorials.

[Richard Simpson]

Yeah i agree with the tutorials, would be great, and thanks for your hard work on this Aggror. It will come in very useful for me

[AggrorJorn]

I've updated the index.

 

only thing left to write about are

• Terrain editor
  
• Model viewer
  
• Texture editor
  
• Conversion methods
  

I think that I'll do the texture editor and conversion methods later this week.

[macklebee]

nice work. Very generous of you to devote so much time and effort to this. +1 to you sir.

[Marleys Ghost]

Very Generous of you Aggror as others have said, thank you for your time

[AggrorJorn]

Thanks Marley,

I'm afraid I can't finish it this weekend. I'm half way done with the terrain editor and I need to do the Leadwerks SDK and model viewer.

 

I promise that it will be availeble for download aprox 1 week.

[Pixel Perfect]

I wouldn't rush it. If it's going to take a while longer to get it how you want it that's fine, we are patient people

[Marleys Ghost]

Thanks Marley,

I'm afraid I can't finish it this weekend.

 

 

 

Oh thats quite alright Aggror ... ready to DL monday night will be fine ...

[Hans]

That sounds great, but yes if it dont look right dont post it till it is

[AggrorJorn]

Due to some overwork I wasn't able to finish it today. I'm going to skip the model conversion for a while as I need to research that first before I can start writing about it. I jsut saw the edit menu in the terrain editor. Thats quite the menu as well but I'm gonna skip that for now.

 

only thing remaining is the explanation about the deault lua menu's and special objects. index updated.

[Marleys Ghost]

Due to some overwork I wasn't able to finish it today

 

 

 

Its no good Aggror we are going to have to sack you ...

 

seriously I agree with Pixel

 

I wouldn't rush it. If it's going to take a while longer to get it how you want it that's fine

 

it will be ready when its ready ..

[AggrorJorn]

Uploaded the first version of the Leadwerks 2.3 - User Guide.

 

http://leadwerks.com/werkspace/index.php?/page/index.html?record=16

[carlb]

just had a quick look and it looking good

will later on have a good look at it

 

keep it up and thanks

[Josh]

This is really good.

[smishra]

Uploaded the first version of the Leadwerks 2.3 - User Guide.

 

http://leadwerks.com/werkspace/index.php?app=downloads&showfile=88

 

The link does not seem to work. Has the file been moved?

 

Thanks

Sanjay