#openttdcoop wiki - User contributions [en]

GRFPack Dev Guide

2008-12-29T11:44:47Z

Kommer: /* Release */

__NOTOC__
{{GrfMenu}}

== How-to ==
# Checkout or Update trunk: '''svn co https://svn.openttdcoop.org/grfpack/trunk ottdc_grfpack_trunk''' or '''cd ottdc_grfpack_trunk && svn up'''
# Download the GRF to the right place
# Open the GRF in OpenTTD
# Commit the GRF to REPO: '''svn ci -m "New/Update: ...."'''
# Edit the [[GRF_Table_(Trunk)]]
# Done

== Updating an existing GRF file==
This is a guide to update our #openttdcoop NewGrf Package with [http://subversion.tigris.org/Subversion Subversion] and documenting the changes at [[GRF Table (Trunk)]].

=== General Aspects ===
* GRFs in alpha/beta state change many times and should be checked before releasing a new pack.
* The data from a GRF could differ from the data from the webpage or forum or any other resource. We would suggest to use the data from the GRF.
* Remember that [http://grfcrawler.tt-forums.net/ GRFCrawler] isn't always up-to-date. TT-Forums should work if no official website exists, because the GRFs are mostly update at this place.
* Loading the GRF in OpenTTD might be a good idea for checking title, credits etc. (Title in GRF Table should be the same...).
* If there is a ReadMe available a link in the column 'Details' would be nice (link to www.openttdcoop.org/newgrfs/...).

=== Updating Procedure ===
# '''Double check''' if it really is an update (md5sum).
# Commit to SVN with a proper message (svn commit).
# Update [[GRF Table (Trunk)]].
## Edit title and version number.
## Check the link to the GRF authors page (whether its outdated or not - avoid [[wikipedia:HTTP_404|404]])
## After an update the credits might change too.
## Write the '''svn revision''' (of our grfpack) into the status column.

== Adding a new GRF file ==
# Create a directory in the category, the NewGrf belongs to. Possibly the NewGrf needs another location because of a special dependency. Then you create a folder with a prefix (e.g. "a_") or you move it to the top directory (1_others) or to bottom (9_last). '''Every''' GRF has its own directory. (svn add <grffolder>).
# Update [[GRF Table (Trunk)]].
## Add the title with version number.
## Add a link to the original resource of the GRF file.
## Do '''not''' forget the credits (you can check them in the GRF file itself).
## Write the '''svn revision''' (of our grfpack) into the status column.

== Deleting an old GRF file ==
# Move it to [[GRF Table Removed]] and document the reason(s).
# The GRF itself needs to be moved to z_obsolete for compatibility with older saves.

== Revert a commit ==
Change to the directory where the GRF is, then

'''svn export -r <revision to revert -1> ./ ./ --force'''

Commit the change.

== Preambles for SVN commits ==
*'''Update''': Updating an existing NewGrf
*'''New''': Adding a new NewGrf
*'''Orders''': Moving an existing NewGrf to another location to fix order dependencies
*'''Fix''': Fixing some other bugs ;-)
*'''Remove''': Deleting an existing NewGRF (with reason)
*'''Release''': Creating a new tag in /grfpack/tags

==Release==
# Create a ''wiki tag'' of [[GRF Table (Trunk)]]. (copy [[GRF Table (Trunk)]] to [[GRF Table $VERSION]])
# Download the GRF Table to trunk. You can use firefox for this job. Go to the wiki page of the grf table, press ctrl-s and save the html files and the images. To conform to the current svn grftable structure, rename the images folder to 'images'. Rename the html file to 'GRFLIST.htm'. Open us the html file and replace the GRF_TABLE_*.*_files (the old images dir name) with 'images'. Open up the htm file to verify that everything works. Copy the html file and the images files to the svn repository and add any new images and commit everything.
# Update the ReadMe file and VERSION file
# Update the 0_info.grf (Script makeinfogrf <version>)
# Update ottdc_grfpack.cfg (Script makenewgrfcfg)
# Tag the Release. (link the tag to latest)
# Generate the release packages. (Script eportpacks (edit the config first ;-) )
# Generating md5sum list @ [http://www.openttdcoop.org/newgrfs/ottdc_grfpack.md5sum http://www.openttdcoop.org/newgrfs/ottdc_grfpack.md5sum]
# http://www.openttdcoop.org/newgrfs/ottdc_grfpack/VERSION should show current available version

