Steam Weasel Design Document

<body bgcolor="#FFFFFF"> <h1 align="center">Steam Weasel Design Document</h1> <p align="right"><i>Revised Sunday, 2001-07-01 (Bob Savage)</i></p> <hr> <p> </p> <h1 align="center"><font face="Arial, Helvetica, sans-serif">Usage notes</font></h1> <hr> <h3><font face="Arial, Helvetica, sans-serif">Executables</font></h3> <p> <i><b>// SWServer</b></i></p> <p> SWServer -- persistance: </p> <blockquote> <p> SWServer writes SWServerModel to file<br> SWServer reads SWServerModel from file</p> </blockquote> <p> SWServer -- I/O:</p> <blockquote> <p> SWServer reads SWCommand from file<br> SWServer writes SWReport to file</p> </blockquote> <p></p> <p><b><i> // SWClient</i></b></p> <p> SWClient is the app that the player uses to explore the game world (as accessible to him through "reports"), and to create "orders that are issued to her troops.</p> <p></p> <p>The SWClient is very 'thin' in capability. Most functionality is aquired by ".helper" bundles.</p> <p></p> <p> SWServer -- persistance:</p> <blockquote> <p> The SWClient actually does not have any persistance features. All persistance is handled by the server. Changes to a report has absolutely no impact on the game.</p> </blockquote> <p></p> <p> SWClient -- I/O:</p> <blockquote> <p> SWClient reads SWReport from file<br> SWClient writes SWCommand to file</p> </blockquote> <h4></h4> <hr> <h3><font face="Arial, Helvetica, sans-serif">Top level Models</font></h3> <p></p> <p><b><i> // SWServerModel</i></b></p> <p> SWServerModel provides a means of saving and loading the entire game, not just a single player's turn. It is for the use of the SWServer.</p> <p></p> <p> SWServerModel must have:</p> <ul> <li> an array of SWPlayers</li> <li>current turn indicator</li> <li>time limit for turns -- ideally adjustable by players</li> <li>time last turn was played</li> <li>SWBoard -- which will contain units and hexes</li> </ul> <p></p> <p><b><i> // SWClientModel</i></b></p> <p> Owned by SWClient -- seperates GUI code from the Model</p> <p></p> <p> SWServerModel must have:</p> <ul> <li> an array of open reports (selected by the user)</li> <li>one active report (can by nil if no reports are loaded)</li> </ul> <hr> <h3></h3> <h3><font face="Arial, Helvetica, sans-serif">Lower level Models</font></h3> <p></p> <p><b><i> // SWHex</i></b></p> <p> SWHex must have:</p> <ul> <li> height</li> <li> location<br> </li> <li>terrain<br> </li> <li>contents (any units in it)</li> </ul> <p><i> <b>// SWUnit</b></i></p> <p> SWUnit must have:</p> <ul> <li> a unique ID -- this is to distinguish on unit from all other units it does not need to be shown to the player, but it will be used in report and command files</li> <li> command queue (*not* same as SWCommand)<br> </li> <li>component technologies:<br> this must include at the very least a "chassis" technology.</li> </ul> <p></p> <p><i> <b>// SWPlayer</b></i></p> <p> SWPlayer must have:</p> <ul> <li> email address</li> <li> list of all owned units</li> <li> social choices (e.g. research goals)</li> <li> list of resources (and quantities)</li> <li> list of known hexes</li> <li> diplomat object (like a mailbox for incoming diplomacy offers)</li> </ul> <hr> <h3></h3> <h3><font face="Arial, Helvetica, sans-serif">File handling Objects</font></h3> <p></p> <p><i> <b>// Reports</b></i></p> <p> A report includes all the information a player is allowed to know in clear text. It is an XML formatted file. A DTD will be made available when it is finalized.</p> <p>Reports include an expiration date determined by the Server after which a command file based on this report will not be accepted -- a new command file will need to be generated, based on a current report. The purpose of the "freshness date" is, amongst other things, to prevent a player from sending commands to her troops without basing them on her units' current location/health/etc.</p> <p></p> <p> SWReport is an object that is initialized from a ".swreport" XML file. SWReport parses the file and returns useful game components upon demand.</p> <p></p> <p><i> <b>// Commands</b></i></p> <p> Commands are created by the player through the SWClient. They are formatted into an XML file and sent to the server where they are issued to the units and executed.</p> <hr> <h3></h3> <h3></h3> <h3><font face="Arial, Helvetica, sans-serif">Etc.</font></h3> <p></p> <p><b><i> // ".helper" bundles</i></b></p> <p> .helper bundles are loaded by the SWClient to give the player</p> <p> Some Helpers might write SWReport to file (e.g. send edited maps to other players)</p> <p></p> <p><b><i> // ".content" bundle</i></b></p> <p> A .content bundle has:</p> <ul> <li> unique name - e.g. "BuckRodgers"</li> <li> version string - e.g. "version 1.2"</li> <li> additional bundle dependencies<br> this is to allow "cascading" bundles -- the idea is to allow for one bundle that has certain features and allow ".content" bundle developers to build off of that (so there is only one "Forest" terrain, but a second bundle could require the bundle which includes "Forest" and add resources that could be harvested from a Forested hex.</li> <li> list of terrains</li> <li> list of technologies</li> <li> list of resources</li> <li> list of research areas</li> </ul> <p> </p> <p><b><i> // Terrain</i></b></p> <p> A terrain is a property that a hex can have. A hex can only have one terrain at a time. It is possible that a player could aquire technology which enables them to convert a hex from one terrain to another.</p> <p></p> <p> Terrains have:</p> <ul> <li> names (internationalized strings)</li> <li> This is used for display to the player</li> <li> unique ID -- if we have multiple names for something we need an unambiguos way of referring to an item in a bundle -- this could be something like "BuckRodgers-MudPits" the idea is to make sure there isn't a name clash if another bundle creates a similarly named Terrain, and allow for internationalized name strings</li> <li> terrain textures (image file)</li> <li> (default color for use when image file can't be shown?)</li> </ul> <p></p> <p><b><i> // Technology</i></b></p> <p> A technology is an object that can be used to equip an SWUnit. There are 4 basic categories of technology:</p> <ol> <li> Chassis -- only one per unit.<br> Chassis would determine mobility and the ability to "carry" other technologies (meaning a person on foot can only carry so much stuff, if he was driving a truck he could mount a big weapon on the back and lead plate it -- which might make it as slow as a person walking, but that is the choice a player would have to make). Examples would be:<br> - Immobile -- used for buildings<br> - Horse<br> - Bicycle<br> - Giant Eagle<br> - Etc.</li> <li> Weapon -- 0 or more per unit.<br> Weapon could be an optional technology so that some units would have no offensive capacity (and use that carrying capacity for something else (extra armor, or some special technology (something to increase vision?). A player might even choose to forgo the weapon for no other reason than to make the unit cheaper and faster.</li> <li> Armor -- 0 or more per unit.<br> Another optional technology, although this would place the unit at risk of being captured.</li> <li> Special -- 0 or more per unit.<br> This should be a very popular category :) It would include Espianage equipment, or "Sheilds" (see discussion on list), etc. etc. etc. Note that heroes can be implemented using "Special" technologies. Just make sure that the technology creation conditions (see below) will permit only one instance of the hero to exist per game.<br> Example: a bundle named "BuckRodgers.content" is loaded; it contains a technology called "Jet Pack" in English. A player in the game, who had the requisite knowledge (research) and resources (it is also possible for the technology to require that it be created *in* a particular terrain, or by a unit equipped with a particular technology), can create a new unit with the "Jet Pack" chassis.</li> </ol> <p> Technologies have:</p> <ul> <li> names (internationalized strings)</li> <li> unique ID -- as per Terrain above)</li> <li> tech image file</li> <li> possibly a model and texure -- details to follow</li> <li> category (chassis, weapon, armor, or special).</li> <li> "weight" -- or mass<br> only for technologies of categories weapon, armor, and special. This is a number used to determine if the chassis can support it and what effect it might have on speed</li> </ul> <p> Chassis technologies would have additional things:</p> <ul> <li> max weight</li> <li> max speed</li> <li> perhaps this is the 3D model used to represent a unit in an OpenGL view?</li> <li> creation conditions<br> what conditions must be met in the hex that the "manufacturing" of the technology is taking place? Is there a Shaman present? Are we in a swamp? Does the player have "Woodcraft"? etc. etc. etc. This will be a bit of code, not simply a line in a plist file.</li> </ul> <p></p> <p><b><i> // Resource</i></b></p> <p> A resource is kind of an abstract thing that an SWPlayer object can have. It is not represented by a unit on the board. ".content" bundles are free to create their own resources, as well as the rules for their extraction, which typically requires some combination of terrain and technology (which implies some kind of research).</p> <p></p> <p>Resources are consumable, meaning they can go down as well as up.</p> <p> examples:</p> <ul> <li> a player might use up all their "Wood" resource building a raft.</li> <li> workers might consume a "Food" resource. If the owning SWPlayer does not have enough "Food" to feed a worker it will die.</li> </ul> <p></p> <p>Resources can be traded using diplomacy.</p> <p></p> <p> Technologies have:</p> <ul> <li> names (internationalized strings)</li> <li> unique ID -- as per Terrain above</li> <li> resource image file</li> <li> creation conditions -- as per Technology above</li> </ul> <p><i> <b>// Research</b></i></p> <p> This is the knowledge base an SWPlayer has, or the required knowledge an SWPlayer would need to have in order to produce/use some technology.</p> <p></p> <p>.content bundles define areas of research.</p> <p></p> <p>An area is researched by consuming resources. This might be "Research Points" or it might be something special defined by the bundle, such as "Mana", or some combination of resources ("Research Points" + "Electricity"). A bundle might also define prerequisites for starting research in an area, typically having acheived a minimum value in another area of study.</p> <p></p> <p>Each area of study has a rating from 0 to 100. After a certain level of researching in an area additional research may be possible, but would not enable additional technologies (only improve the technologies already enabled).</p> <h1> </h1> </body>