gamelib/ReadMe.org

#+TITLE:GameLib

GameLib is my library for making games. It is the successor to [[https://macoy.me/code/macoy/base2.0][base2.0]].

GameLib is written in [[https://macoy.me/code/macoy/cakelisp/][Cakelisp]].

* Setup
Clone the repository and its dependencies:
#+BEGIN_SRC sh
git clone https://macoy.me/code/macoy/gamelib.git
git submodule update --init --recursive
hg clone http://hg.libsdl.org/SDL Dependencies/SDL
#+END_SRC

Build dependencies:
#+BEGIN_SRC sh
./BuildDependencies_Debug.sh
#+END_SRC

Build:
#+BEGIN_SRC sh
./Build_Debug.sh
#+END_SRC

* Asset pipeline
This is a work in progress.
** Blender setup
- Install [[https://www.blender.org/][Blender]]. I can confirm Blender 2.91 works.
- Copy ~blender2ogre~ to Blender plugins:
#+BEGIN_SRC sh
cp -r Dependencies/blender2ogre/io_ogre/ ~/.config/blender/2.91/
#+END_SRC
- Open Blender, then open Preferences (Edit->Preferences), and click Add-ons
- Search for "Ogre" and check the box to enable the OGRE Exporter
- Build Ogre, if you haven't already (run ~BuildDependencies_Debug.sh~)
- Set ~OGRETOOLS_XML_CONVERTER~ to where you built OgreMeshTool. You'll need to browse to ~gamelib/Dependencies/ogre-next/build/Debug/bin/OgreMeshTool_d~

You are now ready to export. Open your model or create one, then do ~File -> Export -> Ogre3D~. See the following section for settings. /Note:/ I will be making command-line driven auto-exporting to reduce these manual steps.
** OGRE Export Settings
- Don't *export materials*. These are v1 materials as far as I know, which don't work with Ogre 2
- Don't *export scene*. I don't use these files
- Ensure *mesh export version* is set to ~v2~
** Converting ~.mesh.xml~ to ~.mesh~
You shouldn't need to do this step if you set ~OGRETOOLS_XML_CONVERTER~, but in case blender2ogre didn't recognize it, here's how I worked around it:

#+BEGIN_SRC sh
cd Dependencies/ogre-next/build/Debug/bin
./OgreMeshTool_d -e -O puqs ../../../../../test/data/Models/Suzanne.mesh.xml
#+END_SRC

Run this after you've made an attempted export from the Blender OGRE plugin.
Added readme 3 years ago			`#+TITLE:GameLib`

			`GameLib is my library for making games. It is the successor to [[https://macoy.me/code/macoy/base2.0][base2.0]].`

Update cakelisp for stable comptime builds * Building each app separately was causing rebuilds of comptime definitions, which I have now fixed in Cakelisp * Moved some SDL stuff around and added a initialize function which should support using SDL for drawing 2 years ago			`GameLib is written in [[https://macoy.me/code/macoy/cakelisp/][Cakelisp]].`

Added readme 3 years ago			`* Setup`
Ogre now successfully creates window 3 years ago			`Clone the repository and its dependencies:`
Added readme 3 years ago			`#+BEGIN_SRC sh`
			`git clone https://macoy.me/code/macoy/gamelib.git`
			`git submodule update --init --recursive`
Got SDL working; Ogre doesn't use its window yet * Moved shared macros into new Macros.cake 2 years ago			`hg clone http://hg.libsdl.org/SDL Dependencies/SDL`
Added readme 3 years ago			`#+END_SRC`
Ogre now successfully creates window 3 years ago
			`Build dependencies:`
			`#+BEGIN_SRC sh`
			`./BuildDependencies_Debug.sh`
			`#+END_SRC`

			`Build:`
			`#+BEGIN_SRC sh`
			`./Build_Debug.sh`
			`#+END_SRC`
Load meshes and create nodes separately 2 years ago
			`* Asset pipeline`
			`This is a work in progress.`
Added blender2ogre and mesh pipeline instructions 2 years ago			`** Blender setup`
			`- Install [[https://www.blender.org/][Blender]]. I can confirm Blender 2.91 works.`
			`- Copy ~blender2ogre~ to Blender plugins:`
			`#+BEGIN_SRC sh`
			`cp -r Dependencies/blender2ogre/io_ogre/ ~/.config/blender/2.91/`
			`#+END_SRC`
			`- Open Blender, then open Preferences (Edit->Preferences), and click Add-ons`
			`- Search for "Ogre" and check the box to enable the OGRE Exporter`
			`- Build Ogre, if you haven't already (run ~BuildDependencies_Debug.sh~)`
			`- Set ~OGRETOOLS_XML_CONVERTER~ to where you built OgreMeshTool. You'll need to browse to ~gamelib/Dependencies/ogre-next/build/Debug/bin/OgreMeshTool_d~`

			`You are now ready to export. Open your model or create one, then do ~File -> Export -> Ogre3D~. See the following section for settings. /Note:/ I will be making command-line driven auto-exporting to reduce these manual steps.`
			`** OGRE Export Settings`
			`- Don't export materials. These are v1 materials as far as I know, which don't work with Ogre 2`
			`- Don't export scene. I don't use these files`
			`- Ensure mesh export version is set to ~v2~`
			`** Converting ~.mesh.xml~ to ~.mesh~`
			`You shouldn't need to do this step if you set ~OGRETOOLS_XML_CONVERTER~, but in case blender2ogre didn't recognize it, here's how I worked around it:`
Load meshes and create nodes separately 2 years ago
			`#+BEGIN_SRC sh`
Added blender2ogre and mesh pipeline instructions 2 years ago			`cd Dependencies/ogre-next/build/Debug/bin`
			`./OgreMeshTool_d -e -O puqs ../../../../../test/data/Models/Suzanne.mesh.xml`
Load meshes and create nodes separately 2 years ago			`#+END_SRC`
Added blender2ogre and mesh pipeline instructions 2 years ago
			`Run this after you've made an attempted export from the Blender OGRE plugin.`