Wednesday, October 11, 2017

How May I Help System You

Now that I've been building my text based game engine forever, it's time to write the admin tool's help system. I'm using plain text files and parsing them into a SQLITE DB. The challenge is organizing the help topics so that it is easy to track down what you need - even if you don't necessarily know what you need.
 
There are a LOT of pieces to defining games - learning how to write the game definitions, how to even use the game engine admin tool itself, how to build and play the games, what admin tools are available for debugging... it goes on and on.

I want to keep the help topics to a single page (Fits on the screen without much scrolling), which makes the challenge even more, well, challenging. Here is my approach so far:

I started at the highest level:
- Getting Started
- Using This Help System
 
etc

These topics are like tables of contents, they give a brief description and which more detailed topic to view.
 
Those topics then drill down into other topics. This would be a nightmare if it was the only way to get around, but it is useful if you aren't sure what you need etc.

Help topics are shown by specifying the topic's alias. If you don't know the alias, or mistyped it, the help system will search the topics for matches and list those for you.
 
There is also a topic index so you can see the titles in alphabetical order.
I will be utilizing this help system as I build the rest of the demonstration game, we'll see how painful ... or useful! it is.

No comments:

Post a Comment

From Shotcut to Kdenlive

So I've been using Shotcut for a while now, for my YouTube videos... and music videos. I love the application. Slicing clips, doing fade...