Forum | Tutorial Project

You must be logged in to post Login Register

Search Forums:


 






Tutorial Project

No Tags
UserPost

1:02 pm
February 17, 2010


saluk

Admin

posts 144

Several times I or others have tried to make a good tutorial for PyWright. It is a very important piece that is missing, as the comprehensive but terse doc.txt can make the simplicity of PyWright seem, well, not so simple.

The main thing that has stopped these tutorial projects has been overambition. What starts as writing a quick, simple tutorial eventually grows into an all-encompassing guide of everything. Eventually, it gets too big to actually write and finish. Another issue, is both myself and Ferdielance have focused a lot on the presentation of the tutorial, with me spending a lot of effort on good html; and FerdieLance working with pdf.

I think for now we really need a good, short, tutorial that schools users in the basics enough to get their feet wet. At that point, asking questions, trying things out, or searching doc.txt will be more productive, but before that just getting started can seem impossible.

I want to discuss here with any potential collaborators (StBacchus Wink) how to get this project off the ground and into the hands of the general public.

My idea is for the tutorial to be a few chapters, covering most of the basic things that people will want to do. Getting started will be the first "chapter", and should not be more than a few "pages" long. I think pictures are a must, especially showing how to create the folders for a game, and what you should see when it is running right. Other chapters would focus on dialog, investigations, and court. Different people can write each chapter too, so that all of the work isn't thrust on one person.

Anyone who has good writing skills can help with this, and I think StBacchus will be the leader of the project. It may just be me and StBacchus, but others can help by commenting on the output to improve it!

8:41 pm
February 17, 2010


StBacchus

Madison, WI

Member

posts 39

Are you thinking about adding screenshots to what you have already, or starting from scratch? Either way, I think HTML is the best place to start, because it can be edited easily. Plus once the web pages are done, they can be easily converted into a PDF.


Here are some screenshots to start with. They can be inserted into what you have here already – they just show directory structure and a couple of different resolutions. I used my own game and cases because, well, I don't need permission for that. Smile


I think what you already have for Getting Started is fine. So the next thing to do would be short task-related tutorials. "How to do a Talk scene," etc. How about screenshots showing the actual script side-by-side with the script running in PyWright? That might be helpful, at least for the simple early stuff like placing characters. Does that sound like the right direction?

2:51 pm
February 19, 2010


saluk

Admin

posts 144

Which getting started did you like? I like those pictures, they can enhance it a lot.

Yes, having screens showing both the code, and what the code does, will be helpful. I almost think that less text and more pictures might be better than the other way around. The focus of these guides would be in getting users comfortable with the language and process, rather than showing all of the different ways to do things, or all of the myriad options they have.

Here's a tentative list of chapters that we should think about:

  • How to do a talk scene
  • Investigations
    • The menu command and menu options
    • Talking and moving
    • Presenting
    • Examining
    • Psyce-locks
  • Court scenes
    • Court macro for dealing with all of the characters
    • Introducing evidence
    • Cross examination
  • Transitions
    • How to go from an introduction to a court scene, how to go from a court scene to an investigation
  • Finishing touches
    • Guilty/not guilty, the penalty bar, exiting the case when it's finished
    • Distributing your game

The talk scene chapter is first, after that I'm not sure what the best order to do them in would be. I would like to focus on one chapter at a time, and release each one as it is finished.


Thanks for the offer to help!

1:04 am
February 21, 2010


StBacchus

Madison, WI

Member

posts 39

You're welcome! I'm working on my own case, so doing this at the same time makes sense. It's helpful for me too. :)

What I meant by Getting Started is the first 3-4 chapters of documentation on the website here. I'm a little torn on "Scripting and commands" because I feel like it's easier just to look at some examples and jump on in – but I guess that's a personal preference.


Here's an, er, demo:

This is a draft, and the whole style may depend on how you can integrate things with Wordpress anyway. But in general, is this about what you were thinking?

1:30 pm
February 21, 2010


saluk

