Wiki and documentation

[Bertram]

Hi all,

You might have read that Roots will be in need of help to update his wiki and overall document the engine features.
http://www.allacrost.org/node/93

As for me, updating doc for Allacrost as for the engine feature is doing it for Valyria Tear as well, so let's open a topic here so that Roots can tell what common documentation we could help to update.

Your turn to speak Roots.

[Roots]

Our old wiki is here:
http://allacrost.sourceforge.net/wiki/i ... /Main_Page

The new wiki I still have not installed, but it will be located here when it's ready:
http://www.allacrost.org/wiki

The first step will be to copy all of the pages found in there to the new wiki. Unfortunately I'm pretty sure that this has to be done manually, and the images used in the old wiki will have to be re-added and re-linked appropriately. It will be tedious, but I don't think it will take too long to copy everything over.

After the copying is complete, then it's time to update the material. Updating the code documentation is the primary focus here. Especially for map mode and battle mode, I want the documentation to explain the major architecture in these sets of code and to answer some fundamental questions for map/battle designers, such as "How do I add a dialogue?". As I've been re-familiarizing myself with the code, I've had to figure out these answers myself and learn how everything works all over again.

I'll update the topic when the wiki is installed and ready for editing. I might need to place some strict restrictions on account creation, as our site is having a lot of problems with spam bots lately.

[Bertram]

I guess I'll mainly help on the map event/scripting part since I think quite everything there received at least a little touch from me.

[Roots]

That would be excellent. A good guide on how to write scripts to do things to make maps and battles come alive would be really helpful in enabling other people to come along and help in that area (which is where more and more development effort is going to switch to as time goes on).

I have not yet setup the wiki as I'm in Cozumel Mexico at the moment and I have an Ironman race tomorrow, so I'm trying to just relax before my race. I'll get around to it maybe early next week, but I'll still be on vacation so I can't guarantee that. Should definitely have it up sometime next weekend if not sooner.

[Bertram]

That would be excellent. A good guide on how to write scripts to do things to make maps and battles come alive would be really helpful in enabling other people to come along and help in that area (which is where more and more development effort is going to switch to as time goes on).

Ok, once the wiki is up, we'll be able to talk about the kind of example you want to see.

I have not yet setup the wiki as I'm in Cozumel Mexico at the moment and I have an Ironman race tomorrow, so I'm trying to just relax before my race. I'll get around to it maybe early next week, but I'll still be on vacation so I can't guarantee that. Should definitely have it up sometime next weekend if not sooner.

Iron Man race, wow, that's being on vacation Have fun!
I'm struggling with the last pieces of the dungeon, so you still have time with all that.

[Roots]

Wiki is now up and running:

http://www.allacrost.org/wiki

I'm going to begin copying over pages from the old wiki tonight. It would be helpful if someone can do the following to help me make sure that the wiki is working properly:

1) Create an account on the wiki
2) Make a small edit to an existing page (just write 'blah blah' or something)
3) Save your edit, and make sure it appears properly.
4) Edit the page again, remove what you added, and then save it and make sure it is now gone.

Let me know if that works or not. If there's any problem, I'll work on finding the problem.


Also note that only registered users can edit the wiki. Spam is too much of a problem on the site right now and I'm afraid of making the wiki editable by anyone. Apparenly spammers got a hold of the last wiki I made and uploaded over 1GB of content to the database there. Blegh.

[Bertram]

Hi,

I've tested, you can see the history here:
http://www.allacrost.org/wiki/index.php ... on=history

Everything went fine.

[Roots]

Great, thanks. Currently having a hell of a fun time with the wiki as about 100+ spammers have already found there way on to it. I swear to god it pisses me off so much. I have spent so much time and effort fighting spam over the years and every minute I spend doing that is less time I spend making games.

[Roots]

I defeated the spammers. Wiki is fully operational now and I've been migrating more and more content over from the old wiki. I'm also playing around with a new organization of our wiki content (as you can see on the main page http://www.allacrost.org/wiki/). I've added links to empty pages to serve as place holders to pages that cover some of the things we discussed, like how to write maps and script battles. I'm still copying, cleaning, and organizing things right now. By next week I think the wiki will be in a good state to begin some serious documentation efforts, which will help both VT and Allacrost.

[Roots]

Migration of content from the old wiki is complete. This week i'm going to be spending a lot of time useful for artists and map designers, as Allacrost requires more effort on those fronts than any other. I doubt that I'm going to get around to updating any code documentation, unfortunately. I spent the majority of my day writing this page:

http://www.allacrost.org/wiki/index.php ... Categories

Should be useful for both of our projects to help guide the artists.