README

   1 # RULP: Ru*** roLeplay Playground
   2
   3 It is a virtual board for roleplay games, it display a table
   4 with a grid to simulate battles and scenaries. It include
   5 an editor to create your own map and events.
   6
   7 ## Install on Linux
   8
   9 The software is released as binaries on the osdn page in both appimage
  10 with dependencies and rpm/deb. This software uses raylib, tcl and tk to
  11 run.
  12
  13 If you want to compile, be aware that this software is
  14 developed with Common Lisp and it is tested and deployed with
  15 the "Steel Bank Common Lisp" (sbcl), but it can work
  16 with other implementations such as GNU clisp or Clozure Common Lisp.
  17
  18 * sbcl (or clisp, or ccl)
  19
  20 Also the software uses sdl2 and ltk libraries for display graphics.
  21
  22 * sdl2-devel
  23 * sdl2_image-devel
  24 * tcl
  25 * tk
  26 * quicklisp
  27
  28 To compile you can use buildapp or just do with asdf. To compile with
  29 buildapp you just need to use the makefile
  30
  31 $ make
  32 # make install
  33
  34 Or if you don't use buildapp you can use the asdf tools for that:
  35
  36 $ cd /path/to/sources
  37 $ sbcl --load rulp.asd
  38 * (require :rulp)
  39 * (asdf:make :rulp)
  40
  41 Then use CTRL+D to exit console.
  42
  43 ## Install on Windows
  44
  45 To compile on windows you need sbcl and the dlls SDL2.dll,
  46 SDL2-image.dll and SDL2-ttf.dll.
  47
  48 First you can install sbcl from the website or with chocolatey
  49 with
  50
  51 # choco install sbcl
  52
  53 (here the # indicate that you use administrator powershell).
  54
  55 The dlls can be downloaded from the sdl2, sdl2-image and sdl2-ttf
  56 github pages selecting the win32-x64 version. The dlls should
  57 be copied in the rulp folders.
  58
  59 also you need to download the libffi sources and copy the ffi.h and
  60 ffi-target.h files for later use.
  61
  62 Start sbcl on your folder and install quicklisp as written on
  63 the website beta.quicklisp.org.
  64
  65 With quicklisp installed, use the commands
  66
  67 * (ql:quickload "clingon")
  68 * (ql:quickload "sdl2")
  69 * (ql:quickload "sdl2-image")
  70 * (ql:quickload "sdl2-ttf")
  71
  72 sdl2-ttf should fail because it misses the ffi.h files. These files
  73 need to be placed into
  74 quicklisp\dists\quicklisp\software\libffi[whatever version]\
  75 and retry the last command.
  76
  77 Now you should be able to start and compile rulp. Without using
  78 the makefile just execute
  79
  80 > sbcl --load "rulp.asd" --eval "(progn (require :rulp) (asdf:make :rulp))"
  81
  82 The sbcl.exe executable should in the folder.