rive-app / rive-app/rive-runtime
Incomplete instructions and build issues
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 1.2k
- Forks
- 121
- PR merge metrics
- No merged PRs in 30d
Description
Trying to compile following the README.md, I can into the following problems:
- The
git clonecommand shows the use of the SSH protocol. This results in agit@github.com: permission denied (publickey)error for me. Usinggit clone https://github.com/rive-app/rive-rendererworks. - Using
git clone --resurve-submodules https://...fails with the same error. Changing.gitmodulestourl = https://github.com/rive-app/rive-cpp.gitand then runninggit submodule update --init --recursivehelped. - The Build GLFW step requires CMake. A standard Xcode installation does not come with a bundled CMake (at least not in v12.4), it needs to be installed separately and added to the
PATHto avoid./make_glfw.sh: line 24: cmake: command not found - The Call Premake & Build step doesn't mention at what path to run the commands. It can be deduced that it must be the
rive-rendererfolder, though. - Running the
... premake5 gmake2 ...command fails withError: ...renderer/submodules/rive-cpp/build/rive_build_config.lua:323: attempts to concatenate a nil value (global 'iphoneos_sysroot'). I'm not familiar enough with Lua/premake but it seems strange that the code where the concatenation happens is executed despitefilter({ 'system:ios', ... }). I worked around the problem by addingor ''inbuild/rive_build_config.luawhere the sysroot variables are set. path_fiddleis in therive_rendererfolder, not inout/release.- The
metalutility is required, which means you need a full Xcode installation, not only the Command Line Tools for Xcode. I can't install Xcode on the device in question and I'm not even sure if the latest available Xcode for the outdated platform includes themetalutility so I cannot check for more issues with the compilation.
The system I tried the above on was a MacBook Air from 2014 running Catalina, Intel CPU. This may not be a representative device but I think all of the above papercuts equally apply to newer devices and OS versions.
On Windows, the first two bullet points apply as well. Other issues I encountered:
- To run
make make_glfw.sh, you can use Git Bash. But it doesn't have thetouchcommand which is used inrenderer/shaders/Makefile. I substituted@touch $(MINIFY_STAMP)withecho "" > $(MINIFY_STAMP). - The premake command needs to be different to use the Microsoft toolchain. The environment variable needs to be set differently - I used
$Env:PREMAKE_PATH="C:/<some-path>/submodules/rive-cpp/build"in PowerShell. The generator needs to be set according to the installed Visual Studio version, e.g.premake5 vs2019 --toolset msc ...instead ofpremake gmake2 .... - There were issues with the
path_fiddletarget that I worked around by setting the C++ standard to C++20 and disabling to treat warnings as errors (/WX-) in Visual Studio for therive.sln. Usingvcvars64.bat, everything compiled successfully withmsbuild .\rive.slnand thepath_fiddle.exeworks.
I'd appreciate it if you could share the commands you use to compile for Windows. Do you use MinGW?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review README.md and the referenced .gitmodules, make_glfw.sh, renderer/shaders/Makefile, and build/rive_build_config.lua. Reproduce the documented macOS and Windows build steps, then update the instructions with prerequisites, paths, commands, and platform-specific workarounds. Done means a newcomer can follow the README and reach a successful build on each supported platform.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cmake, cpp, git, powershell, shell
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100