Browse Source

Update readme with dependencies explanation

windows-imgui
Macoy Madson 8 months ago
parent
commit
1a5d3e15c7
  1. 17
      ReadMe.org

17
ReadMe.org

@ -5,12 +5,13 @@ GameLib is my library for making games. It is the successor to [[https://macoy.m
GameLib is written in [[https://macoy.me/code/macoy/cakelisp/][Cakelisp]].
* Setup
Clone the repository and its dependencies:
Clone the repository:
#+BEGIN_SRC sh
git clone https://macoy.me/code/macoy/gamelib.git
git submodule update --init --recursive
#+END_SRC
By default, GameLib does not include any 3rd-party dependencies. The dependencies will be downloaded to a folder ~Dependencies/~ as soon as you import their modules. This allows me to continue adding useful tools to GameLib without having it balloon into hour-long submodule downloading.
Build tests:
#+BEGIN_SRC sh
cd test/
@ -21,12 +22,7 @@ This step will take a while the first time, because it builds Cakelisp, Ogre, SD
Note that changes to the 3rd-party dependencies will not automatically be detected.
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
#+BEGIN_SRC sh
./test/RemoveSubmodules.sh
#+END_SRC
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.
** Setting up for your project
#+BEGIN_SRC sh
@ -65,6 +61,11 @@ You'll probably need the following search paths:
#+END_SRC
Refer to ~test/~ for project setup.
** Cleaning test
#+BEGIN_SRC sh
./test/RemoveSubmodules.sh
#+END_SRC
This shouldn't be necessary because ~test/~ is set up to not clone dependencies as submodules, but if you are testing the submodules feature, this script helps undo them.
* 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