git.mutantstargoat.com Git - metatoy/blob - README.md

   1 Molten Metal
   2 ============
   3 Molten metal is mainly a tech demo for COM32, my experimental (and still quite
   4 buggy) DOS protected mode kernel, which starts as a flat binary (COM file).
   5
   6 About the game
   7 --------------
   8 There is no goal or fail state. You just play with shapes pulled out of a pool
   9 of molten metal. Grab with the left mouse button and move them around, then let
  10 them fall back into the pool by releasing the mouse button.
  11
  12 About COM32
  13 -----------
  14 The idea is to facilitate writing small protected mode DOS programs, without
  15 having to rely on DOS-specific toolchains. Use COM32 and GCC on GNU/Linux, build
  16 it as a flat binary, and have it run in 32bit protected mode under DOS.
  17 The downside is mainly that programs are constrained to 64kb, and that there's
  18 no debugger support yet.
  19
  20 Beyond the COM loader and DOS-specific additions, the main bulk of the kernel is
  21 really a large chunk out of my earlier pcboot project:
  22 https://github.com/jtsiomb/pcboot
  23
  24 Frankly there isn't much of a point in any of this, other than being a fun hack.
  25
  26 License
  27 -------
  28 Copyright (C) 2023 John Tsiombikas <nuclear@mutantstargoat.com>
  29
  30 This program is free software, feel free to use, modify, and/or redistribute it
  31 under the terms of the GNU General Public License v3, or at your option any
  32 later version published by the Free Software Foundation. See COPYING for
  33 details.
  34
  35 Build
  36 -----
  37 The data files are not included in the git repo. If you cloned the git repo, you
  38 need to grab a copy of the data directory from the latest release archive before
  39 building.
  40
  41 To build this program you'll need gcc, nasm, and GNU make.
  42
  43 Run `make` to build the native (UNIX/Windows) version, or `make -f Makefile.dos`
  44 to build the DOS 32bit COM executable.