Browse Source

Update readme with instructions

RelativeDependencies
Macoy Madson 10 months ago
parent
commit
fbc2991732
  1. 40
      ReadMe.org

40
ReadMe.org

@ -23,10 +23,48 @@ Note that changes to the 3rd-party dependencies will not automatically be detect
You may need to follow the instructions in the /Asset pipeline/ section if you are failing during the ~Asset-Building~ stage. (You may also comment out any ~VocalGame.cake~ lines in the build script to avoid building any assets.)
* Cleaning test
** Cleaning test
#+BEGIN_SRC sh
./test/RemoveSubmodules.sh
#+END_SRC
** Setting up for your project
#+BEGIN_SRC sh
mkdir my-project
cd my-project
git submodule add https://macoy.me/code/macoy/cakelisp/ Dependencies/cakelisp
git submodule add https://macoy.me/code/macoy/gamelib/ Dependencies/gamelib
#+END_SRC
Then, copy the following script (you get the idea - build cakelisp, then build your project):
#+BEGIN_SRC sh
#!/bin/sh
CAKELISP_DIR=Dependencies/cakelisp
# Build Cakelisp itself
echo "\n\nCakelisp\n\n"
cd $CAKELISP_DIR
./Build.sh || exit $?
cd ../..
CAKELISP=./Dependencies/cakelisp/bin/cakelisp
echo "\n\nMy project\n\n"
$CAKELISP MyProject.cake || exit $?
#+END_SRC
You'll probably need the following search paths:
#+BEGIN_SRC lisp
;; Cakelisp
(set-cakelisp-option cakelisp-src-dir "Dependencies/cakelisp/src")
(add-cakelisp-search-directory "Dependencies/cakelisp/runtime")
;; Gamelib
(add-cakelisp-search-directory "Dependencies/gamelib/src")
#+END_SRC
Refer to ~test/~ for project setup.
* Asset pipeline
You should do it manually once to ensure your environment is properly configured, then refer to ~test/src/VocalGame.cake~ function ~process-3d-assets~ for how to automate it.
** Blender setup

Loading…
Cancel
Save