Add the following code to your project's shard.yml under:
to use in production
- OR -
development_dependencies to use in development
See the example.
That said, crystal-imgui-sfml does take over some parts of the installation process from crystal-imgui.
First, install SFML.
Then add to your project's shard.yml file:
dependencies: crsfml: github: oprypin/crsfml imgui: github: oprypin/crystal-imgui imgui-sfml: github: oprypin/crystal-imgui-sfml
Resolve dependencies with Shards:
During installation this will invoke
make to build the C++ wrappers as object files. SFML headers are expected to be available in the default include path.
Try the example from inside the folder of crystal-imgui-sfml:
crystal build examples/simple.cr
Although building the example automatically added the
libcimgui.so library (bundled with the project) to the search path, running it will require that addition to be done manually:
export LD_LIBRARY_PATH="$(pwd)" ./example
For your own project, crystal-imgui-sfml will be in a subdirectory, so adjust this accordingly:
export LD_LIBRARY_PATH="$(pwd)/lib/imgui-sfml" printf 'require "crsfml"\nrequire "imgui"\nrequire "imgui-sfml"\n' >> my_project.cr crystal run my_project.cr
If SFML's headers and libraries are not in a path where the compiler would look by default, additional steps are needed.
Before building the extensions (
make) you need to configure the include path:
export CXXFLAGS="-I/full/path/to/sfml/include" export LIBRARY_PATH="/full/path/to/sfml/lib" make
It's also possible to use crystal-imgui-sfml outside of Shards, as with any library. One option is to directly create a symbolic link to crystal-imgui-sfml in your project's lib folder.
mkdir lib ln -s /full/path/to/crsfml lib/crsfml ln -s /full/path/to/crystal-imgui lib/imgui ln -s /full/path/to/crystal-imgui-sfml lib/imgui-sfml
Note, though, that the C bindings inside the crystal-imgui-sfml directory must be additionally built using
crystal-imgui-sfml is licensed under the terms and conditions of the MIT license.