Admin

posts 144

SurprisedSurprisedSurprisedSurprised

Great job StBacchus, I think they look really beautiful. When the rest of it is set up, we can link commands to their full description so that people who want to see more can, but excess information doesn't overwhelm.

So what I'm getting is, stick with the general text of the current docs up to the scripting, but add the screenshots and fix formatting of everything, and then add these onto that? That sounds good, since I am none too happy with the direction things went once I got into the scripting part.

I also really like the two panes, where a quick glance at the screenshots conveys enough information to get your feet wet.

If my "Scripting and Commands" is going away, I think you should start "Setting up your script" with a line or two about using a text editor. It's something that frequently trips up new users.


Nicely done! I don't mind if it fits into wordpress or not, it might be better as a separate entity, it can come packaged with the engine that way.

4:52 pm
February 21, 2010


StBacchus

Madison, WI

Member

posts 39

Thanks! Laugh

When the rest of it is set up, we can link commands to their full description so that people who want to see more can, but excess information doesn't overwhelm. So what I'm getting is, stick with the general text of the current docs up to the scripting, but add the screenshots and fix formatting of everything, and then add these onto that?

That's just what I was thinking. I don't think "Scripting and Commands" needs to go away, there's lots of good info in there. It's just a little intimidating as the first thing someone might read, so maybe it would be better off as a "For more information, see…" kind of thing. Good point about text editors, I'll add that.

Alright! Now that I have a template, I'll keep going with that. We can worry about how to fit it into the website whenever you have time to work on it. If you do decide to go with a wiki or something else, it shouldn't be too hard to transfer.

7:46 pm
February 27, 2010


StBacchus

Madison, WI

Member

posts 39

The links above are now obsolete. I also added some stuff:

My fiddling will be moot if dougidog does make a wiki. But this may go faster then, since I won't have to worry so much about changing titles, moving things around, etc. And others will be able to help out if they want…that's fairly impossible now, although of course I'm happy to take suggestions!

1:19 am
February 28, 2010


saluk

Admin

posts 144

I think a wiki would be more for long term use with many users; for authoring it's probably best for you to just focus on your own part of it. Just don't get too caught up in style, we can always play with that.

Some of the images seem to be missing? Setting up your script for example.

The blurb about making blank nameboxes is kind of awkward. My fault I know. The nt command is supposed to work on its own. It's these kinds of quirks that I really want to eliminate by 1.0. OTOH, it is a good thing to have documentation of such quirks. This is the missing documentation that I never wrote into doc.txt or anywhere else :)

This looks really in depth. I especially love all of the details about each aspect of doing text. It's such an important thing in AA styled games. Things like showing an example of scene setting text are a nice touch. I also see parts where you used my descriptions. I'll be reading, and start getting a bit confused, and then realize it was my text, hehe. But that's OK I think. It's better to have a lot of OK docs, than to have a small amount of perfect docs; or, as is now the case, a small number of highly imperfect docs!

You seem to be getting through these pretty rapidly, I'm impressed. It won't be long before we do actually need to figure out how to integrate them either with the site, the engine, or both. I might just put them up as-is and link to it, without running it through wordpress. It's faster that way.

12:58 pm
February 28, 2010


StBacchus

Madison, WI

Member

posts 39

Yep, I did use your descriptions wherever possible. Goes faster that way, and I prefer to work in drafts. At least until the whole thing is done, I'm considering all of them works in progress (editing, more screenshots, and links to be added later). I think I'll be able to keep this pace up until court scenes, at which point I'll be learning all new things.


