|
|
| Line 22: |
Line 22: |
|
| |
|
| ==Improving the documentation== | | ==Improving the documentation== |
| ===File types overview suggestion===
| |
| I'd like to throw a general blueprint out there and see if there's any in agreement, or at least any who disagree. It concerns what we're doing with our modding-related articles on the wiki, which is generally One Big Mess right now. The basic principle behind these changes is simple: "groups things logically; present information clearly".
| |
|
| |
| Proposal for organizing things:<br>
| |
| *write an interlocking (interlinking!) page for OBD (called something like [[Overview of file types]]) that explains in plain English what each file does; this puts it all in one place, unlike putting summaries at the top of each page so that a newbie has to follow each file type link to that page to read about the file type; for the format would be something like:
| |
| :"==QXRF== The QXRF type is for tracking the hats the characters are wearing; hat geometries are stored in <span style="color:#0000ff">VPRW</span> files. At level-load, Oni scans the QXRF array and loads the VPRWs. Then, it textures them with the hat textures stored in <span style="color:#0000ff">BINA/LDWF</span> and applies them using the UV maps in that BINA resource that are in the <span style="color:#0000ff">FLSJ</span> format." -- each four-letter type links to an subheading on the <u>same page</u> that explains that type more fully but without any technical details; until this is done, the hard work performed in reverse-engineering these files is shadowed in obscurity for newbies because of the lack of plain English in the OBD pages
| |
| ::New idea: use the <nowiki><onlyinclude></nowiki> tags on explanatory paragraphs at the start of each file type article. Then, transclude every article onto the [[Overview of file types]] page, or whatever it'll be called, and only the explanations will get carried over and compiled into one page. The only catch is that this method would only allow the blurbs to link between other file type pages, or other sections of that overview page; we couldn't have it both ways.
| |
| :::Actually, there's a way to get either kind of link depending on where the text is being transcluded: using an #if: statement in league with the <nowiki>{{PAGENAME}}</nowiki> variable. <nowiki>{{PAGENAME}}</nowiki> actually looks at which page the data appears on, not where it's transcluded from. Voila!
| |
|
| |
| ===BSL tutorial(s)=== | | ===BSL tutorial(s)=== |
| Despite its relative simplicity, [[BSL]] is vastly underdocumented. Most of the stuff is well-known to experts, but designing a comprehensive guide that will get novice scripters started and keep them going requires didactic skills and ''lots'' of patience. There are a few programming language basics that someone ought to say a little about (like [[BSL:Functions|functions]] or [[BSL:Operators|operators]]). Long-term goals are: a cross-referenced set of mini-tutorials that document the functions and variables in a standalone way (see, e.g., [[ai2_allpassive]]); maybe a functional breakdown of an original script (see [[BSL:Tutorial/airport1_level_logic.bsl|HERE]]); and redirects so that typing the name of the variable/function in the Go/Search box leads to just the right place. | | Despite its relative simplicity, [[BSL]] is vastly under-documented. Most of the stuff is well-known to experts, but designing a comprehensive guide that will get novice scripters started and keep them going requires didactic skills and ''lots'' of patience. There are a few programming language basics that someone ought to say a little about (like [[BSL:Functions|functions]] or [[BSL:Operators|operators]]). Long-term goals are: a cross-referenced set of mini-tutorials that document the functions and variables in a standalone way (see, e.g., [[ai2_allpassive]]); maybe a functional breakdown of an original script (see [[BSL:Tutorial/airport1_level_logic.bsl|HERE]]); and redirects so that typing the name of the variable/function in the Go/Search box leads to just the right place. |
|
| |
|
| ==Oni 2 and beyond...== | | ==Oni 2 and beyond...== |