settlers 0.2.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,18 @@
1
+ = settlers
2
+
3
+ Play Settlers of Catan on your computer. You know you want to.
4
+
5
+ All the hard work here was part of Robb Thomas'
6
+ JSettlers[http://jsettlers.sf.net] project; I just wrapped his code with a
7
+ handy shell script.
8
+
9
+ == Behold
10
+
11
+ settlers # launches a game -- a server and a client connected to it
12
+
13
+ settlers --client # browses for a server to connect to
14
+
15
+ == Install
16
+
17
+ gem install settlers
18
+
@@ -0,0 +1,10 @@
1
+ begin
2
+ require 'shoe'
3
+ rescue LoadError
4
+ abort 'Please `gem install shoe` to get started.'
5
+ end
6
+
7
+ Shoe.tie('settlers', '0.2.1', "Provides a simple command-line executable for playing Robb Thomas' JSettlers game.") do |spec|
8
+ spec.add_dependency 'dnssd'
9
+ spec.add_dependency 'highline'
10
+ end
@@ -0,0 +1,6 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ $:.unshift File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
4
+ require 'settlers'
5
+
6
+ Settlers::Application.new(*ARGV).run
@@ -0,0 +1,3 @@
1
+ require 'settlers/java_command'
2
+ require 'settlers/jar'
3
+ require 'settlers/application'
@@ -0,0 +1,131 @@
1
+ require 'optparse'
2
+ require 'set'
3
+ require 'shellwords'
4
+
5
+ require 'rubygems'
6
+ require 'dnssd'
7
+ require 'highline/import'
8
+
9
+ module Settlers
10
+ class Application
11
+ attr_accessor :server, :client, :style
12
+
13
+ def initialize(*args)
14
+ self.server = Server.new
15
+ self.client = Client.new
16
+ self.style = StandaloneGame
17
+ parse_options(args)
18
+ end
19
+
20
+ def run
21
+ style.new(self).run
22
+ end
23
+
24
+ def start_server
25
+ server.start
26
+ end
27
+
28
+ def start_client(server)
29
+ client.start(server)
30
+ end
31
+
32
+ def find_server
33
+ choose(*available_servers)
34
+ end
35
+
36
+ private
37
+
38
+ def parse_options(args)
39
+ # TODO it would be nice to provide a quick tabtab definition here.
40
+ OptionParser.new do |opts|
41
+ opts.on('-c', '--client') { self.style = BonjourClientGame }
42
+ opts.parse!(args)
43
+ end
44
+ end
45
+
46
+ class StandaloneGame < Struct.new(:app)
47
+ def run
48
+ app.start_server
49
+ app.start_client(app.server)
50
+ end
51
+ end
52
+
53
+ class BonjourClientGame < Struct.new(:app)
54
+ def run
55
+ app.start_client(app.find_server)
56
+ end
57
+ end
58
+
59
+ def available_servers(timeout = 3)
60
+ servers = Set.new
61
+
62
+ dns = DNSSD.browse('_settlers._tcp') do |reply|
63
+ DNSSD.resolve(reply.name, reply.type, reply.domain) do |resolve_reply|
64
+ servers << RemoteServer.new(reply.name, resolve_reply.target, resolve_reply.port)
65
+ end
66
+ end
67
+
68
+ puts 'Looking for settlers servers nearby...'
69
+ sleep timeout
70
+ dns.stop
71
+
72
+ return servers
73
+ end
74
+
75
+ class Server
76
+ # Maybe we can change these to attr_writer as we'd like to make them command-line configurable.
77
+ attr_reader :name, :host, :port, :startup_delay, :maximum_connections, :username, :password, :robot_names
78
+
79
+ def initialize
80
+ @name = "#{`hostname -s`.chomp}-#{`whoami`.chomp}"
81
+ @host = 'localhost'
82
+ @port = 8880
83
+ @startup_delay = 4
84
+ @maximum_connections = 12
85
+ @username = 'root'
86
+ @password = ''
87
+ @robot_names = %w(Leonardo Humperdink Elwood)
88
+ end
89
+
90
+ def start
91
+ announce
92
+ serve
93
+ sleep(startup_delay)
94
+ start_robots
95
+ end
96
+
97
+ private
98
+
99
+ def announce
100
+ # Maybe it would be nice to include a TextRecord here providing something of a description?
101
+ DNSSD.register(name, '_settlers._tcp', 'local', port) do |rr|
102
+ puts "Announcing settlers server available on port #{port}."
103
+ end
104
+ end
105
+
106
+ def serve
107
+ # TODO move the Shellwords.escape call inside of JavaCommand.start
108
+ Jar.new('JSettlersServer.jar').running('soc.server.SOCServer').start(port, maximum_connections, username, Shellwords.escape(password))
109
+ end
110
+
111
+ def start_robots
112
+ robot_names.each do |name|
113
+ # TODO move the Shellwords.escape call inside of JavaCommand.start
114
+ Jar.new('JSettlersServer.jar').running('soc.robot.SOCRobotClient').start(host, port, name, Shellwords.escape(password))
115
+ end
116
+ end
117
+ end
118
+
119
+ class RemoteServer < Struct.new(:name, :host, :port)
120
+ def to_s
121
+ "#{name} (#{host}:#{port})"
122
+ end
123
+ end
124
+
125
+ class Client
126
+ def start(server)
127
+ Jar.new('JSettlers.jar').running('soc.client.SOCPlayerClient').run(server.host, server.port)
128
+ end
129
+ end
130
+ end
131
+ end
@@ -0,0 +1,17 @@
1
+ module Settlers
2
+ class Jar
3
+ def initialize(path)
4
+ @path = path
5
+ end
6
+
7
+ def running(class_name)
8
+ JavaCommand.new(full_path, class_name)
9
+ end
10
+
11
+ private
12
+
13
+ def full_path
14
+ File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'resources', 'jsettlers-1.0.6', @path))
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,22 @@
1
+ module Settlers
2
+ class JavaCommand
3
+ def initialize(class_path, class_name)
4
+ @class_path, @class_name = class_path, class_name
5
+ end
6
+
7
+ def run(*args)
8
+ system command(args)
9
+ end
10
+
11
+ def start(*args)
12
+ pid = fork { exec command(args) }
13
+ at_exit { Process.kill 'INT', pid }
14
+ end
15
+
16
+ private
17
+
18
+ def command(args)
19
+ "java -cp #{@class_path} #{@class_name} #{args.join(' ')}"
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,340 @@
1
+ GNU GENERAL PUBLIC LICENSE
2
+ Version 2, June 1991
3
+
4
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
5
+ 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
6
+ Everyone is permitted to copy and distribute verbatim copies
7
+ of this license document, but changing it is not allowed.
8
+
9
+ Preamble
10
+
11
+ The licenses for most software are designed to take away your
12
+ freedom to share and change it. By contrast, the GNU General Public
13
+ License is intended to guarantee your freedom to share and change free
14
+ software--to make sure the software is free for all its users. This
15
+ General Public License applies to most of the Free Software
16
+ Foundation's software and to any other program whose authors commit to
17
+ using it. (Some other Free Software Foundation software is covered by
18
+ the GNU Library General Public License instead.) You can apply it to
19
+ your programs, too.
20
+
21
+ When we speak of free software, we are referring to freedom, not
22
+ price. Our General Public Licenses are designed to make sure that you
23
+ have the freedom to distribute copies of free software (and charge for
24
+ this service if you wish), that you receive source code or can get it
25
+ if you want it, that you can change the software or use pieces of it
26
+ in new free programs; and that you know you can do these things.
27
+
28
+ To protect your rights, we need to make restrictions that forbid
29
+ anyone to deny you these rights or to ask you to surrender the rights.
30
+ These restrictions translate to certain responsibilities for you if you
31
+ distribute copies of the software, or if you modify it.
32
+
33
+ For example, if you distribute copies of such a program, whether
34
+ gratis or for a fee, you must give the recipients all the rights that
35
+ you have. You must make sure that they, too, receive or can get the
36
+ source code. And you must show them these terms so they know their
37
+ rights.
38
+
39
+ We protect your rights with two steps: (1) copyright the software, and
40
+ (2) offer you this license which gives you legal permission to copy,
41
+ distribute and/or modify the software.
42
+
43
+ Also, for each author's protection and ours, we want to make certain
44
+ that everyone understands that there is no warranty for this free
45
+ software. If the software is modified by someone else and passed on, we
46
+ want its recipients to know that what they have is not the original, so
47
+ that any problems introduced by others will not reflect on the original
48
+ authors' reputations.
49
+
50
+ Finally, any free program is threatened constantly by software
51
+ patents. We wish to avoid the danger that redistributors of a free
52
+ program will individually obtain patent licenses, in effect making the
53
+ program proprietary. To prevent this, we have made it clear that any
54
+ patent must be licensed for everyone's free use or not licensed at all.
55
+
56
+ The precise terms and conditions for copying, distribution and
57
+ modification follow.
58
+
59
+ GNU GENERAL PUBLIC LICENSE
60
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61
+
62
+ 0. This License applies to any program or other work which contains
63
+ a notice placed by the copyright holder saying it may be distributed
64
+ under the terms of this General Public License. The "Program", below,
65
+ refers to any such program or work, and a "work based on the Program"
66
+ means either the Program or any derivative work under copyright law:
67
+ that is to say, a work containing the Program or a portion of it,
68
+ either verbatim or with modifications and/or translated into another
69
+ language. (Hereinafter, translation is included without limitation in
70
+ the term "modification".) Each licensee is addressed as "you".
71
+
72
+ Activities other than copying, distribution and modification are not
73
+ covered by this License; they are outside its scope. The act of
74
+ running the Program is not restricted, and the output from the Program
75
+ is covered only if its contents constitute a work based on the
76
+ Program (independent of having been made by running the Program).
77
+ Whether that is true depends on what the Program does.
78
+
79
+ 1. You may copy and distribute verbatim copies of the Program's
80
+ source code as you receive it, in any medium, provided that you
81
+ conspicuously and appropriately publish on each copy an appropriate
82
+ copyright notice and disclaimer of warranty; keep intact all the
83
+ notices that refer to this License and to the absence of any warranty;
84
+ and give any other recipients of the Program a copy of this License
85
+ along with the Program.
86
+
87
+ You may charge a fee for the physical act of transferring a copy, and
88
+ you may at your option offer warranty protection in exchange for a fee.
89
+
90
+ 2. You may modify your copy or copies of the Program or any portion
91
+ of it, thus forming a work based on the Program, and copy and
92
+ distribute such modifications or work under the terms of Section 1
93
+ above, provided that you also meet all of these conditions:
94
+
95
+ a) You must cause the modified files to carry prominent notices
96
+ stating that you changed the files and the date of any change.
97
+
98
+ b) You must cause any work that you distribute or publish, that in
99
+ whole or in part contains or is derived from the Program or any
100
+ part thereof, to be licensed as a whole at no charge to all third
101
+ parties under the terms of this License.
102
+
103
+ c) If the modified program normally reads commands interactively
104
+ when run, you must cause it, when started running for such
105
+ interactive use in the most ordinary way, to print or display an
106
+ announcement including an appropriate copyright notice and a
107
+ notice that there is no warranty (or else, saying that you provide
108
+ a warranty) and that users may redistribute the program under
109
+ these conditions, and telling the user how to view a copy of this
110
+ License. (Exception: if the Program itself is interactive but
111
+ does not normally print such an announcement, your work based on
112
+ the Program is not required to print an announcement.)
113
+
114
+ These requirements apply to the modified work as a whole. If
115
+ identifiable sections of that work are not derived from the Program,
116
+ and can be reasonably considered independent and separate works in
117
+ themselves, then this License, and its terms, do not apply to those
118
+ sections when you distribute them as separate works. But when you
119
+ distribute the same sections as part of a whole which is a work based
120
+ on the Program, the distribution of the whole must be on the terms of
121
+ this License, whose permissions for other licensees extend to the
122
+ entire whole, and thus to each and every part regardless of who wrote it.
123
+
124
+ Thus, it is not the intent of this section to claim rights or contest
125
+ your rights to work written entirely by you; rather, the intent is to
126
+ exercise the right to control the distribution of derivative or
127
+ collective works based on the Program.
128
+
129
+ In addition, mere aggregation of another work not based on the Program
130
+ with the Program (or with a work based on the Program) on a volume of
131
+ a storage or distribution medium does not bring the other work under
132
+ the scope of this License.
133
+
134
+ 3. You may copy and distribute the Program (or a work based on it,
135
+ under Section 2) in object code or executable form under the terms of
136
+ Sections 1 and 2 above provided that you also do one of the following:
137
+
138
+ a) Accompany it with the complete corresponding machine-readable
139
+ source code, which must be distributed under the terms of Sections
140
+ 1 and 2 above on a medium customarily used for software interchange; or,
141
+
142
+ b) Accompany it with a written offer, valid for at least three
143
+ years, to give any third party, for a charge no more than your
144
+ cost of physically performing source distribution, a complete
145
+ machine-readable copy of the corresponding source code, to be
146
+ distributed under the terms of Sections 1 and 2 above on a medium
147
+ customarily used for software interchange; or,
148
+
149
+ c) Accompany it with the information you received as to the offer
150
+ to distribute corresponding source code. (This alternative is
151
+ allowed only for noncommercial distribution and only if you
152
+ received the program in object code or executable form with such
153
+ an offer, in accord with Subsection b above.)
154
+
155
+ The source code for a work means the preferred form of the work for
156
+ making modifications to it. For an executable work, complete source
157
+ code means all the source code for all modules it contains, plus any
158
+ associated interface definition files, plus the scripts used to
159
+ control compilation and installation of the executable. However, as a
160
+ special exception, the source code distributed need not include
161
+ anything that is normally distributed (in either source or binary
162
+ form) with the major components (compiler, kernel, and so on) of the
163
+ operating system on which the executable runs, unless that component
164
+ itself accompanies the executable.
165
+
166
+ If distribution of executable or object code is made by offering
167
+ access to copy from a designated place, then offering equivalent
168
+ access to copy the source code from the same place counts as
169
+ distribution of the source code, even though third parties are not
170
+ compelled to copy the source along with the object code.
171
+
172
+ 4. You may not copy, modify, sublicense, or distribute the Program
173
+ except as expressly provided under this License. Any attempt
174
+ otherwise to copy, modify, sublicense or distribute the Program is
175
+ void, and will automatically terminate your rights under this License.
176
+ However, parties who have received copies, or rights, from you under
177
+ this License will not have their licenses terminated so long as such
178
+ parties remain in full compliance.
179
+
180
+ 5. You are not required to accept this License, since you have not
181
+ signed it. However, nothing else grants you permission to modify or
182
+ distribute the Program or its derivative works. These actions are
183
+ prohibited by law if you do not accept this License. Therefore, by
184
+ modifying or distributing the Program (or any work based on the
185
+ Program), you indicate your acceptance of this License to do so, and
186
+ all its terms and conditions for copying, distributing or modifying
187
+ the Program or works based on it.
188
+
189
+ 6. Each time you redistribute the Program (or any work based on the
190
+ Program), the recipient automatically receives a license from the
191
+ original licensor to copy, distribute or modify the Program subject to
192
+ these terms and conditions. You may not impose any further
193
+ restrictions on the recipients' exercise of the rights granted herein.
194
+ You are not responsible for enforcing compliance by third parties to
195
+ this License.
196
+
197
+ 7. If, as a consequence of a court judgment or allegation of patent
198
+ infringement or for any other reason (not limited to patent issues),
199
+ conditions are imposed on you (whether by court order, agreement or
200
+ otherwise) that contradict the conditions of this License, they do not
201
+ excuse you from the conditions of this License. If you cannot
202
+ distribute so as to satisfy simultaneously your obligations under this
203
+ License and any other pertinent obligations, then as a consequence you
204
+ may not distribute the Program at all. For example, if a patent
205
+ license would not permit royalty-free redistribution of the Program by
206
+ all those who receive copies directly or indirectly through you, then
207
+ the only way you could satisfy both it and this License would be to
208
+ refrain entirely from distribution of the Program.
209
+
210
+ If any portion of this section is held invalid or unenforceable under
211
+ any particular circumstance, the balance of the section is intended to
212
+ apply and the section as a whole is intended to apply in other
213
+ circumstances.
214
+
215
+ It is not the purpose of this section to induce you to infringe any
216
+ patents or other property right claims or to contest validity of any
217
+ such claims; this section has the sole purpose of protecting the
218
+ integrity of the free software distribution system, which is
219
+ implemented by public license practices. Many people have made
220
+ generous contributions to the wide range of software distributed
221
+ through that system in reliance on consistent application of that
222
+ system; it is up to the author/donor to decide if he or she is willing
223
+ to distribute software through any other system and a licensee cannot
224
+ impose that choice.
225
+
226
+ This section is intended to make thoroughly clear what is believed to
227
+ be a consequence of the rest of this License.
228
+
229
+ 8. If the distribution and/or use of the Program is restricted in
230
+ certain countries either by patents or by copyrighted interfaces, the
231
+ original copyright holder who places the Program under this License
232
+ may add an explicit geographical distribution limitation excluding
233
+ those countries, so that distribution is permitted only in or among
234
+ countries not thus excluded. In such case, this License incorporates
235
+ the limitation as if written in the body of this License.
236
+
237
+ 9. The Free Software Foundation may publish revised and/or new versions
238
+ of the General Public License from time to time. Such new versions will
239
+ be similar in spirit to the present version, but may differ in detail to
240
+ address new problems or concerns.
241
+
242
+ Each version is given a distinguishing version number. If the Program
243
+ specifies a version number of this License which applies to it and "any
244
+ later version", you have the option of following the terms and conditions
245
+ either of that version or of any later version published by the Free
246
+ Software Foundation. If the Program does not specify a version number of
247
+ this License, you may choose any version ever published by the Free Software
248
+ Foundation.
249
+
250
+ 10. If you wish to incorporate parts of the Program into other free
251
+ programs whose distribution conditions are different, write to the author
252
+ to ask for permission. For software which is copyrighted by the Free
253
+ Software Foundation, write to the Free Software Foundation; we sometimes
254
+ make exceptions for this. Our decision will be guided by the two goals
255
+ of preserving the free status of all derivatives of our free software and
256
+ of promoting the sharing and reuse of software generally.
257
+
258
+ NO WARRANTY
259
+
260
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261
+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263
+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264
+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266
+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268
+ REPAIR OR CORRECTION.
269
+
270
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272
+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274
+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275
+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276
+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277
+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278
+ POSSIBILITY OF SUCH DAMAGES.
279
+
280
+ END OF TERMS AND CONDITIONS
281
+
282
+ How to Apply These Terms to Your New Programs
283
+
284
+ If you develop a new program, and you want it to be of the greatest
285
+ possible use to the public, the best way to achieve this is to make it
286
+ free software which everyone can redistribute and change under these terms.
287
+
288
+ To do so, attach the following notices to the program. It is safest
289
+ to attach them to the start of each source file to most effectively
290
+ convey the exclusion of warranty; and each file should have at least
291
+ the "copyright" line and a pointer to where the full notice is found.
292
+
293
+ <one line to give the program's name and a brief idea of what it does.>
294
+ Copyright (C) 19yy <name of author>
295
+
296
+ This program is free software; you can redistribute it and/or modify
297
+ it under the terms of the GNU General Public License as published by
298
+ the Free Software Foundation; either version 2 of the License, or
299
+ (at your option) any later version.
300
+
301
+ This program is distributed in the hope that it will be useful,
302
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
303
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304
+ GNU General Public License for more details.
305
+
306
+ You should have received a copy of the GNU General Public License
307
+ along with this program; if not, write to the Free Software
308
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
309
+
310
+
311
+ Also add information on how to contact you by electronic and paper mail.
312
+
313
+ If the program is interactive, make it output a short notice like this
314
+ when it starts in an interactive mode:
315
+
316
+ Gnomovision version 69, Copyright (C) 19yy name of author
317
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
318
+ This is free software, and you are welcome to redistribute it
319
+ under certain conditions; type `show c' for details.
320
+
321
+ The hypothetical commands `show w' and `show c' should show the appropriate
322
+ parts of the General Public License. Of course, the commands you use may
323
+ be called something other than `show w' and `show c'; they could even be
324
+ mouse-clicks or menu items--whatever suits your program.
325
+
326
+ You should also get your employer (if you work as a programmer) or your
327
+ school, if any, to sign a "copyright disclaimer" for the program, if
328
+ necessary. Here is a sample; alter the names:
329
+
330
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
331
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
332
+
333
+ <signature of Ty Coon>, 1 April 1989
334
+ Ty Coon, President of Vice
335
+
336
+ This General Public License does not permit incorporating your program into
337
+ proprietary programs. If your program is a subroutine library, you may
338
+ consider it more useful to permit linking proprietary applications with the
339
+ library. If this is what you want to do, use the GNU Library General
340
+ Public License instead of this License.
@@ -0,0 +1,264 @@
1
+ Java Settlers - A web-based client-server version of Settlers of Catan
2
+
3
+ Introduction
4
+ ------------
5
+
6
+ JSettlers is a web-based version of the board game Settlers of Catan
7
+ written in Java. This client-server system supports multiple
8
+ simultaneous games between people and computer-controlled
9
+ opponents. Initially created as an AI research project.
10
+
11
+ The client may be run as a Java application, or as an applet when
12
+ accessed from a web site which also hosts a JSettlers server.
13
+
14
+ The server may be configured to use a MySQL database to store account
15
+ information. A client applet to create user accounts is also
16
+ provided.
17
+
18
+ JSettlers is an open-source project licensed under the GPL. The
19
+ software is maintained as a SourceForge project at
20
+ http://sourceforge.net/projects/jsettlers.
21
+
22
+ Forums for discussions and community based support are provided at
23
+ SourceForge.
24
+
25
+ -- The JSettlers Development Team
26
+
27
+
28
+ Contents
29
+ --------
30
+
31
+ Documentation
32
+ Requirements
33
+ Setting up and testing
34
+ Shutting down the server
35
+ Hosting a JSettlers Server
36
+ Database Setup
37
+ Development and Compiling
38
+
39
+
40
+ Documentation
41
+ -------------
42
+
43
+ User documentation for game play is available as .html pages located
44
+ in "docs/users" directory. These can be put on a JSettlers server for
45
+ its users using the applet.
46
+
47
+ Currently, this README is the only technical documentation for running
48
+ the client or server, setup and other issues. Over time other more
49
+ will be written. If you are interested in helping write documentation
50
+ please contact the development team from the SourceForge site.
51
+
52
+
53
+ Requirements
54
+ ------------
55
+
56
+ To play JSettlers by connecting to a remote server you will need the
57
+ Java Runtime Version 1.1 or above (1.4 recommended). To connect as an
58
+ applet, use any browser which is Java enabled (again, we recommend
59
+ Java 1.4 using the browser plug-in).
60
+
61
+ To Play JSettlers locally you need the Java Runtime 1.4 (or
62
+ later). Remote clients started on the command line can connect
63
+ directly to this server. To host a JSettlers server and provide a web
64
+ applet for clients, you will need an http server such as Apache's
65
+ httpd, available from http://httpd.apache.org.
66
+
67
+ To build JSettlers from source, you will need Apache Ant, available from
68
+ http://ant.apache.org.
69
+
70
+
71
+ Setting up and testing
72
+ ----------------------
73
+
74
+ From the command line, make sure you are in the JSettlers distribution
75
+ directory which contains both JSettlers.jar, settlers-server.jar and the
76
+ "lib" directory. Start the server with the following command
77
+ (server requires Java 1.4):
78
+
79
+ java -jar JSettlersServer.jar 8880 10 dbUser dbPass
80
+
81
+ If MySQL is not installed and running (See "Database Setup"), you will
82
+ see a warning with the appropriate explanation:
83
+
84
+ Warning: failed to initialize database: ....
85
+
86
+ The server will function normally except that user accounts cannot be
87
+ maintained.
88
+
89
+ Now, from another command line window, start the player client with
90
+ the following command:
91
+
92
+ java -jar JSettlers.jar localhost 8880
93
+
94
+ If you are using Java 1.1 you will need to unpack the Java archive
95
+ (Java could not run directly from jar files until version 1.2). The
96
+ commands to unpack, then start the client are:
97
+
98
+ jar -xf JSettlers.jar
99
+ java soc.client.SOCPlayerClient localhost 8880
100
+
101
+ In the player client window, enter "debug" in the Nickname field and
102
+ create a new game.
103
+
104
+ Type *STATS* into the chat part of the game window. You should see
105
+ something like the following in the chat display:
106
+
107
+ * > Uptime: 0:0:26
108
+ * > Total connections: 1
109
+ * > Current connections: 1
110
+ * > Total Users: 1
111
+ * > Games started: 0
112
+ * > Games finished: 0
113
+ * > Total Memory: 2031616
114
+ * > Free Memory: 1524112
115
+
116
+ If you do not, you might not have entered your nickname correctly. It
117
+ must be "debug" in order to use the administrative commands.
118
+
119
+ Now you can add some robot players. Enter the following commands in
120
+ separate command line windows:
121
+
122
+ java -cp JSettlersServer.jar soc.robot.SOCRobotClient localhost 8880 robot1 passwd
123
+
124
+ java -cp JSettlersServer.jar soc.robot.SOCRobotClient localhost 8880 robot2 passwd
125
+
126
+ java -cp JSettlersServer.jar soc.robot.SOCRobotClient localhost 8880 robot3 passwd
127
+
128
+ Now click on the "Sit Here" button and press "Start Game". The robot
129
+ players should automatically join the game and start playing.
130
+
131
+ If you want other people to access your server, tell them your server
132
+ IP address and port number (in this case 8880). They will enter the
133
+ following command (or use the instructions above for Java 1.1):
134
+
135
+ java -jar JSettlers.jar <host> <port_number>
136
+
137
+ Where host is the IP address and port_number is the port number.
138
+
139
+ If you would like to maintain accounts for your JSettlers server,
140
+ start the database prior to starting the JSettlers Server. See the
141
+ directions in "Database Setup".
142
+
143
+
144
+ Shutting down the server
145
+ ------------------------
146
+
147
+ To shut down the server enter *STOP* in the chat area of a game
148
+ window. This will stop the server and all connected clients will be
149
+ disconnected.
150
+
151
+
152
+ Hosting a JSettlers server
153
+ --------------------------
154
+ - Start MySQL server (optional)
155
+ - Start JSettlers Server
156
+ - Start http server (optional)
157
+ - Copy JSettlers.jar jar and "web/*.html" server directory (optional)
158
+ - Extract JSettlers.jar to allow Java 1.1 clients (optional)
159
+ - Copy "docs/users" to the server directory (optional)
160
+
161
+ To host a JSettlers server, start the server as described in "Setup
162
+ and Testing". To maintain user accounts, be sure to start the database
163
+ first. Remote users can simply start their clients as described there,
164
+ and specify your server as host.
165
+
166
+ To provide a web page from which users can run the applet, you will
167
+ need to set up an html server, such as Apache. We assume you have
168
+ installed it correctly, and will refer to "${docroot}" as a directory
169
+ your web server is configured to provide.
170
+
171
+ Copy the sample .html pages from "web" to ${docroot}. Edit them, to
172
+ make sure the PORT parameter in "index.html" and "account.html" applet
173
+ tags match the port of your JSettlers server.
174
+
175
+ Next copy the client files to the server. Copy JSettlers.jar to
176
+ ${docroot}. This will allow users with Java version 1.2 or later
177
+ installed to use the browser plug-in. Using the .jar like allows for
178
+ faster downloads, and startup times, but does not allow browsers with
179
+ Java version 1.1 to start the client.
180
+
181
+ To allow browsers with old versions of Java (1.1) to use the applet,
182
+ unpack JSettlers.jar and copy (recursively) the extracted "soc"
183
+ and "resources" directories to ${docroot}. To unpack, use:
184
+
185
+ $ jar -xf JSettlers.jar
186
+
187
+ You may also copy the "doc/users" directory (recursively) to the same
188
+ directory as the sample .html pages to provide user documentation.
189
+
190
+ Your web server directory structure should now contain:
191
+ ${docroot}/index.html
192
+ ${docroot}/*.html
193
+ ${docroot}/JSettlers.jar
194
+ ${docroot}/resources/...
195
+ ${docroot}/soc/...
196
+ ${docroot}/users/...
197
+
198
+ Users should now be able to visit your web site to run the client
199
+ version of JSettlers.
200
+
201
+
202
+ Database Setup
203
+ --------------
204
+
205
+ If you want to maintain user accounts, you will need to set up a MySQL
206
+ database. This will eliminate the "Problem connecting to database"
207
+ errors from the server. We assume you have installed it correctly.
208
+
209
+ Run the following commands to create the database and configure its
210
+ tables.
211
+
212
+ CREATE DATABASE socdata;
213
+
214
+ USE socdata;
215
+
216
+ CREATE TABLE users (nickname VARCHAR(20), host VARCHAR(50), password VARCHAR(20), email VARCHAR(50), lastlogin DATE);
217
+
218
+ CREATE TABLE logins (nickname VARCHAR(20), host VARCHAR(50), lastlogin DATE);
219
+
220
+ CREATE TABLE games (gamename VARCHAR(20), player1 VARCHAR(20), player2 VARCHAR(20), player3 VARCHAR(20), player4 VARCHAR(20), score1 TINYINT, score2 TINYINT, score3 TINYINT, score4 TINYINT, starttime TIMESTAMP);
221
+
222
+ CREATE TABLE robotparams (robotname VARCHAR(20), maxgamelength INT, maxeta INT, etabonusfactor FLOAT, adversarialfactor FLOAT, leaderadversarialfactor FLOAT, devcardmultiplier FLOAT, threatmultiplier FLOAT, strategytype INT, starttime TIMESTAMP, endtime TIMESTAMP, gameswon INT, gameslost INT, tradeFlag BOOL);
223
+
224
+
225
+ To create accounts, run the simple account creation client with the
226
+ following command:
227
+
228
+ java -jar JSettlers.jar soc.client.SOCAccountClient localhost 8880
229
+
230
+
231
+ Development and Compiling
232
+ -------------------------
233
+
234
+ Source code for JSettlers is available via anonymous CVS. Source code
235
+ tarballs are also made available. See the project website at
236
+ http://sourceforge.net/projects/jsettlers/ for details. Patches
237
+ against CVS may be submitted there.
238
+
239
+ Before building, make sure you have at least version 1.4 of the Java
240
+ development kit installed. If you simply want to run the client and
241
+ server, you only need the Java. If you wish to maintain a user
242
+ database for your server, you need MySQL installed, and configured.
243
+
244
+ This package was designed to use the ANT tool available from
245
+ http://ant.apache.org tools. We assume you have installed it
246
+ correctly.
247
+
248
+ Check the "build.properties" file. There may be build variables you
249
+ may want to change locally. These can also be changed from the command
250
+ line when calling ant, by passing a "-Dname=value" parameter to ant.
251
+
252
+ Now you are ready to invoke ant. There are several targets, here are
253
+ the most useful ones:
254
+
255
+ build Create project jar files. (default)
256
+ clean Cleans the project of all generated files
257
+ compile Compile class files into "target/classes"
258
+ dist Build distribution tarballs and zips.
259
+ javadoc Creates JavaDoc files in "target/docs/api"
260
+ src Create a tarball of the source tree
261
+
262
+ All files created by building are in the "target" directory, including
263
+ Java .class files, and JavaDoc files. Distribution tarballs, zip
264
+ files, and installation files are placed in "dist".
@@ -0,0 +1,50 @@
1
+ [ The list of the different public versions of JSettlers ]
2
+
3
+ > 1.0.6 (build 2004-11-17)
4
+
5
+ - Fixed the same PORT property error in the Account client
6
+ - Fixed bug which could allow modified clients to invoke admin
7
+ commands (*STOP*, *KILLCHANNEL*, etc) (Lasse Vartiainen)
8
+ - Fixed 920375, 1022157: mysql-connector-3.x fails: version 2.x works
9
+ (Mezryn)
10
+ - Fixed 1060651: Bots crash if database backend is used (Jack Twilley)
11
+ - Moved more SQL error handling and reconnecting from SOCServer to
12
+ SOCDBHelper correcting potential errors like 1060651
13
+
14
+ > 1.0.5 (build 2004-06-12)
15
+
16
+ - Fixed an error introduced into the applet initialization which kept
17
+ the PORT property from being read properly
18
+
19
+ > 1.0.4 (build 2004-06-10)
20
+
21
+ - build.xml file added for Ant builds
22
+ - soc.util.Version class added so both build files and source code get
23
+ version and copyright info from build.xml. Clients and server updated
24
+ - Build process creates two jar files: one for client, one for server
25
+ - README updated for jar file invocation, with additional sections for
26
+ intro, requirements, hosting a server, and development
27
+ - Fix for inconsistent game state when players leave a game.
28
+ - Divider in chat window cannot be moved off-screen
29
+ - Text of game chat now correctly scrolls to bottom of text.
30
+ - Rewrite of much of the display code to address continuing display
31
+ issues. Methods which directly manipulate GUI components can cause
32
+ race conditions, and are now never called from main networking
33
+ thread.
34
+ - Removed calls to deprecated methods
35
+ - Images can now be loaded from files (on server or not) or from
36
+ within jar.
37
+
38
+ > 1.0.3 (build 2004-03-29)
39
+
40
+ - Continuing to fix the display bug in the SOCPlayerClient
41
+
42
+ > 1.0.2 (build 2004-03-26)
43
+
44
+ - Fixed display bug (again) in the SOCPlayerClient when run as a stand
45
+ alone.
46
+
47
+ > 1.0 (build 2004-03-14)
48
+
49
+ - First release. See the README file for how to setup a server and
50
+ robot clients.
@@ -0,0 +1,38 @@
1
+ # -*- encoding: utf-8 -*-
2
+
3
+ Gem::Specification.new do |s|
4
+ s.name = %q{settlers}
5
+ s.version = "0.2.1"
6
+
7
+ s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
8
+ s.authors = ["Matthew Todd"]
9
+ s.date = %q{2010-01-09}
10
+ s.default_executable = %q{settlers}
11
+ s.email = %q{matthew.todd@gmail.com}
12
+ s.executables = ["settlers"]
13
+ s.extra_rdoc_files = ["README.rdoc"]
14
+ s.files = ["Rakefile", "settlers.gemspec", "README.rdoc", "bin/settlers", "lib/settlers", "lib/settlers/application.rb", "lib/settlers/jar.rb", "lib/settlers/java_command.rb", "lib/settlers.rb", "resources/jsettlers-1.0.6", "resources/jsettlers-1.0.6/COPYING.txt", "resources/jsettlers-1.0.6/JSettlers.jar", "resources/jsettlers-1.0.6/JSettlersServer.jar", "resources/jsettlers-1.0.6/README.txt", "resources/jsettlers-1.0.6/VERSIONS.txt"]
15
+ s.rdoc_options = ["--main", "README.rdoc", "--title", "settlers-0.2.1", "--inline-source"]
16
+ s.require_paths = ["lib"]
17
+ s.rubygems_version = %q{1.3.5}
18
+ s.summary = %q{Provides a simple command-line executable for playing Robb Thomas' JSettlers game.}
19
+
20
+ if s.respond_to? :specification_version then
21
+ current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
22
+ s.specification_version = 3
23
+
24
+ if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
25
+ s.add_development_dependency(%q<shoe>, [">= 0"])
26
+ s.add_runtime_dependency(%q<dnssd>, [">= 0"])
27
+ s.add_runtime_dependency(%q<highline>, [">= 0"])
28
+ else
29
+ s.add_dependency(%q<shoe>, [">= 0"])
30
+ s.add_dependency(%q<dnssd>, [">= 0"])
31
+ s.add_dependency(%q<highline>, [">= 0"])
32
+ end
33
+ else
34
+ s.add_dependency(%q<shoe>, [">= 0"])
35
+ s.add_dependency(%q<dnssd>, [">= 0"])
36
+ s.add_dependency(%q<highline>, [">= 0"])
37
+ end
38
+ end
metadata ADDED
@@ -0,0 +1,100 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: settlers
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.2.1
5
+ platform: ruby
6
+ authors:
7
+ - Matthew Todd
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+
12
+ date: 2010-01-09 00:00:00 +01:00
13
+ default_executable: settlers
14
+ dependencies:
15
+ - !ruby/object:Gem::Dependency
16
+ name: shoe
17
+ type: :development
18
+ version_requirement:
19
+ version_requirements: !ruby/object:Gem::Requirement
20
+ requirements:
21
+ - - ">="
22
+ - !ruby/object:Gem::Version
23
+ version: "0"
24
+ version:
25
+ - !ruby/object:Gem::Dependency
26
+ name: dnssd
27
+ type: :runtime
28
+ version_requirement:
29
+ version_requirements: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: "0"
34
+ version:
35
+ - !ruby/object:Gem::Dependency
36
+ name: highline
37
+ type: :runtime
38
+ version_requirement:
39
+ version_requirements: !ruby/object:Gem::Requirement
40
+ requirements:
41
+ - - ">="
42
+ - !ruby/object:Gem::Version
43
+ version: "0"
44
+ version:
45
+ description:
46
+ email: matthew.todd@gmail.com
47
+ executables:
48
+ - settlers
49
+ extensions: []
50
+
51
+ extra_rdoc_files:
52
+ - README.rdoc
53
+ files:
54
+ - Rakefile
55
+ - settlers.gemspec
56
+ - README.rdoc
57
+ - bin/settlers
58
+ - lib/settlers/application.rb
59
+ - lib/settlers/jar.rb
60
+ - lib/settlers/java_command.rb
61
+ - lib/settlers.rb
62
+ - resources/jsettlers-1.0.6/COPYING.txt
63
+ - resources/jsettlers-1.0.6/JSettlers.jar
64
+ - resources/jsettlers-1.0.6/JSettlersServer.jar
65
+ - resources/jsettlers-1.0.6/README.txt
66
+ - resources/jsettlers-1.0.6/VERSIONS.txt
67
+ has_rdoc: true
68
+ homepage:
69
+ licenses: []
70
+
71
+ post_install_message:
72
+ rdoc_options:
73
+ - --main
74
+ - README.rdoc
75
+ - --title
76
+ - settlers-0.2.1
77
+ - --inline-source
78
+ require_paths:
79
+ - lib
80
+ required_ruby_version: !ruby/object:Gem::Requirement
81
+ requirements:
82
+ - - ">="
83
+ - !ruby/object:Gem::Version
84
+ version: "0"
85
+ version:
86
+ required_rubygems_version: !ruby/object:Gem::Requirement
87
+ requirements:
88
+ - - ">="
89
+ - !ruby/object:Gem::Version
90
+ version: "0"
91
+ version:
92
+ requirements: []
93
+
94
+ rubyforge_project:
95
+ rubygems_version: 1.3.5
96
+ signing_key:
97
+ specification_version: 3
98
+ summary: Provides a simple command-line executable for playing Robb Thomas' JSettlers game.
99
+ test_files: []
100
+