Sean Meighan

Welcome => User Manual => Topic started by: flyinverted on August 15, 2015, 07:05:10 PM

Title: xLights / Nutcracker User Manual initial release
Post by: flyinverted on August 15, 2015, 07:05:10 PM
--==>>> You MUST be logged into the forum download the file <<<===--

I am pleased to announce the initial release of the xLights/Nutcracker User Manual.
Gerard Machado (Australia) and Kevin Pankratz (USA) responded to the plea for help a few months ago and have taken on the lion's share of this endeavor.  They have been making changes daily as the developers keep adding new features to xLights.  Please say thank you to Gerard and Kevin.

This will be a living document with constant updates as the software evolves. This 1.0 release is the equivalent of the reference manual that comes with your automobile. It goes over the features, however it won't make you great driver. You will though have a reference to what each feature does.

Future versions/updates of the manual will be on the Nutcracker releases page.

There is still MUCH to be added in this manual.
Future planned sections will include
* How-to for converting from other lighting sequencer applications
* Advanced sequencing options for some of the effects like Morph
* Sequencing tips for adding emotion to your sequences
* Other task specific lessons and tutorials.

Thank you!
Steve

[attachment deleted by admin]
Title: Re: xLights / Nutcracker User Manual initial release
Post by: ocanada1 on August 15, 2015, 08:53:34 PM
Thank you Gerard and Kevin for your work in this.


Sent from my iPhone using Tapatalk
Title: Re: xLights / Nutcracker User Manual initial release
Post by: ikke1981 on August 15, 2015, 09:22:58 PM
Special thanks to all the contributors and dev's from lights/nutcracker. I still have a lot to learn. But the manual will surely help a lot.


Verzonden vanaf mijn iPad met Tapatalk
Title: Re: xLights / Nutcracker User Manual initial release
Post by: Clovis84 on August 16, 2015, 02:04:55 AM
 :)Great resource! There is so much information to learn, this helps a lot.
Thank you
Title: Re: xLights / Nutcracker User Manual initial release
Post by: lightpro on August 16, 2015, 11:41:35 AM
Thank you Gerard and Kevin.
Title: Re: xLights / Nutcracker User Manual initial release
Post by: jnealand on August 16, 2015, 12:37:54 PM
Thank you Gerard and Kevin.

+100 for this.  One suggestion is to add a version number to the file in the wiki so when we look in the wiki we can see if the file is newer than the last one we downloaded.  This ver number should be not try to match to the releases since that may limit the times when you update if and when releases slow down.  Besides we should not be having files that support old versions of the ver 4 software versions IMHO.
Title: Re: xLights / Nutcracker User Manual initial release
Post by: scuba on August 16, 2015, 04:41:51 PM
Great Work!!!!

 Thank you so much for this effort.  It will help both Newbie's and experienced users alike (I'm talking about me!)

Thanks again!
Title: Re: xLights / Nutcracker User Manual initial release
Post by: danj on August 16, 2015, 06:52:33 PM
That is TOTALLY AWESOME.   Thanks Gerald and Kevin!!!!!!
Your time and effort is VERY MUCH appreciated
Title: Re: xLights / Nutcracker User Manual initial release
Post by: sean on August 16, 2015, 08:39:37 PM
I would like to take the time and thank
Gerard Machado (Australia)
Kevin Pankratz (USA)
Steve Giron (USA)
for the tremendous amount of work that they put into the xLights user manual! I have posted a link to this manual on the releases page. I will try to keep it always current. There will be a version number and the date when it was last updated. http://nutcracker123.com/nutcracker/releases/

This year I have seen a change, a good change. People ask questions about xLights, Falcon, FPP (Setup, how to create effects, .etc.) i see more and more users answering and helping.

Gerard, kevin and Steve have stepped up and gave us a xlights manual.

It is nice seeing us becoming a community

thanks to all the volunteers

sean
Title: Re: xLights / Nutcracker User Manual initial release
Post by: gerry on August 16, 2015, 10:33:37 PM
Thanks Sean !

It has been nice being able to contribute and not leaving everything to the developers only.

I think , too , the grid based 4.x  version, the fact that it was released as a Beta very early in the year and the fantastic rate of updates meant that people had a much better chance to try it out and participate in assisting others coming on board later.

Similarly with the FP.

In addition , the videos that you , Steve , Dan and Gil do when new functionality is built are fundamental to its success. Otherwise you can have the most complete/complex capability, but without people knowing about it and how it can be used, it wont be as valuable.

I know others have also said so, but having the developers (xl and FP) respond to questions / issues and provide so much of their time has been phenomenal.
   

Title: Re: xLights / Nutcracker User Manual initial release
Post by: Dazzled on August 17, 2015, 06:16:56 AM
Fantastic effort guys, I didn't expect a 138 page BOOK!!! when I downloaded it.

Now to get it printed on a high quality printer and bind it to do it justice.

