Sorry your browser is not supported!

-----------------------------------
Get it, fork it.

https://github.com/Ortu-/ALdocs
-----------------------------------

Download .zip to install for use in the IDE

https://github.com/Ortu-/ALdocs/raw/master/dist/ALdocs_20150325.zip
-----------------------------------

AdvLighting is big, complex, sometimes intimidating, a bit of a performance hog, and gives absolutely fantastic looking visuals for DirectX 9.0c

While it does distribute with some excellent demo projects, it is sorely lacking in explanation and documentation.

This project treats AL as a DBpro plugin, providing a keywords.ini file for the IDE for syntax highlighting and function parameter prompts.

It also provides standardized help files, explaining commands, parameters, and giving usage examples. The majority of these files are currently stubs, but hopefully, we can get them filled in before long.


----------------


This project is on github. Anyone is welcome to fork it and contribute.

I have the keywords file up to date, and have stub pages for every command prepped and ready to fill in. The index and command list files are fully built, it mainly needs work filling in explanations of the commands, their parameters, and how to use them.

I will be working on this as I can, but if any of you other AL users want to fill in some of the stubs, that'd be cool too.

If you want to install the files for use, grab the /dist/ALdocs_20150325.zip

Added a 'Usage Guides' block to the index page, and completed a quickie guide on using Depth of Focus

Commit

This is a great idea, I will contribute as soon as I can.
What is the easiest way to add info to the help files?

sign up on github and install the client
fork the repository to your account
clone it to your local machine
edit the files
commit the changes
send me a pull request so that I can merge your fork with the master

from time to time you will want to merge changes from upstream/master to your fork to get any updates others have made.

github has some decent help documentation on the basics of forking, syncing, merging, and pull requests

Filled in most of the command pages for the directional light.

Commit

the dist/ALdocs_20150325.zip installation is current for use in the IDE. Download clicky

I also found a bug in the command DirLight_SetVisible(boolean Visible) which failed to restore the lensflare after hiding then showing the directional light. Details are included on that command's page, but basically line 94 of AL_Directional.dba needs to be changed from:

if AL_DirLightLensFlare.x>-1 then LensFlare_SetVisible(AL_DirLightLensFlare.x,0)

to:

if AL_DirLightLensFlare.x>-1 then LensFlare_SetVisible(AL_DirLightLensFlare.x,1)