Re: [Rails-devel] Docs for new games?

[brett l. <wak...@gm...>]

As with most small projects, the documentation is minimal and usually
out of date. ;-)

You're on the right track, the XML tends to be the best documentation
of existing features.  In general, the options that exist, are the
ones used by the XML already.  Any new features that we may need, will
need to be created.

If the games don't add any new game mechanics, they should be easy
additions. 18Kaas was fairly simple to add, as I recall, exactly
because we had 1830 working and it's just uses the 1830 rules on a
different map. So, if you compare the 1830 and 18Kaas XML, you should
be able to get an idea of how to add in other 1830-style games.

The other place to that documents what's possible is the various
ConfigureFromXML() methods within the code. Those methods handle the
XML parsing, and more or less define the things we're expecting to
find in the XML.

If you're interested in adding real documentation, it's definitely
something we'd love to have.

---Brett.



On Wed, Jan 6, 2010 at 9:50 AM, Rick Westerman <wes...@pu...> wrote:
>  From the small bit I did searching the archives I suspect that the
> answer to this question is a resounding "NO" but ... are there any docs
> on how to create a new game and especially the options available to
> modify the game's parameters?
>
>    I can certainly go through the existing games' xml files and try to
> figure out what needs to be placed where, but it would be handy to know
> what some of the options mean without have to parse the code.  For
> example, in the 'CompanyManager.xml'  there are options such as
> 'PoolPaysOut' -- which is clear but makes me wonder what other options
> are possible; e.g., 'PoolRetains' or just perhaps not including the
> 'PoolPaysOut' line is sufficient?  And in the 'LayCost' option there is
> a method.  The particular file I am looking at has the method
> 'sequence'.  Are there others available?  And so on.
>
>    If there is no such document then I will try to make one up as I
> create a couple of games.  BTW:  At the moment I am working on 1800 and
> 1876 -- these are some very simple 1830-style games which should not
> (knock on wood!) give too many config problems.
>
> TIA.
>
> --
> Rick Westerman wes...@pu...
>
> ------------------------------------------------------------------------------
> This SF.Net email is sponsored by the Verizon Developer Community
> Take advantage of Verizon's best-in-class app development support
> A streamlined, 14 day to market process makes app distribution fast and easy
> Join now and get one step closer to millions of Verizon customers
> http://p.sf.net/sfu/verizon-dev2dev
> _______________________________________________
> Rails-devel mailing list
> Rai...@li...
> https://lists.sourceforge.net/lists/listinfo/rails-devel
>