Thanks again
Stuart
Title: Re: xLights / Nutcracker User Manual initial release
Post by: keithsw1111 on August 17, 2015, 06:21:00 AM
--==>>> You MUST be logged into the forum download the file <<<===--

I am pleased to announce the initial release of the xLights/Nutcracker User Manual.
Gerard Machado (Australia) and Kevin Pankratz (USA) responded to the plea for help a few months ago and have taken on the lion's share of this endeavor.  They have been making changes daily as the developers keep adding new features to xLights.  Please say thank you to Gerard and Kevin.

This will be a living document with constant updates as the software evolves. This 1.0 release is the equivalent of the reference manual that comes with your automobile. It goes over the features, however it won't make you great driver. You will though have a reference to what each feature does.

Future versions/updates of the manual will be on the Nutcracker releases page.

There is still MUCH to be added in this manual.
Future planned sections will include
* How-to for converting from other lighting sequencer applications
* Advanced sequencing options for some of the effects like Morph
* Sequencing tips for adding emotion to your sequences
* Other task specific lessons and tutorials.

Thank you!
Steve
Guys this is awesome.  The only thing I would love that I didnt see is an explanation of each of the layer blending options.
Title: Re: xLights / Nutcracker User Manual initial release
Post by: kevinp on August 17, 2015, 07:53:51 AM
In the next release of the manual there is a chart explaining the different layer blending modes.
Title: Re: xLights / Nutcracker User Manual initial release
Post by: Buckeyelights on August 17, 2015, 10:05:03 AM
Wow, very impressive.  Thank YOU!!
Title: Re: xLights / Nutcracker User Manual initial release
Post by: rando1957 on August 17, 2015, 11:25:39 AM
Thanks guys for all the hard work in  putting this together.
Title: Re: xLights / Nutcracker User Manual initial release
Post by: sean on August 17, 2015, 02:26:53 PM
found a place that will print 150 pages, spiral bound for $24

https://www.mgxcopy.com/products/spiral-bound-booklets
Title: Re: xLights / Nutcracker User Manual initial release
Post by: neil on August 17, 2015, 02:54:30 PM
I would wait to see more changes in the near future before having it printed.
Title: Re: xLights / Nutcracker User Manual initial release
Post by: DDameron on August 17, 2015, 06:06:58 PM
WOW... Thanks guys for doing this !!!
 On page 75 it talks about a pixel/matrix editor... Where is that located? Or what program is that?
Thanks, again, for your efforts !!!
Dan
Title: Re: xLights / Nutcracker User Manual initial release
Post by: kevinp on August 17, 2015, 07:43:22 PM
The Pixel Editor (Matrix Drawing Tool) is part of the Pictures effect.  When you drop that effect onto the grid the Effect Assist window should automatically be displayed so you can draw on your model.
Title: Re: xLights / Nutcracker User Manual initial release
Post by: DDameron on August 18, 2015, 09:19:24 AM
WOW... That is great... Thanks !
I had never dropped a picture effect in V.4... Duh !!
Dan
Title: Re: xLights / Nutcracker User Manual initial release
Post by: Steve Gase on August 19, 2015, 12:40:37 PM
suggestion:  how about a new section in the forum to discuss the "Manual"

PLEASE NOTE !!!   I am not trying to be critical, only offering helpful feedback !!!!

As I read through it, i see places that that might offer embellishment.
I think having "notes" off to the site for links to video tutorials, or links for more info would be helpful.  Adding too much detail would create a something too intimidating, but links for more info might fill in details when the reader has more questions.

There are places where the content is more complete than others...  the queen mary vamp instructions are for linux, and I didn't see the info for windows yet.  (maybe the included INSTALL_win32.txt file is sufficient?)

anyway... a section where people can offer input, suggest corrections, or request more info on sparse topics would be helpful.
Title: Re: xLights / Nutcracker User Manual initial release
Post by: Gilrock on August 19, 2015, 02:54:11 PM
suggestion:  how about a new section in the forum to discuss the "Manual"

Umm...aren't we in the "User Manual" section of the forum?  Here's your sign.
Title: Re: xLights / Nutcracker User Manual initial release
Post by: Steve Gase on August 19, 2015, 03:01:23 PM
oops!  :-X
Title: Re: xLights / Nutcracker User Manual initial release
Post by: flyinverted on August 19, 2015, 03:31:26 PM
suggestion:  how about a new section in the forum to discuss the "Manual"

Umm...aren't we in the "User Manual" section of the forum?  Here's your sign.

Now THAT was funny.   :) ;) :D ;D :o 8) ::) :P
Title: Re: xLights / Nutcracker User Manual initial release
Post by: gerry on August 19, 2015, 06:06:48 PM
Hello Steve,

Suggestions and corrections are most welcome.

The reason that some areas are more described than others , is that , it reflected the experience (or inexperience) of the contributor in that area/questions on the forum/fb.