[[Category:GRF]]

Main Page/editcopy

2008-11-11T15:07:55Z

Kommer:

__NOTOC__
{| style="width: 100%;" cellspacing="5" cellpadding="0"
| colspan="3" | <div style="width: 75%; margin: auto; background:#f5faff; border: 1px solid #AAA;"><div style="background:#f5faff; border: 1px solid #7BC; padding: 5px; margin: 3px; font-weight: bold; text-align: center;">
Welcome to the #openttdcoop wiki,<br>the definitive source for cooperative building and design of transportation networks.</div></div>



|-
| class="frontpage_box" |
<div class="frontpage_bar"><div style="float: right;">[[Image|*]]</div>Getting Started</div>
<div style="padding-left: 1em;">
; [[Obtaining OpenTTD]]
: [http://nightly.openttd.org Nightly Builds]
: [[GRF|#openttdcoop GRF Pack]]
; [[Tutorial Savegame|#openttdcoop Tutorial]]
: [http://www.openttdcoop.org/wiki/images/6/6a/Tutorial.sav Download]
: [[Tutorial Savegame Mainline|Mainline]] • [[Tutorial Savegame Sideline|Sideline]]
: [[Tutorial Savegame Stations|Stations]] • [[Tutorial Savegame Feeder|Feeder]] • [[Tutorial Savegame Towns|Towns]]
; [[Cooperation]]
; [[Ruleset|Building Guidelines]]
; [[Naming conventions|Naming Conventions]]
; [[Glossary]]
</div>
| class="frontpage_box" |
<div class="frontpage_bar"><div style="float: right;">[[Image|*]]</div>Basic Building Concepts</div>
<div style="padding-left: 1em;">
; [[Game Start]]
: [[Planning]] • [[Moneymaker]]
; [[Line hierarchy|Basic Networking]]
: [[Mainline]] • [[Signalling]] • [[Service depot]]
: [[Basic Junctions]] • [[Mainline Junctions]]
; [[Basic Stations]] • [[Terminus Station]]
: [[Road stations]]
; [[Terraforming]]
; [[Orders]]
: [[Copy orders|Copying Orders]] • [[Shared Orders]]

</div>
| class="frontpage_box" |
<div class="frontpage_bar"><div style="float: right;">[[Image|*]]</div>Advanced Building Concepts</div>
<div style="padding-left: 1em;">
; [[Junctionary]]
: [[Junctionary - 3-Way BBH|BBH:3-way]] • [[Junctionary - 4-Way BBH|BBH:4-way]] • [[Junctionary - SLH|SLH]]
: [[Junctionary - Station Entries RoRo|RoRo Entries]] • [[Junctionary - Station Exits RoRo|RoRo Exits]] • [[Junctionary - All|more...]]
; [[Load Balancers]]
: [[Unbalancers]] • [[Implicit Load Balancing]]
; [[Priorities]]
; [[Presignal Bypass Station]]
; [[Enhanced SBahn]]
</div>
|-
| class="frontpage_box" |
<div class="frontpage_bar"><div style="float: right;">[[Image|*]]</div>Technical Info</div>
<div style="padding-left: 1em;">
; [[Servers|#openttdcoop Servers]]
: [[Public Server | (PS) Public Server]] ([[PublicServerSettings|Configuration]] • [[PublicServer:Archive|Archive]])
: [[Pro Zone | (PZ) ProZone Server]] ([[ProZoneSettings|Configuration]] • [[ProZone:Archive|Archive]])
: [[Member Zone| (MZ) Member Server]] ([[MemberZoneSettings|Configuration]] • [[MemberZone:Archive|Archive]])
: [[Coopetition|Coopetition Server]] • [[Dev Server|Patched Server]]
; [[IRC]]
: [[IRC Commands]] • [[IRC Highlighting]]
; [[Teamspeak]]
; [[GRF|#openttdcoop GRF Pack]]
: [[GRF Table 7.2|Current GRF Table]] • [[GRF History|Version History]]
: [[GRF Dev Guide|Development Guide]] • [[GRF Table (Trunk)|Development Table]]
: [[GRF Table Obsolete|Obsolete GRFs]] • [[Server Administration]]
: [[Autopilot]] • [[Autostart]]
</div>
| class="frontpage_box" |
<div class="frontpage_bar"><div style="float: right;">[[Image|*]]</div>Development</div>
<div style="padding-left: 1em;">
; [[Gametypes]]
: [[Gametype:ICE SBahn|ICE/SBahn]] • [[Gametype:Chaos Theory|Chaos]] • [[Gametypes|more...]]
: [[Game Proposals|Proposals for Future Gametypes]]
; [[:Category:Coopetition|Coopetition]]
; [[OSQC|Scenario Quest/Competition (OSQC)]]
; [[WWOTTDGD|WorldWide OpenTTD Game Day (WWOTTDGD)]]
; [[Webbased configurator | Web-based Configurator]]
; [[:Category:Research|Current Research Projects]]
; [[ToDo|ToDo List]]
</div>
| class="frontpage_box" |
<div class="frontpage_bar"><div style="float: right;">[[Image|*]]</div>Community Info</div>
<div style="padding-left: 1em;">
We are maintaining [[Special:Statistics|{{NUMBEROFARTICLES}}]] [[Special:Allpages|articles]]!<br />
<span style="margin-left: 2em;"><small>See...[[Special:Recentchanges|Recent changes]] | [[Special:Newpages|New pages]] | [[Special:Wantedpages|Missing pages]]</small></span>
; [http://www.openttdcoop.org/blog #openttdcoop Blog]
; [[Membership|Becoming an #openttdcoop Member]]
: Join the cooperative building community!
; [[Users|User List]]
: See the list of current members and active players
; [[History|History of #openttdcoop]]
; [[Contact|Contact Info]]
; [[Sandbox]]
</div>
|}

<div style="margin-right: 10px; text-align: right; font-style: italic; font-size: 85%;">Changes for the main page can be proposed [[Main Page/editcopy|here]].</div>

2008-10-10T11:32:39Z

Kommer: /* Implementation design */

This wiki page shows the requirements, design, implementation and progress of the development of a web-based configurator for openttd.cfg. Before any design will be made, functional requirements of the system should be clear. For questions or remarks, please use the discussion page or contact Kommer on #openttdcoop

=== Project goal and scope ===
The goal of this project is to design a webbased configurator for the openttf.cfg configuration file. The initial scope is to only generate a openttd.cfg configuration file. Other possibilities, like restarting a server, will be out of scope for the first version of this configurator.

=== Functional Requirements ===
==== Mandatory ====
*the web-based tool should be able to manage the configuration of the openttd.cfg configuration file.
*it should generate server specific openttd.cfg files for all #openttdcoop servers;
*the web-based tool should have a read only and read-write option to make it possible for users to see our config;
*all options and new grf settings of the openttd.cfg should be changeable;
*options need to be mandatory or non-mandatory;
*newgrfs and their options must be selectable;
*each option should have a description of the possible values and their meaning;
*values of options should be open, an enumeration or multiple values (NewGRF Parameters)
*some options should be specific for a configuration and some options should be specific for a server
*each server should be able to have multiple configurations in the tool
==== Optional ====
*it should be possible to load a openttd.cfg into the webtool.
*support for presets/templates
*it should be possible to upload the config file to a server using (S)ftp;

=== Database design ===
The database design is made in Mysql workbench, which can generate all SQL scripts easily.

[[Media:webtool_configurator_database_design_v0.03.pdf|Database design v0.03]]

=== Gui design ===
A pre of the system is to use some kind of template tool or use plain xhtml with a good css file.

If you have suggestions, please add them here!

==== Requirements on the implementation ====
*the tool should use PHP as the programming language
''Rationale'': PHP is used in a lot of webbased tools. If we choose something like java (with google's webtoolkit?), it would be harder to install and maintain the tool.
*as database a open source *SQL version should be used. (For now, we will use MySQL)

=== Implementation design ===
A design of the implementation will be posted here when the global requirements are final and the database design will be finished.

Possibly a [http://en.wikipedia.org/wiki/Model-view-controller|MVC approach] will be used. The mysql workbench file can be used to generate all model files, which saves a LOT of development time.

Also looking into the <http://framework.zend.com/|Zend Framework] which will also make coding a lot easier and Object Oriented. Also [http://www.eclipse.org/pdt/|Eclipse] can be used to develop php code with the zend framework.

2008-10-08T18:22:26Z

Kommer: /* Implementation design */

This wiki page shows the requirements, design, implementation and progress of the development of a web-based configurator for openttd.cfg. Before any design will be made, functional requirements of the system should be clear. For questions or remarks, please use the discussion page or contact Kommer on #openttdcoop

=== Functional Requirements ===
==== Mandatory ====
*the web-based tool should be able to manage the configuration of the openttd.cfg configuration file.
*it should generate server specific openttd.cfg files for all #openttdcoop servers;
*the web-based tool should have a read only and read-write option to make it possible for users to see our config;
*all options and new grf settings of the openttd.cfg should be changeable;
*options need to be mandatory or non-mandatory;
*newgrfs and their options must be selectable;
*each option should have a description of the possible values and their meaning;
*values of options should be open, an enumeration or multiple values (NewGRF Parameters)
*some options should be specific for a configuration and some options should be specific for a server
*each server should be able to have multiple configurations in the tool
==== Optional ====
*it should be possible to load a openttd.cfg into the webtool.
*support for presets/templates
*it should be possible to upload the config file to a server using (S)ftp;

=== Database design ===
[[Media:webtool_configurator_database_design_v0.02.pdf]]

=== Gui design ===
A pre of the system is to use some kind of template tool or use plain xhtml with a good css file.

If you have suggestions, please add them here!

=== Implementation design ===
A design of the implementation will be posted here when the global requirements are final and the database design will be finished.

==== Requirements on the implementation ====
*the tool should use PHP as the programming language
''Rationale'': PHP is used in a lot of webbased tools. If we choose something like java (with google's webtoolkit?), it would be harder to install and maintain the tool.
*as database a open source *SQL version should be used. (For now, we will use MySQL)

Webbased configurator

2008-10-08T18:20:00Z

Kommer: /* Gui design */

File:Webtool configurator database design v0.02.pdf

2008-10-08T18:15:26Z

Kommer:

Webbased configurator

2008-10-08T18:15:10Z

Kommer: /* Database design */

Talk:Webbased configurator

2008-10-08T18:14:55Z

2007-10-06T13:27:08Z

Kommer:

__NOTOC__
==Active Members of #openttdcoop==
*{{User|Adm.Spock|nl}}
*{{User|Ammler|ch}} '''(Admin)'''
*{{User|Hylje|fi}}
*{{User|Kommer|nl}}
*{{User|Mucht|at}} '''(Admin)'''
*{{User|Osai|de}} '''(Admin)'''
*{{User|Phazorx|iru}}
*{{User|Progman|de}}
*{{User|thgergo|hu}}
*{{User|valhallasw|nl}}, BOFH, Wiki-god and mainly werkloos '''(Admin)'''
*{{User|XeryusTC|nl}}, Chairman of the #openttdcoop stupidness committee '''(Admin)'''
''Note: Admins have shell access to our servers''

==Currently Inactive Members of #openttdcoop==
*{{User|dp|de}}
*{{User|e1ko|cz}}
*{{User|Guru3|se}}
*{{User|ottd-king|uk}}
*{{User|Piratejerk|ca}}
*{{User|StarLite|nl}}
*{{User|xahodo|nl}}

==Honorary Members of #openttdcoop==
*{{User|Brianetta|uk}} (our amiable host who is responsible for making #openttdcoop to such a vital community it is today) '''(Admin)'''
*{{User|TrueLight|nl}} (for being a bugfixer over ... a long time ;-) )

==The usual suspects around the Public Server==
*{{User|Addi|ch}}
*{{User|Alendo|no}}
*{{User|AntB|uk}}
*{{User|Bob27|us}}
*{{User|Cipri|nl}}
*{{User|Dark_Link|se}}
*{{User|Doke|de}}
*{{User|Dopefish|de}}
*{{User|EmiT|cz}}
*{{User|Farden|fr}}
*{{User|Gamer|nl}}
*{{User|Godde|no}}
*{{User|itsnotvalid|hk}}
*{{User|Jinx|be}}
*{{User|Juustro|fi}}
*{{User|Kejhic|cz}}
*{{User|Kolo|pl}}
*{{User|LittleMikey|au}}
*{{User|Mark|nl}}
*{{User|MooUK|uk}}
*{{User|N101|au}}
*{{User|Nitehawk|us}}
*{{User|OwenS|uk}}
*{{User|Phil|uk}}
*{{User|RaWt|no}}
*{{User|Red|us}}
*{{User|Sedontane|uk}}
*{{User|Shader|pl}}
*{{User|Sian|dk}}
*{{User|S m w|de}}
*{{User|Stoffe|se}}
*{{User|Spectre100|us}}
*{{User|strstrep|us}}
*{{User|Thraxian|us}}
*{{User|Walle|be}}
*{{User|welterde|de}}
''And of course all the others above!''

===== Exsuspects =====
*{{User|Alanin|de}}
*{{User|ChrisM|de}}
*{{User|csuke|uk}}
*{{User|eJoJ|no}}
*{{User|Green-devil|dk}}
*{{User|Hans|nl}}
*{{User|hdp|us}}
*{{User|Ichi|nl}}
*{{User|Ihmemies|fi}}
*{{User|John|sk}}
*{{User|Nazirro|pl}}
*{{User|RichK|uk}}
*{{User|SerriaRomeo|us}}
*{{User|Skasi|at}}
*{{User|Skidd13|de}}
*{{User|Teddy|no}}
*{{User|uLiKo}}
*{{User|UnderBuilder|ar}}
*{{User|Zavior|fi}}

PublicServer:Archive - Games 61 - 70

2007-09-20T15:50:26Z

Kommer:

<noinclude>{{PublicServerArchiveMenu}}</noinclude>

{{Archive_PublicServer|Public Server Game 63|16.09.07 - 20.09.07|{{User|Mark}}, {{User|Little Mikey}}, {{User|Progman}},{{User| Kommer}}, {{User|Phazorx}},{{User| Shader}}, (add yourself)|[[Gametype:Cargo_Concept|Cargo]] |5 tiles|512x512|rr11118 + [[Guides:Glossary:GRF|#openttdcoop-GRF-Set 6 beta]]| One big main loop that serviced a factory, sawmill and oil refinery. Three separate main lines that service 1/3rd of the map and are connected to the main loop|63|Image:blabla.png|}}

{{Archive_PublicServer|Public Server Game 62|09.09.07 - 16.09.07|{{User|Mark}}, {{User|Little Mikey}}, {{User|Sian}},{{User| Kommer}}, {{User|thgergo}},{{User| Shader}}, {{User|N101}},(add yourself)|[[Gametype:|??]] / [[Gametype:|??]]|7 tiles|512x512|rr11086 + [[Guides:Glossary:GRF|#openttdcoop-GRF-Set]]| 3 islands. Neatly joined up, having many bridges did cause some congestion and queue's which slowed trains to a halt. |62|Image:Islanders_Ltd.%2C_17th_Oct_2220.png|}}

{{Archive_PublicServer|Public Server Game 61|03.09.07 - 09.09.07|(add yourself)|[[Gametype:TGV_Concept|TGV]] / [[Gametype:Chaos_Theory|Chaos]]|8 tiles|???x???|r11047 + [[Guides:Glossary:GRF|#openttdcoop-GRF-Set]]| Breakdowns were enabled. Early on, the ML became a parking lot for broken down trains. Later, redundant lines were added to compensate. Players were harder to find, as this nightly build generated desync errors early and often. |61|Image:Desync_Transport%2C_9th_May_2099.png|}}