import recovered chunk of validity_check() func
[rofl0r-financial-time-machine.git] / README
blob2ca46eab753430353132b713f84c9f25e699ea15
1 November 2014
3 Financial Time Machine first appeared in 1982 as 
4 "The Great Wall Street Fortune Hunt" for the Odyssey 2 Console.
5 later it reappeared as C64 version with the current title.
6 The version for the Commodore Amiga from 1985 was shipped together
7 with its C source code, although a single source file (lessee6.c)
8 has been lost.
9 http://eab.abime.net/showthread.php?t=71641
11 this project here is based on that source code and tries to recreate
12 the missing functionality and use modern backend to be able to run
13 the game on recent operating systems in order to preserve it for
14 the generations to come.
16 To compile it, a C99 compiler, SDL library, and "make" utility
17 is required, however lacking the latter, it should be sufficient to
18 just manually compile ftm.c.
20 Original README follows.
22                                         rofl0r
26 November 1985
28     This new release of THE FINANCIAL TIME MACHINE includes a new
29 command for those people who can't wait for history to repeat
30 itself slowly.
32 The new command is called JUMP.
34 This command allows you to set the game into a mode where it
35 speeds through time.  This means that it is no longer necessary
36 for you to wait through long periods of inactivity to see how
37 well your investment strategy is doing.  In addition, for those
38 intrepid enough to try, you'll find that all regular commands are
39 still active in JUMP mode!  And for the real speed addicts, if
40 you turn off the stock ticker click (by holding down the control
41 key and typing Q) things really being to fly.  To play along at
42 this speed you'll need a crystal ball and blindingly fast
43 fingers.
45 Here's how the command works. Type:
47     JUMP 10
49 This will put in JUMP mode for 10 weeks.
51 If you try:
53     JUMP *
55 it will put you into JUMP mode for 3500 weeks, enough weeks to
56 play the entire 55 years.  Don't panic if you need to get back
57 out of JUMP mode.  Just type:
59     JUMP 0
61 Good Luck!
64 ADDITIONAL INFO & HINTS
65 -----------------------
67     For those of you who like short cuts and hate typing you'll
68 find that FTM recognizes any distinct abbreviation for a command,
69 as well as for stock names.  For example:
71     B  2  IBM
73 is as good as
75     BU  2  IB
77 is as good as
79     BUY 2 IBM
81 but
83     B  2  I
85     is no good because FTM can't tell if you want to buy IBM,
86 IMF, or ITT.  In addition you can always check a command by
87 hitting the ESCAPE key.  This will NEVER execute the command but
88 it will expand commands into a more readable form.  For example:
90     B  2  R
92 would expand to
94     BUY 2 RES AT 120
96 when you hit the ESCAPE key.
99 ON TAXES
100 --------
102     If you don't hold a stock at least a year then anything you
103 make is taxable as short term gains (50% tax rate).  If you DO
104 hold it a year or more it's Long Term Gains (only 25% tax rate.
105 FTM always sells the shares that you've held the longest first in
106 order to give you the best deal.  For those interested in really
107 playing the angles on taxes this is how taxes are figured.
109 If both Short Term and Long Term Gains are positive or both are
110 negative then just multiply both by their respective tax rates
111 (50% and 25%) to come up with your taxes due or tax credit.  If
112 one or the other is positive and the other is negative then
113 things are a bit more complicated.  This is what happens.  First
114 you add the two numbers together (Short Term Gains + Long Term
115 Gains; where one of the two is negative, a loss).   Then you pick
116 which of the two numbers (Short or Long Term Gains) is largest,
117 ignoring the negative sign, and use that numbers tax rate on the
118 number you got by adding the two together.  Essentially what is
119 happening is that you can cancel Short and Long Term gains and
120 losses against each other and the tax rate is determined by which
121 one of the two was largest (in an absolute sense).  Got it???  If
122 not don't worry the program takes care of all this for you.
124     Bond interest is always taxed at 50% and is considered Other
125 Earnings, as are earnings from options.  If a stock splits and
126 you can't hold the extra shares  (the limit is 9999) then you get
127 cash instead and that's taxed as Other Earnings as well.  If you
128 own IMF when ANY stock splits you get a cash dividend as well,
129 again taxed as Other Earnings (50% rate).  If all this taxation
130 is getting you down then you'll be pleased to know that FTM
131 automatically carries forward any tax losses you might have from
132 year to year.  Sorry, no refunds.
135 A HINT
136 ------
137     In the real world it's tough to make money and so it is in
138 the world of THE FINANCIAL TIME MACHINE.  Those bar charts in the
139 instruction manual for each of stocks are the key.  They provide
140 a measure of how stocks generally (but only generally) react to
141 various events.  It's worth the time to study them.  Also don't
142 be reluctant to deal in options, there is money to be made, as
143 well as lost.  In addition, if you buy on margin you effectively
144 double your buying power and potential return (while at the same
145 time doubling you risk).  But interest accrues on you margin debt
146 so beware.  And, after all is said and done, keep in mind that
147 the prime rate generally reflects the inflation rate and that in
148 real life you would be fighting against inflation as well as
149 trying to make money.  Those of you interested in seeing how you
150 are doing against some benchmark can try one of two methods.
151 Either set up a second dummy player that invests everything in
152 bonds (this will reflect how much you could have made by just
153 holding bonds; remember bonds don't incur any brokerage fees
154 either), or set up a dummy player that invests everything in IMF
155 (this reflects how well the market performed overall).  Take some
156 risks and enjoy!
161                                         NMc