iamgreaser / iceball

Open-source rewrite of the VOXLAP version of Ace of Spades.
http://iceball.build
GNU General Public License v3.0
114 stars 32 forks source link

Basic in-engine tutorial (pkg/iceball/halp) #52

Closed iamgreaser closed 11 years ago

iamgreaser commented 11 years ago

So I've started a very bare-bones framework for showing text with informative stuff in it.

It will eventually be expanded to be a help viewer, with categories and stuff. client.img_blit_to might come in handy here, so not to choke everyone's comps. (the software renderer should be totally fine for this)

Hopefully this will be the "double-click default".

According to Triplefox's Iceball Enhancement Proposal (IEP) no. 1, which at the moment is the only IEP there is, there will be 3 sections for documentation.

  1. Development Manual. I think a wiki would be good for this, but at the same time, docs/*.txt would be a good place to put stuff.
  2. Gameplay Manual. This is the sole purpose of this issue.
  3. API documentation. docs/*.txt should be fine for that sort of stuff. If you're too lazy to open up a text editor, you're too lazy to develop anything. This is the stuff we actually keep up to date! (well, modding_lua.txt at least)

Anyhow, point 4.3:

The Gameplay Manual is shipped with builds and should be a single Markdown document processed into HTML, with the bare minimum necessary to get started with the client. Additional gameplay docs are best made by players, not developers.

We might skip the Markdown requirement, at least for now, although that could be useful for later on. As for emphasis, well... &eMinecraft colours, &4anyone? (It'll probably be much close to CGA colours, and I think we might go with \033 (ESC).)

rakiru commented 11 years ago

Regarding having a wiki and docs/*.txt, there's this: https://readthedocs.org/ I've seen a lot of projects using it, and it is really nice. It basically works as a wiki that uses markdown files from a git repo, meaning we'd only have to maintain one set of docs (make a repo called iceball-docs or something, unless it can be given a specific folder within a repo).

There's also an issue open already for text colour formatting codes: #8

iamgreaser commented 11 years ago

Sorted. At least for now.