The reason I have setting a character before nt is…. Hmm. I had this idea that the visible character's mouth would move otherwise. But on testing, no such thing happens. Thanks for pointing that out. It's very helpful to have your input on how things should be working. (I swear I had a problem with Franziska's mouth moving on *whip* *whip* *whip* – who knows how I achieved that? Confused)

3:27 pm
February 28, 2010


saluk

Admin

posts 144

In certain versions there were bugs with nt/char, nt not actually clearing the nametag etc, I wasn't sure if they were gone or not. Sometimes these things get resurrected :)

If you have sections that you are unsure of or you want me to write I could do that. It's just the overal management of the docs and writing the basic stuff that it turns out I couldn't handle well. Once there is a good base, I look forward to making changes to the docs to coincide with new features, and actually knowing where to put stuff, so that it doesn't turn into such a huge thing. We are at the point where, pywright has gotten quite large and relatively complex – the simple stuff is still pretty simple, but explaining the entire thing in a cohesive way is not an easy thing to do.

It's just something to keep chipping away at. You might run into things with court that need more clarification, especially since you are learning as you go. But that also puts you in the best place to write the docs I think, because you have the right perspective!

2:43 pm
March 1, 2010


Dougidog

Member

posts 14

I have started wrighting a Courtroom tutorial.

I hope it'll turn out well.

It will walkthrough how to build the classic first case of Phoenix Wright games, the all-courtroom case.

12:00 am
March 2, 2010


StBacchus

Madison, WI

Member

posts 39

Oh good, then I can use it! Laugh What happened with the wiki idea?

1:36 am
March 2, 2010


saluk

Admin

posts 144

The more people to help on this the better!

I couldn't find a good wiki plugin for wordpress, so we should have it separate. I can host it (would be pywright.dawnsoft.org/wiki) but I'm not sure what a good wiki software is. The best would be if I can make it use the same user accounts from wordpress, so people don't have to sign up twice :)

9:53 pm
March 2, 2010


StBacchus

Madison, WI

Member

posts 39

MediaWiki would be the obvious choice, but DokuWiki is worth a look too. (comparison) They're very similar, but Doku's made especially for documentation and doesn't require SQL. Another possibility would be piggybacking onto GyakutenWiki. It might actually be helpful to everyone's projects to make GW one-stop shopping for all things casemaker.

It would definitely be cool to use just one login. Both DokuWiki and MediaWiki have OpenID plugins, which may be the best option. Or at least the easiest. Smile

11:44 pm
March 2, 2010


saluk

Admin

posts 144

Reusing http://www.gyakutenwiki.net/ sounds perfect. No extra maintenence needed by us, and most of us will have accounts already. I made a stub at http://www.gyakutenwiki.net/in…..ialProject

2:34 pm
March 8, 2010


Dougidog

Member

posts 14

 StBacchus said:

Oh good, then I can use it! Laugh What happened with the wiki idea?


Working on it, but it's taking a while :(


2:26 am
March 9, 2010


StBacchus

Madison, WI

Member

posts 39

Dougidog said:

Working on it, but it's taking a while :(


What do you think about using GyakutenWiki instead? I didn't ask, but I think it should be OK with them.

2:19 pm
March 9, 2010


Dougidog

Member

posts 14

StBacchus said:

Dougidog said:

Working on it, but it's taking a while :(


What do you think about using GyakutenWiki instead? I didn't ask, but I think it should be OK with them.


Would it be tricky? Not quite sure about how I'd go using someone else's site.

Also, I am very happy to help with this site if it would be more useful.

3:12 pm
March 9, 2010


saluk

Admin

posts 144

Like I said, I linked to a spot on GyakutenWiki where you can start putting it, if you would like to use it. It's just a stub right now (nothing really posted) but there is nothing stopping us from fleshing it out. It is linked to the PyWright page, which I think is a good start for it. It might be easier to use that then another site, because at least most of us already have accounts there.

8:25 pm
March 9, 2010


StBacchus

Madison, WI

Member

posts 39

Dougidog said:


Would it be tricky? Not quite sure about how I'd go using someone else's site.

Also, I am very happy to help with this site if it would be more useful.


I made a table of contents (not set in stone, just a guideline) over at GyakutenWiki. I think it will be fine, since GW is all about casemakers and fan games. If there is an issue, it shouldn't be too hard to move things to a new site. Please do help, that would be great!

No Tags