IFComp walkthrough best practices

Volker T. Blasius’ narrative walkthrough for World is a work of art in itself.
Downloadable from the IFDB game page (worldsol.zip) here: World - Details (ifdb.org)

Hear, hear!

4 Likes

I much prefer gradual hints instead of walkthroughs.

2 Likes

Sound advice, thank you!

I agree, they’re great! I guess an implicit part of my question was “is a good IFComp walkthrough the same as a good general purpose walkthough?” If so I suppose the best advice is “Just do what David does.” :slight_smile:

Thanks for bringing that walkthrough to my attention, I’ll be sure to have a look at it.

I personally agree, but perhaps A, different people have different tastes so it doesn’t hurt to have both. And B, within the scope of the competition perhaps some players don’t want to (or have time to) engage with the puzzles and just want to zoom through the game.

3 Likes

Good old plain text is fine, or you could alternatively consider PDF or HTML, then you could distribute the content over several pages and have a clickable table of contents to let players jump to specific sections, minimizing their exposure to (unintended) spoilers.

I like plain text for maximum opening speed and ease of use – sometimes a PDF reader or a browser opens sluggishly, when a lot of tabs were open in the last session. But the TOC aspect could make these other formats worthwhile. Or you could even get fancy and make it look like a sort of in-universe resource, feelie-style, as long as that doesn’t impede its usability for a frustrated player.

(About the content itself, I have nothing to add to Patrick’s great answer. :+1:)

3 Likes

If you’re going to release it as a PDF, it better be a pretty one to makeup for the format’s limitations.

PDF readers in general suck. They’re bad on PC and they’re much worse on mobile. Disregarding the fact that there are only a handful of PDF readers even worth using on Android (which I recently discovered while trying to play PDF gamebooks), their fixed page sizes make for itty bitty text on mobile. So small that you have to read the PDF in landscape mode just to be able to see it well. It makes for very poor reading.

So, again, if you’re not going to use any features that make it a reasonable choice over HTML, just use HTML please. Thanks.

2 Likes

Last year, I did a screen recording of me playing the game and explaining what to do. That format was natural for me as I do website tutorials like that all the time. Are there any thoughts about this type of walkthrough?

2 Likes

I generally dislike video content compared to text content, but I think for the specific case of game walkthroughs I’m even more strongly in favor of text content, because you can search text. If I get stuck and can’t figure out what to do with the chicken, being able to search through the walkthrough for “chicken” could be really helpful.

7 Likes

+1

That’s maybe a question of age-related IT preferences - my girlfriend is ten years younger than me, Insta-maniac, always prefering her phone over her laptop and getting all her everyday information via Youtube while I feel uncomfortable without a keyboard, scan Google results for renowned sites and commit Wikipedia to memory. She thinks I’m frumpy, I think she’s ineffective.

As a consequence: I’d always prefer Ctrl+F’ing a .txt/.pdf/.doc/.html in no time to being glued to the screen to watch a video, but I have learned that many people think vice versa, and that statistically I’ll die before them.

6 Likes

Agreeing with the earlier comment about a list of commands being next to useless, I am including an InvisiClues page with my IFComp entry this year. It is basically an HTML page using the standard “details” tag, so the text is hidden until the user clicks on it. Each puzzle has a series of clues getting more and more explicit. The page can be accessed from the game by typing “hint”.

5 Likes

This is absolutely not a best practice, but I thought it was a notable example of something you COULD do.

For our #8th placed IFComp 2008 game, Ürs, the game is written in 2nd person of course, but the walkthrough was written as a history of the character as if they had already completed the game:

The ifdb entry if you want to know more:
https://ifdb.org/viewgame?id=bzxt7fme5nwrqto1

7 Likes

That reminds me of Alan Wake. That game is about a novelist and the voice over in the game is told like a noir-style novel. So it only makes sense that the entire strategy guide is written like a novel.

3 Likes

This thread is extremely useful-- I’ve totally changed everything about my walkthrough after reading through it. Thanks for starting it, Nils.

3 Likes

What about Savoir-Faire style Invisiclues as a walkthrough? I like that format because you can uncover hints slowly, although the text is awfully pale when you mouse-drag over it. I like this because I can divide the walkthrough into individual rooms that can be clicked on without you having to search through a text document that might give spoilers.

Thoughts on this as a best practice?

Highlighting white-on-white text isn’t standardized. It doesn’t work on all browsers. In particular, it tends not to work on mobile browsers.

2 Likes

Good to know. So that’s right out. Standard walkthrough it is.

