shiva
1.0
0.91.0last version
1.0
0.91.0last version
  • Shiva Documentation
  • Shiva
    • Changelog
    • FAQ
    • Gallery
    • Installation
    • Modules
      • shiva::dll
      • shiva::ecs
      • shiva::entt
      • shiva::enums
      • shiva::error
      • shiva::event
      • shiva::filesystem
      • shiva::input
      • shiva::lua
      • shiva::meta
      • shiva::pp
      • shiva::pyscripting
      • shiva::range
      • shiva::reflection
      • shiva::scenes
      • shiva::sfml
        • shiva::system-sfml-animation
        • shiva::system-sfml-graphics
        • shiva::system-sfml-inputs
        • shiva::system-sfml-resources
      • shiva::spdlog
      • shiva::stacktrace
      • shiva::timer
      • shiva::world
    • Roadmap
    • Scripting
      • Lua
      • Python
    • Tutorial
      • Quick'start
      • How to create/build/install a system plugin
      • How to create a scripted system
      • How to create a project through the CLI tools and build it
Powered by GitBook
On this page
  • Using the CLI
  • Prerequisites
  • Create a project and build it
  • If you use VCPKG:
  • Run the binary
  1. Shiva
  2. Tutorial

How to create a project through the CLI tools and build it

Using the CLI

Prerequisites

  • You should install shiva with vcpkg or with a regular installation before following this tutorial.

  • VCPKG_ROOT env variable set to the root directory of your installation of VCPKG

  • Python 3.6

Create a project and build it

If you use VCPKG:

Windows

Open powershell and type: 

cd "$($env:VCPKG_ROOT)/installed/x64-Windows/share/shiva/tools"
##! syntax
./cli_shiva.py --project_name project_name --project_renderer renderer_name --output_directory path
##! for example
./cli_shiva.py --project_name bomberman --project_renderer sfml --output_directory D:/game_project/bomberman

cd D:/game_project/bomberman
mkdir build
cd build
##! Replace Release by Debug if you prefer Debug
cmake -G "Visual Studio 15 2017 Win64" -DCMAKE_TOOLCHAIN_FILE="$($env:VCPKG_ROOT)/scripts/buildsystems/vcpkg.cmake" -DCMAKE_BUILD_TYPE=Release ..
cmake --build . --config Release

Linux or OSX

Open bash and type:

##! Linux
cd $VCPKG_ROOT/installed/x64-linux/share/shiva/tools

##! OSX
cd $VCPKG_ROOT/installed/x64-osx/share/shiva/tools

##! syntax
./cli_shiva.py --project_name project_name --project_renderer renderer_name --output_directory path
##! for example
./cli_shiva.py --project_name bomberman --project_renderer sfml --output_directory ~/Documents/bomberman

cd ~/Documents/bomberman
mkdir build
cd build

##! Linux (Replace Release by Debug if you need)
cmake -DCMAKE_TOOLCHAIN_FILE=$VCPKG_ROOT/vcpkg/scripts/buildsystems/vcpkg.cmake -DCMAKE_BUILD_TYPE="Release" -DCMAKE_CXX_COMPILER=g++-8 -DCMAKE_C_COMPILER=gcc-8 ..

##! OSX (Replace Release by Debug if you need)
cmake -DCMAKE_TOOLCHAIN_FILE=$VCPKG_ROOT/vcpkg/scripts/buildsystems/vcpkg.cmake -DCMAKE_BUILD_TYPE="Release" -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_C_COMPILER=clang ..

make

Run the binary

cd bin 
./bomberman

You should see a window appear, you can leave with escape

This entire tutorial used the sfml rendering module, but when other module will be available you can replace sfml with what you want, Ogre, SDL2, Vulkan, bgfx

PreviousHow to create a scripted system

Last updated 6 years ago