tea-tea-deluxe/README.txt

Tea Tea Deluxe
===================================
This NewGRF adds a tea based economy chain.

----------
0 Contents
----------

1   About
2   General information
    2.1  Requirements
    2.2  Installation
    2.3  Parameter settings
    2.4  Usage
3   Known issues
4   Background information
5   Frequently Asked Questions
6   Credits
7   Contact information
    7.1  Bug reports
    7.2  Other problems and general inquiries
8   License
9   Obtaining the source
    9.1 Building the NewGRF


-------
1 About
-------

Three things are added with this extension:
* Farms producing tea leaves
* Factories turning tea leaves into tea
* Teahouses consuming tea.

Tea Tea Deluxe
MD5Hash:  e886ef2432a0ae61b7ecd02b3362665b
Version:  1.0.0
GRF ID:   BW\01\01



---------------------
2 General information
---------------------

2.1 Requirements
----------------
- OpenTTD 12.2 (not tested with earlier versions)


2.2 Installation
----------------
OpenTTD:
  see http://wiki.openttd.org/NewGRF
  This NewGRF is available from the ingame Online Content


2.3 Parameter settings
----------------------
No user-set parameters are available in this NewGRF


2.4 Usage
---------
Install, activate, and start a new game. Enjoy!


--------------
3 Known issues
--------------

The appearance probabilities are tuned to the base industry set + this
NewGRF. Because probabilities are uniformly distributed based on a single
number they will be relatively lower the more other industries are added.
With lower relative probabilites I've noticed that tea tree farms often
are decommissioned more often than new ones are founded, leading to a
generally reducing trend over time. The risk of this can of course be
reduced by building stations with high ratings serving them!


------------------------
4 Background information
------------------------

Tea is important. Tea is life. Tea is civilisation. Tea is my heroin.

I must have tea. Tea. Tea!

The game is not allowed to be without tea. Not on my watch.



----------------------------
5 Frequently Asked Questions
----------------------------

Q: How much tea do you drink?
A: More than you.


---------
6 Credits
---------

All code and art in this NewGRF was made by Björn Wärmedal, aka
pickpacket/ew0k/tinyrabbit/a whole lot of other handles depending on
context.

It's written in the excellent NewGRF Meta Language, which requires Python
3.x. äa requirements.txt file for installation with pip is included.


---------------------
7 Contact information
---------------------

7.1 Bug reports
---------------
Please report any bugs you find to bjorn.warmedal@gmail.com, address them
to the very same by the nick pickpacket on the irc.oftc.net IRC server, or
in the project at https://notabug.org/tinyrabbit/tea-tea-deluxe

Always included a detailed description of the bug, preferrably with
screenshot and savegame. Also state the exact game version you're using, 
as well as the version of this NewGRF.

If you have a savegame that includes NewGRFs not available on OpenTTD's 
Online Content, then please try to reproduce the bug in a new game 
which has all NewGRFs easily accessible.


7.2 Other problems and general inquiries
------------------
The same contact information as above applies.


---------
8 License
---------

Tea Tea Deluxe - This NewGRF adds a tea based economy chain.
Copyright (C) 2022 Björn Wärmedal

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.



----------------------
9 Obtaining the source
----------------------

The source is available at https://notabug.org/tinyrabbit/tea-tea-deluxe

9.1 Building the NewGRF
-----------------------
NML can only build one file. For readability this NewGRF is split into
several .nml files. The build.sh script combines these in the proper order
and builds the NewGRF, passing any arguments on to NML directly.