Added debugger.
[jars.git] / README
1 JaRS: Janky Redcode Simulator
2 =============================
3
4 A hobby implementation of the Memory Array Redcode Simulator (MARS)
5 and associated tools for the programming game, Core War. The original
6 concept for this game was developed by A. K. Dewdney (see
7 http://corewar.co.uk/dewdney for copies of the 1984 Scientific
8 American columns where the idea was first presented).
9
10 At this pont, JaRS contains utilities for:
11 - Running redcode programs (warriors) specified in the "load file"
12   format of the 1994 draft of the core war standard,
13 - Visualizing the progress of battles graphically using Tk, and
14 - Maintaining King of the Hill style tournaments in the spirit of
15   http://www.koth.org.
16
17 JaRS is still under development, and many aspects have not been fully
18 tested.  Use at your own risk!
19
20 Further Details
21 ---------------
22
23 JaRS follows version 3.3 of the Proposed 1994 Core War Standard.
24 (A copy is here: gopher://thelambdalab.xyz/0/docs/icws94.txt.)
25
26 Currently the parser only handles the redcode programs expressed in
27 the simple "load file" format described by the standard.  All possible
28 core war programs can be expressed in this format, but it lacks some
29 niceties such as labeled addresses.  That is, it accepts the redcode
30 equivalent of machine code but lacks an assembler.
31
32 Furthermore the simulator itself lacks support for p-space, a private
33 memory area reserved for each program in some later revisions of the
34 standard.
35
36 License
37 -------
38
39 JaRS is free software, and is distributed under the terms of version 3
40 of the GNU General Public License.  A copy of this license can be found in
41 the file named COPYING.