55 lines
2.4 KiB
Plaintext
55 lines
2.4 KiB
Plaintext
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
|
|
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.
|