ThreadBoard ArchivesSite FeaturesActiveworlds SupportHistoric Archives |
AW SDK Wiki (Sdk)
AW SDK Wiki // Sdkdm mercuryJun 4, 2006, 7:03am
I don't know if this has even been attempted or if there is even a real
audience for it(or if one exists at present). Since 4.1 isnt being very cooperative, I have decided to attempt to start an SDK wiki. I have offered the webspace hopefully it goes to good use. And maybe becomes a resource for many developers for AW. Because we certainly know that the current sdk documentation is lacking at best. I think the last documentation update for it was for like build 37 or 38? I am basically asking for help in creating this, not only because it's no small task, but because we as programmers need good resources and documentation to do our job effectively. If you don't have the right tools, the job is more difficult than it needs to be. It's like trying to scrub the kitchen floor clean with a tooth brush, it would take you all day with a tooth brush, but if you used a mop the job would take only minutes. It's why we typically use high level languages for large projects and tasks over assembly or even machine code. (Well not to start a language choice debate and such it is just an analogy). In any case there isnt much to see yet but check it out at http://awsdk.addrpg.org, hopefully some people will help get some more content up on it. DM byteJun 4, 2006, 3:25pm
You know, I actually thought about doing this. I think it's a good
idea, since the current SDK documentation is crap. :) Best thing is that code examples and links to all the different SDK wrappers can go up here, also. [View Quote] byteJun 4, 2006, 4:45pm
I took the liberty of creating lists of all the functions, attributes,
events, callbacks, and return codes with corresponding links to the non-existant pages about each one. I'll leave that up to other people to fill in, or do myself as I find time. There's still quite a few things missing like most of the new data structures, defines, and typedefs introduced in the 4.1 header. :) [View Quote] strike rapierJun 4, 2006, 4:52pm
Added a bit
-- - Mark Randall http://www.temporal-solutions.co.uk "We're Systems and Networks..." "It's our job to know..." [View Quote] byteJun 4, 2006, 5:12pm
Thanks, looking through your examples... they make great templates for
the rest of the Wiki. I may go through and add basic C examples for some of the events and functions, to demonstrate how to go about doing code examples. strike rapierJun 4, 2006, 6:58pm
Bare in mind I have *no* idea how to use wiki formatting
-- - Mark Randall http://www.temporal-solutions.co.uk "We're Systems and Networks..." "It's our job to know..." [View Quote] strike rapierJun 4, 2006, 8:16pm
Could someone fire up a template for each method that includes:
* Minimum SDK Build * Minimum World Server (Default ??) * Minimum Universe Server (Default 3.5) etc -- - Mark Randall http://www.temporal-solutions.co.uk "We're Systems and Networks..." "It's our job to know..." [View Quote] dm mercuryJun 4, 2006, 8:37pm
Wow I am glad some others share the same enthusiasm about this as I do. I
literally just created it at the time of the post (about 4am my time), and I was totally not expecting so much done already! I don't know much about wiki formatting myself either, but I have been reading up on the documentation for it to figure stuff out. Looks like in a week or two we will have some really nice documentation. Also like Strike Rapier was saying about the minimum build information stuff, I thought about adding that as well. We will just have to coordinate a bit so everything looks semi decent and organized. A lack of organization could be a bad thing since we want to be able to find things ourselves. I'm going to do a lot of entries later tonight when I have time, I am dead tired and must rest. I woke up at 9am this morning, and have been out running around and shopping all day long. DM P.S. If anyone knows stuff about wiki-ing and such and wants to help administrate the wiki let me know. Or if you need some kind of change done thats setting based or needs to be done in the php let me know and I will take care of it. YP mentioned something about the underscores to me, its at the top of the priority list atm. [View Quote] byteJun 4, 2006, 9:55pm
Yeah, I'm gonna be putting together function and event reference
templates based off of what you have now, I'll include information on the minimum requirements of each. :) [View Quote] byteJun 4, 2006, 9:56pm
Hi DM Mercury,
I was going to mention that for events I'd use the work strike did in terms of those entires, and as far as functions go, I'll try to get something together later tonight as an example of how the function pages might light. :) [View Quote] |