Development instructions?

[Alan Hazelden]

Hey Stephen,

Are there any docs for working on the PuzzleScript code? Would expect there to be a file listing dependencies for running compile/inline but I didn't spot one.

Possibly I have no need to run compile, but presumably I should be using inline to update standalone_inlined.txt whenever I touch a javascript file? Or would it be better to mostly ignore that and let you update it prior to new releases?

(In general the presence of an auto-generated file like that in the repository makes me a bit wary but I can't make a strong argument for doing it another way at this point.)

Alan

[Stephen Lavelle]

Hey there - there aren't any docs.  I'll add it to my to-do list, but for now I'll try explain here what the deal is so I can direct others who ask in the interim. (though, probably just skip to the penultimate paragraph and then decide whether the rest is worth reading). 

inline generates the template used by export - it's called automatically by compile, and unless you're testing out exporting, you don't need to run it each time.  Sharing doesn't make any use of inline.  For most testing, you can just open up editor.html in the src directory (if you have trouble with some stuff not working (I can't remember what bits rely on this, definitely export), you have to set up a local http server - http://www.linuxjournal.com/content/tech-tip-really-simple-http-server-python has the easiest instructions for this, if you have python.  Inline calls this node.js program - https://github.com/remy/inliner , which you'll have to have installed for it to work.

>(In general the presence of an auto-generated file like that in the repository makes me a bit wary but I can't make a strong argument for doing it another way at this point.)

please please please don't try to convince me that it's not necessary.  It's *very* likely not worth the trouble.

If you want to compress the website, which I don't really recommend, tbh, you'll have to call compile

compile makes use of a couple of programs to compress css/javascript - you may have to fiddle with it - in particular closure.jar has to point to the google closure compiler - https://developers.google.com/closure/compiler/ .  It also references this html compressor https://code.google.com/p/htmlcompressor/ and probably some other stuff.

-----

But, so long as you don't want to produce a compressed version of the site, and don't need to test out the export option, you don't need to run any scripts.  For running test branches, fixing bugs, implementing new features, it's enough (I'm pretty sure).

-----

Thanks a lot for mentioning this.  A couple of people've figured it out by themselves, but it's good to have this info public.

Peace,

S

--
You received this message because you are subscribed to the Google Groups "PuzzleScript" group.
To unsubscribe from this group and stop receiving emails from it, send an email to puzzlescript...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

[Stephen Lavelle]

One other thing I should mention - I don't have separate dev/release branches, so occasionally stuff might not work.

[Alan Hazelden]

> But, so long as you don't want to produce a compressed version of the site, and don't need to test out the export option, you don't need to run any scripts.

The reason I was playing around with this was that I was fixing a couple of problems with exported games :)

Related question: what is your preferred format for patches? Github bug report with link to commit? Github pull request? Email?

[Stephen Lavelle]

Ah, ok :). Any of these methods are fine. I usually end up reimplementing things manually, rather than automatically merging them.

[Stephen Lavelle]

Having purchased to a new laptop, I find myself having to install additional software to compile, that I might as well note here

gifsicle

pngcrush (on osx, it's useful to install macports IIRC, still in the process)

[Stephen Lavelle]

also https://github.com/yui/yuicompressor/releases

--

You received this message because you are subscribed to the Google Groups "PuzzleScript" group.
To unsubscribe from this group and stop receiving emails from it, send an email to puzzlescript...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.