Go to file
kts d0cc354480 Created run_windows.bat, a batch front-end to sdl and main. Fixed up makefiles a bit to aid in building on Windows. Fixed up README.txt and created dox/proclib.txt - an introductory file to proclib. Deleted todo.txt, as it wasn't needed. 2014-11-20 22:08:07 -08:00
dox Created run_windows.bat, a batch front-end to sdl and main. Fixed up makefiles a bit to aid in building on Windows. Fixed up README.txt and created dox/proclib.txt - an introductory file to proclib. Deleted todo.txt, as it wasn't needed. 2014-11-20 22:08:07 -08:00
src Fixed various warnings and removed unneeded debugging prints 2014-11-20 19:04:20 -08:00
structs SDL frontend - use as per main. space/enter regens and links structures, Z only regens structure, and X only link structures. Q quits. 2014-11-20 15:45:05 -08:00
tools Created run_windows.bat, a batch front-end to sdl and main. Fixed up makefiles a bit to aid in building on Windows. Fixed up README.txt and created dox/proclib.txt - an introductory file to proclib. Deleted todo.txt, as it wasn't needed. 2014-11-20 22:08:07 -08:00
.gitignore Initial commit of the procedural generation syntax library - possesses majority of the basic structure generation codebase, but is lacking the pathing portion (keep posted) 2014-11-17 00:13:51 -08:00
Makefile Created run_windows.bat, a batch front-end to sdl and main. Fixed up makefiles a bit to aid in building on Windows. Fixed up README.txt and created dox/proclib.txt - an introductory file to proclib. Deleted todo.txt, as it wasn't needed. 2014-11-20 22:08:07 -08:00
README.txt Created run_windows.bat, a batch front-end to sdl and main. Fixed up makefiles a bit to aid in building on Windows. Fixed up README.txt and created dox/proclib.txt - an introductory file to proclib. Deleted todo.txt, as it wasn't needed. 2014-11-20 22:08:07 -08:00
run_windows.bat Created run_windows.bat, a batch front-end to sdl and main. Fixed up makefiles a bit to aid in building on Windows. Fixed up README.txt and created dox/proclib.txt - an introductory file to proclib. Deleted todo.txt, as it wasn't needed. 2014-11-20 22:08:07 -08:00

README.txt

,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
proclib
` ` ` ` ` ` ` ` ` ` ` ` ` ` ` ` 
This is a general information/readme for proclib, a structure-oriented procedural generation library and syntax. For more information, see "dox/proclib.txt"
,,,,,,,,,,,,,,,,
General Running Information
` ` ` ` ` ` ` ` 
At the moment, there are 3 programs generated using proclib:
  * "bin/main" -- basic terminal-based ASCII structure generator
  * "bin/sdl" -- SDL 1.2 structure generator - a bit more feature rich
  * "tools/tobmp" -- structure-to-BMP generator

There is 1 front-end helper script:
  * "run_windows.bat" -- front-end to main and sdl for Windows users
    - This also supports drag'n'drop of structure definition files.

,,,,,,,,,,,,,,,,
Specific Running Information
` ` ` ` ` ` ` ` 
All commands show usage when run without any arguments, but here is the general usage syntaxes:

  bin/main structure_file structure_name
    ex. "bin/main structs/castle.txt start"

  bin/sdl structure_file structure_name
    ex. "bin/sdl structs/castle.txt start"
    in-app commands:
      space/enter - regen+link structures
      Z           - regen structures
      X           - link structures
      Q           - quit

  tools/tobmp structures_file structure_name scale_x [scale y]
    ex. "bin/sdl structs/castle.txt start 6 2"

,,,,,,,,,,,,,,,,
Build Instructions
` ` ` ` ` ` ` ` 
If the binaries were not available with this package, you can build them yourself on Linux, OS X, or Windows (potentially others, but only tested with these three).

For the basic "main", you just need a GCC build environment, including make. Works fine with mingw32. If you build using Visual Studio or otherwise, I'd be interested in incorporating the needed build scripts into the official releases.

For building "sdl" on win32/mingw, you will need to copy SDL.dll (1.2) to the proclib bin directory.

  * `make all` -- build everything
  * `make main` -- build the basic terminal program
  * `make sdl` -- builds the SDL program
  * `make tools` -- builds tools in tools/ (i.e., "tobmp")
,,,,,,,,,,,,,,,,
Linking/Library Usage
` ` ` ` ` ` ` ` 
As of this release (0.1), a dynamic library is not provided. The next release will provide a usable ".so"/".dll"/".dylib" that can be linked to your program.

At the moment, the solution is to hold proclib as a sub-directory within your application, include the needed header files, and build accordingly.