Documentation changes for Version B.

- also I remembered what the slide portion was.
This commit is contained in:
Iam Naughton Phier 2014-08-05 10:49:15 +03:00
parent 6a20734094
commit a06a65bb95
5 changed files with 36 additions and 29 deletions

View file

@ -26,7 +26,7 @@ source = [
'16col/avatar.coffee',
'16col/xbin.coffee',
'16col/pallette.coffee',
'16col/fonts.coffee'
'16col/fonts.coffee',
]
task 'build', 'Build merged file for production', (options) ->

View file

@ -9,6 +9,8 @@
Coded by Sir Garbagetruck / Accession 2013
Uses fonts by DMG, http:trueschool.se
Uses SixteenColors textmode js library for rendering
(well, my optimized version...)
Version B
--
This ANSI / Ascii viewer was designed _SPECIFICALLY_ to
address shortcomings with acidview and other viewers in
@ -31,8 +33,8 @@ so if we just would do something in a browser, it would
all work out nicely.
That was the impetus for this, and it's turned out...
well, fairly well. It has been used at Revision 2013
and Evoke 2013, and the folks who saw their stuff in
well, fairly well. It has been used at Revision,
Evoke, and Payback, and the folks who saw their stuff in
it have basically said it is really good. I think it
needs a bit more feedback and some bugfixes, and the
folks at sixteencolors have had some suggestions and
@ -68,25 +70,21 @@ for details, or just get the license:
* tl;dr wtf omg how duz thz wrk omg wtf
1. Place the important files (.js, .css, .html, .sahli) on a webserver or local directory.
2. Put your ansi and ascii files on the webserver / local directory.
3. Edit the 'list.sahli' file (it's json) to have
the proper filenames.
* yes an editor is coming for the standalone
* for the integrated-with-partymeister version,
partymeister will do the sorting/listgen and you
will take the generated 'pack' and ... do something.
I'll write that code at some point after we work out
the details.
4. If you want edit other stuff too, like the descriptions
1. Place the important files (.js, .css, .html, .sahli)
on a webserver or local directory.
2. Put your ansi and ascii files on the webserver / local
directory. (Or unpack your colly, etc...)
3. Fire up the editor and set up the .sahli file.
Alternately, edit it as JSON. (Just be sure it's 100%
correct or your show won't go like you planned.)
5. Open the index file in your browser. Something like
http://localhost/somewhere/sahli/index.html
or if it's on the web, then:
** or if it's on the web, then:
http://www.example.com/ansiasciicompo/sahli/index.html
6. When it says things are loaded, hit 'space' - OR ? or h
? and h are "help"
7. Everything is done by keys.
8. Ok on a tablet tap corners and stuff, cuz no keys.
8. On a tablet tap corners and stuff, cuz no keys.
- Great so yeah why is it 'Sahli'
@ -97,3 +95,6 @@ than a Truck-can't-speak-Finnish-well accent.
- Example files are from Breakpoint 2013's compo, credits:
H7/Blocktronics/Accession, Urs/Mercury, Ted/Pöo-crüe^3ln,
Azzarro/Madwizards.
- More examples came from 16colors archive. When the final
Sahli ver. B comes out, I'll select some test files and
put those credits in here too.

View file

@ -1,4 +1,5 @@
{
"location": "subdir",
"slides": {
"background": "screen.png",
"template": "template.html",
@ -7,6 +8,7 @@
"filedata": [{
"file": "spaceflight.asc",
"name": "Spaceflight",
"filetype":"plain",
"amiga": true,
"width": "80",
"author": "Urs",

View file

@ -2,14 +2,19 @@
A Sahli file is JSON, so all JSON formatting and rule processing applies.
There are 2 primary sections within the file: The slide section and the
Version A:
There were 2 primary sections within the file: The slide section and the
filedata section.
Version B:
3 primary sections, slide / filedata and now location.
=== location ===
The directory in which the slide and filedata files sit.
=== slides ===
This, if implemented (which it isn't) would allow you to show a different
look - i.e. if you were not using partymeister and needed a showcase that
was different than the standard look.
This, if implemented (which it isn't) would allow you to generate slides-
such as if you weren't using partymeister for slides.
"slides": {
"background": "screen.png",
@ -18,14 +23,13 @@ filedata section.
},
background: a file that would be put in the background when showing
the files. This is not implemented in version A or B.
template: a html template, which would be used to... I don't exactly
know what I was thinking with this templating, possibly a method of
displaying a different menu or something else. Not implemented and
I honestly have no idea if I will do that because I don't know why
I have it here.
css: This would let you define the css for the entire Sahli, which could
possibly override fonts and so on. (Because it's css.) Not implemented.
the slides.
template: a html template, which would be used to display the 'info'
on the slide. (Author, line1, line2, text, etc.) Not implemented, but
when it is, it probably will allow you to have blank spots for each of
the variables in 'filedata.'
css: This would let you define the css for the slide; thus allowing
font changes for each line, size changes, color changes, etc.
=== filedata ===
@ -106,4 +110,3 @@ filedata section.
bg: similarly, this is the background color for ascii. I believe this may
work whichever rendering mode you use.
line1 / line2 / text: Stuff for the info panel.

View file

@ -1,6 +1,7 @@
x 2014-04-16 (C) separate to individual renderers @16colors
(C) load to array/picture, render from picture @16colors
(C) speed up rendering more? @16colors
(A) Add "type" of file(format) - plain, xbin, etc.
(A) remove the SAUCE lines at bottom, return ANSI object for render @SAUCE
(B) load SAUCE into 'info' lines (should be done at prep) @SAUCE