You can of course always include a menu with gradually more explicit hints in your game itself, and for the external walkthrough, you could try what @The_Pixie suggested above, and put the individual hints behind the details HTML tag: <details>: The Details disclosure element - HTML: HyperText Markup Language | MDN

2 Likes

I love just using spoiler tags here on the forum. Here’s an example of invisiclues I made for Counterfeit Monkey.

4 Likes

This is too late for IFComp (this year) but I had some thoughts I hope are helpful.

First, yes, I agree David Welbourn’s walkthroughs are great! If you’ve seen his Trello website, you’ll notice he fills in a lot of details. More than you as an author might want to. But you can pick and choose what works best for you, what parts of his checklist are a good use of time.

I’ve often based my walkthrough, or the first draft, on the test commands I wrote. It’s not hard to do a search-and-replace in Notepad++ or your favorite text editor e.g. replace / with \n\n> or \r\n\r\n>. (It’s also not TOO bad to write a python script tracking that these are synced between your test command and/or walkthrough.) That way, I know I have something that just barely works. The extreme case is when I’ve seen walkthroughs that go

e / n / w / etc.

And I know the programmers 1) used Inform’s TEST command (“test win with e/n/w/etc.”) which is good and 2) didn’t use much else, which is not.

I know I take into account what my testers had trouble seeing when writing a walkthrough. I think there will also be certain checkpoints where it’s useful to say, okay, you should have X, Y and Z at this point. You should have unlocked room W. This is a good place to save.

@StJohnLimbo I totally didn’t know about the details tag! That is pretty awesome. I remember wishing there was one but figuring it didn’t have enough general usefulness.

I prefer text content, largely due to searchability, but I think being able to break videos up helps a lot … someone at least knows where approximately to start. And there’s always watching at double speed. All these small features make me really want to try a video walkthrough.

Also, I appreciate (in addition to annotations) if the author says “OK, this one is one worth putting the walkthrough aside to solve.” Sometimes when I try to plow through a competition, some entries need to be in heavy-walkthrough mode, and I get the gist of them with just a walkthrough and then trying to recall the way through later.

But I’ve found some things work in terms of general process:

First, a walkthrough is worth looking at once a week. Make time for it. That doesn’t sound like much, but it helps me pull back and see the big picture after focusing on one area of coding. Sometimes the others get a bit fuzzy, and that’s good, because if I’ve forgotten an assumption I made when writing a walkthrough, I’ll find a hole in the walkthrough. Proofreading my walkthrough can also help me get back in the flow if I’ve left a game to sit. The better it is early on, the more there is to revisit and picture someone saying “Hey, that doesn’t quite make sense!”

Second, it helps to have a “gunner” tester with a week or two who might not be the game’s target audience, but they’re willing to sit down and maybe even play dumb with the walkthrough. They might not even worry about the story–just verify things work or say “you should write X or Y in.”

4 Likes

I wanted to post this when the topic first appeared, and now that the competition is underway, I can. I was a beta tester on Mike Carletta’s The Song of the Mockingbird and the walkthrough he wrote for it really blew me away. The chatty style matches that of the game. It tells you not only what to do, but why you’re doing it. In one or two places it gives you a clue before revealing the solution, giving you one last chance to work it out for yourself. Occasionally it suggests trying things that won’t work, but which will nevertheless help broaden your understanding. I thought it was exemplary and I’m going to use it as the model for my own walkthroughs going forward.

12 Likes

I agree, this was really big. As much as I like a move-by-move walkthrough, I think Mike’s gave you latitude to try things out and solve a secondary puzzle, maybe not as satisfying as doing things yourself, and maybe trivial, but still enough of a puzzle.

Certainly some of my favorite moments have been when I’ve done something wrong or taken that path that doesn’t quite work, and I see why it doesn’t, and the lightbulb goes off, and that’s not something a move by move walkthrough lends itself to. (Unless the walkthrough is wrong. But we don’t want to go there.)

I’ve also found myself worried I’m begging people to look at something funny in a walkthrough. “Hey, you might want to look at this before continuing!” makes the point but is clunky. And an AMUSING section at the end of the game, while it works, is just a list and does force the player to play through again. It’s tough to nudge people constructively to look for neat stuff, whether in IFComp or real life, but yeah, this walkthrough does things well.

I’ve certainly read walkthroughs that try to add jokes that aren’t in the flow of the game, but they can put the focus on the author, which isn’t terrible, because it provides some relief and encouragement, but it isn’t great. And I certainly have a worry that any creative energy I’d put n a walkthrough might be better off in the game… so it’s best if we stay within the lines. In the case of SotM there’s a lot to work with inside the lines, though!

5 Likes