townforge/Urho3D
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Use CMAKE_INSTALL_PREFIX for all as Windows does not support DESTDIR.

Browse Source
This commit is contained in:
Yao Wei Tjong 姚伟忠 2021-07-10 18:24:27 +08:00
parent 733957e3a9
commit 638247e648
No known key found for this signature in database
GPG Key ID: 0296FF46D1EE7308
6 changed files with 65 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
.github/workflows/main.yml vendored
View File

@ -139,7 +139,7 @@ jobs:
rm -rf build/cache/.m2
find build/cache/.gradle -newer build/cache/.gradle/mark -type d |xargs rm -rf
else
rm -rf build/cache/{stage,projects}
rm -rf build/cache/{.urho3d,projects}
fi
if: matrix.platform != 'linux-clang-tidy' && matrix.platform != 'linux-clang-format'
- name: Package
@ -209,20 +209,20 @@ jobs:
- name: Documentation
run: rake doc
- name: Scaffolding - install
run: rake install[~/stage]
run: rake install
- name: Scaffolding - new
run: rake new
- name: Scaffolding - build
run: |
cd ~/projects/UrhoApp
rake URHO3D_HOME=~/stage/usr/local
rake
- name: Scaffolding - test
run: |
cd ~/projects/UrhoApp
rake test
if: matrix.platform == 'macOS'
- name: Scaffolding - cleanup
run: rm -rf ~/{stage,projects}
run: rm -rf ~/{.urho3d,projects}
- name: Package
run: rake package
if: github.event_name == 'push'
@ -287,7 +287,7 @@ jobs:
rake test
if: matrix.graphics-api != 'OpenGL'
- name: Scaffolding - cleanup
run: rm -r -fo $env:ProgramFiles/Urho3D, ~/Projects
run: rm -r -fo ~/.urho3d, ~/Projects
- name: Package
run: rake package
if: github.event_name == 'push'

32
rakefile
View File

@ -31,11 +31,15 @@ task :cmake => [:init] do
end
end
next if ENV['PLATFORM'] == 'android' || (Dir.exists?(build_tree) and not ARGV.include?('cmake'))
if ENV['CMAKE_INSTALL_PREFIX'] == 'system'
ENV.delete('CMAKE_INSTALL_PREFIX')
elsif !ENV['CMAKE_INSTALL_PREFIX']
ENV['CMAKE_INSTALL_PREFIX'] = urho3d_install_dir
end
if ENV['URHO3D_HOME'] == 'system'
delete('URHO3D_HOME')
elsif !ENV['URHO3D_HOME'] && (dockerized? || !ENV['OS'])
candidate = "#{staged_install_dir}/usr/local"
ENV['URHO3D_HOME'] = candidate if (dockerized? || Dir.exists?(candidate))
ENV.delete('URHO3D_HOME')
elsif !ENV['URHO3D_HOME']
ENV['URHO3D_HOME'] = urho3d_install_dir if Dir.exists?(urho3d_install_dir)
end
script = "script/cmake_#{ENV['GENERATOR']}#{ENV['OS'] ? '.bat' : '.sh'}"
build_options = /linux|macOS|win/ =~ ENV['PLATFORM'] ? '' : "-D #{ENV['PLATFORM'].upcase}=1"
@ -105,14 +109,12 @@ task :doc => [:init] do
end
desc 'Install the software'
task :install, [:prefix] => [:init] do |_, args|
task :install, [:dest_dir] => [:init] do |_, args|
if ENV['PLATFORM'] == 'android'
Rake::Task[:gradle].invoke('publishToMavenLocal')
next
elsif dockerized? || !root?
args.with_defaults(:prefix => staged_install_dir)
end
wrapper = args[:prefix] && !ENV['OS'] ? "DESTDIR=#{verify_path(args[:prefix], true)}" : ''
wrapper = args[:dest_dir] && !ENV['OS'] ? "DESTDIR=#{verify_path(args[:dest_dir], true)}" : ''
system build_target('install', wrapper) or abort
end
@ -336,7 +338,7 @@ def build_host
end
def build_tree
ENV['BUILD_TREE'] || "build/#{dockerized? ? 'dockerized-' : ''}#{ENV['PLATFORM'].downcase}#{ENV['CC'] ? "-#{ENV['CC']}" : ''}"
ENV['BUILD_TREE'] || "build/#{dockerized? ? 'dockerized-' : ''}#{default_path}"
end
def build_config
@ -347,6 +349,10 @@ def build_target(tgt, wrapper = '')
%Q{#{wrapper} cmake --build "#{build_tree}" #{build_config} #{tgt ? "--target #{tgt}" : ''}}
end
def default_path
"#{ENV['PLATFORM'].downcase}#{ENV['CC'] ? "-#{ENV['CC']}" : ''}#{ENV['GENERATOR'] ? "-#{ENV['GENERATOR']}" : ''}"
end
def dockerized?
File.exists?('/entrypoint.sh')
end
@ -355,12 +361,8 @@ def lint_err_file
'build/clang-tidy.out'
end
def root?
!ENV['OS'] && Process.uid == 0
end
def staged_install_dir
File.expand_path("~/stage/#{ENV['PLATFORM'].downcase}#{ENV['CC'] ? "-#{ENV['CC']}" : ''}")
def urho3d_install_dir
"#{Dir.home}/.urho3d/install/#{default_path}"
end
def verify_path(path, auto_create = false)

19
website/docs/getting-started/create-urhoapp.mdx
View File

@ -185,7 +185,9 @@ Do not update the Android Gradle Plugin when being prompted, unless you know wha
<div className={clsx('textBlock', styles.fixedHeight)}>
- Choose "Open" to open the new project.
- In the "Open Project Wizard" window, enter the optional build options in the "CMake options" field or just leave it empty for now to use the default options as provided by Urho3D build scripts. If you are using Linux host machine, enter `URHO3D_HOME=~/stage/linux/usr/local` or `URHO3D_HOME=~/stage/linux-clang/usr/local CC=clang CXX=clang++` in the "Environment" field; or leave it empty when you are using Windows host machine.
- In the "Open Project Wizard" or in the "CMake Settings", set the `URHO3D_HOME` accordingly in the "CMake options" field, e.g.:
- `~/.urho3d/install/linux` when targeting Linux platform with GCC
- `%USERPROFILE%\.urho3d\install\win` when targeting Windows platform with MSVC
- Select "UrhoApp" from the "Select Run/Debug Configuration" drop down list and press "Ctrl+F9" to build the UrhoApp.
- To run the UrhoApp, press "Shift+F10".
@ -196,8 +198,7 @@ Do not update the Android Gradle Plugin when being prompted, unless you know wha
<div className={clsx('textBlock', styles.fixedHeight)}>
- Generate a build tree using CMake's Code::Blocks generator. One way to do it is by using rake task, like so:
`BUILD_TREE=build/linux-codeblocks GENERATOR=codeblocks rake cmake`
- Generate a build tree using CMake's Code::Blocks generator. One way to do it is by using rake task, like so: `GENERATOR=codeblocks rake cmake`
- Open the "UrhoApp.cbp" Code::Blocks project file in the build tree. In the above case, the project file can be found in `build/linux-codeblocks/` directory.
- **// FIXME: Please submit PR to complete the steps.**
@ -208,8 +209,7 @@ Do not update the Android Gradle Plugin when being prompted, unless you know wha
<div className={clsx('textBlock', styles.fixedHeight)}>
- Generate a build tree using CMake's CodeLite generator. One way to do it is by using rake task, like so:
`BUILD_TREE=build/linux-codelite GENERATOR=codelite rake cmake`
- Generate a build tree using CMake's CodeLite generator. One way to do it is by using rake task, like so: `GENERATOR=codelite rake cmake`
- Open the "UrhoApp.workspace" CodeLite workspace file in the build tree. In the above case, the workspace file can be found in `build/linux-codelite/` directory.
- **// FIXME: Please submit PR to complete the steps.**
@ -237,7 +237,13 @@ Do not update the Android Gradle Plugin when being prompted, unless you know wha
<div className={clsx('textBlock', styles.fixedHeight)}>
- **// FIXME: Please submit PR to complete the install steps.**
- Choose "Open a project or solution" to open the new project.
- After CMake initial build tree is generated, open the "CMake Settings for UrhoApp" under the "Project" menu, then in the "CMake variables and cache" section:
- Disable the `URHO3D_PCH` build option
- Set the `URHO3D_HOME` to `%USERPROFILE%\.urho3d\install\win`
- Save the above changes to allow CMake to reconfigure the build tree.
- Double click the "Folder View" in the "Solution Explorer", then select the "UrhoApp_d.exe" from the "Select Startup Item" drop down list and press "Ctrl+B" to build the UrhoApp.
- To run the UrhoApp, press "Ctrl+F5".
</div>
@ -251,7 +257,6 @@ Do not update the Android Gradle Plugin when being prompted, unless you know wha
- `PLATFORM=iOS rake cmake` for targeting iOS
- `PLATFORM=tvOS rake cmake` for targeting tvOS
- Open the "UrhoApp.xcodeproj" Xcode project file in the build tree. In the above case, the project file can be found in "build/macos", "build/ios", and "build/tvos", respectively.
- **// FIXME: Please submit PR to configure the <code>URHO3D_HOME=~/stage/<em>&lt;platform&gt;</em>/usr/local</code> environment variable before building the UrhoApp.**
- Select "UrhoApp" from the list of targets and press "⌘+B" to build the UrhoApp.
- To run the UrhoApp, press "⌘+R".

4
website/docs/getting-started/getting-started.module.scss
View File

@ -2,7 +2,7 @@
div {
> div > div > div > div > div, .fixedHeight {
.dbeInstall + & {
min-height: 164px;
min-height: 120px;
}
.dbeBuildUrhoApp + & {
@ -22,7 +22,7 @@ div {
}
.ideUrhoApp + & {
min-height: 276px;
min-height: 302px;
}
}
}

25
website/docs/getting-started/installation.mdx
View File

@ -189,7 +189,7 @@ This is the reason Dockerized Build Environment is fast.
### Using CLI {#install-urho3d-library-using-cli}
Clone the Urho3D project from the main branch, change directory to its project root, and execute **only one of the following commands** to install the library for your desired target platform. For simplicity's sake, this section provides instruction to install the Urho3D library into a **staged install** location under user's home directory that does not require superuser privilege. However, on Windows host there is no concept of staged install, so the library can only be installed to the system-wide installation location which requires superuser privilege. No worry as most Windows users have such privilege by default. Unfortunately, it would prevent both VS version and MinGW version of the library installed at the same time though. Unless specified otherwise, the default staged install location is <code>~/stage/<em>&lt;platform&gt;</em>/</code>. For example, on Linux platform with GCC it is `~/stage/linux/`. For Clang on Linux platform it is `~/stage/linux-clang/` to prevent clash with GCC. For Android platform, it is installed in `~/.m2/repository/` as AAR in Maven format.
Clone the Urho3D project from the main branch, change directory to its project root, and execute **only one of the following commands** to install the library for your desired target platform. For simplicity's sake, this section provides instruction that install the Urho3D library into a default install location under user's home directory that does not require superuser privilege. Unless specified otherwise, the default install location is <code>~/.urho3d/install/<em>&lt;platform&gt;</em>/</code>. For example, on Linux platform with GCC it is `~/.urho3d/install/linux/`. For Clang on Linux platform it is `~/.urho3d/install/linux-clang/` to prevent clash with GCC. For Android platform, it is installed in `~/.m2/repository/` as AAR in Maven format.
:::caution
@ -301,7 +301,7 @@ MINGW_PREFIX=? PLATFORM=mingw rake build install
### Using IDE {#install-urho3d-library-using-ide}
The Urho3D project can be opened directly in the IDE that supports CMake or Gradle build system, like **Android Studio**, **CLion**, **IntelliJ IDEA**, and **Visual Studio**. For other IDEs, like Xcode, use CMake to generate the initial build tree first. This section tries to cover a few of the IDEs available in the market. The steps outlined here should be easily adaptable for other IDEs.
The Urho3D project can be opened directly in the IDE that supports CMake or Gradle build system, like **Android Studio**, **CLion**, **IntelliJ IDEA**, and **Visual Studio**. For other IDEs, like **Xcode**, use CMake to generate the initial build tree first. This section tries to cover a few of the IDEs available in the market. The steps outlined here should be easily adaptable for other IDEs.
<Tabs
className={styles.ideInstall}
@ -340,7 +340,9 @@ Do not update the Android Gradle Plugin when being prompted, unless you know wha
<div className={clsx('textBlock', styles.fixedHeight)}>
- Choose "Open" or "Get from VCS" if you haven't cloned the Urho3D project yet.
- In the "Open Project Wizard" window, enter the Urho3D build options in the "CMake options" field or just leave it empty for now to use the default options as provided by Urho3D build scripts. If you are using Linux host machine then remember to enter `DESTDIR=~/stage/linux` or `DESTDIR=~/stage/linux-clang CC=clang CXX=clang++` in the "Environment" field for staged install.
- In the "Open Project Wizard" or in the "CMake Settings", set the `CMAKE_INSTALL_PREFIX` accordingly in the "CMake options" field, e.g.:
- `~/.urho3d/install/linux` when targeting Linux platform with GCC
- `%USERPROFILE%\.urho3d\install\win` when targeting Windows platform with MSVC
- Select "01_HelloWorld" or any other samples from the "Select Run/Debug Configuration" drop down list and press "Ctrl+F9" to build the sample app. This should build the Urho3D library as well.
- To run the sample app, press "Shift+F10".
- To install the Urho3D library for later use, run "Install" under the "Build" menu.
@ -352,8 +354,7 @@ Do not update the Android Gradle Plugin when being prompted, unless you know wha
<div className={clsx('textBlock', styles.fixedHeight)}>
- Generate a build tree using CMake's Code::Blocks generator. One way to do it is by using rake task, like so:
`BUILD_TREE=build/linux-codeblocks GENERATOR=codeblocks rake cmake`
- Generate a build tree using CMake's Code::Blocks generator. One way to do it is by using rake task, like so: `GENERATOR=codeblocks rake cmake`.
- Open the "Urho3D.cbp" Code::Blocks project file in the build tree. In the above case, the project file can be found in `build/linux-codeblocks/` directory.
- **// FIXME: Please submit PR to complete the install steps.**
@ -364,8 +365,7 @@ Do not update the Android Gradle Plugin when being prompted, unless you know wha
<div className={clsx('textBlock', styles.fixedHeight)}>
- Generate a build tree using CMake's CodeLite generator. One way to do it is by using rake task, like so:
`BUILD_TREE=build/linux-codelite GENERATOR=codelite rake cmake`
- Generate a build tree using CMake's CodeLite generator. One way to do it is by using rake task, like so: `GENERATOR=codelite rake cmake`
- Open the "Urho3D.workspace" CodeLite workspace file in the build tree. In the above case, the workspace file can be found in `build/linux-codelite/` directory.
- **// FIXME: Please submit PR to complete the install steps.**
@ -394,7 +394,14 @@ Do not update the Android Gradle Plugin when being prompted, unless you know wha
<div className={clsx('textBlock', styles.fixedHeight)}>
- **// FIXME: Please submit PR to complete the install steps.**
- Choose "Open a project or solution" or "Clone a repository" if you haven't clone the Urho3D project yet.
- After CMake initial build tree is generated, open the "CMake Settings for Urho3D" under the "Project" menu, then in the "CMake variables and cache" section:
- Disable the `URHO3D_PCH` build option
- Set the `CMAKE_INSTALL_PREFIX` to `%USERPROFILE%\.urho3d\install\win`
- Save the above changes to allow CMake to reconfigure the build tree.
- Double click the "Folder View" in the "Solution Explorer", then select the "01_HelloWorld_d.exe" from the "Select Startup Item" drop down list and press "Ctrl+B" to build the sample app. This should build the Urho3D library as well.
- To run the sample app, press "Ctrl+F5".
- To install the Urho3D library for later use, run "Install Urho3D" under the "Build" menu.
</div>
@ -410,7 +417,7 @@ Do not update the Android Gradle Plugin when being prompted, unless you know wha
- Open the "Urho3D.xcodeproj" Xcode project file in the build tree. In the above case, the project file can be found in "build/macos", "build/ios", and "build/tvos", respectively.
- Select "01_HelloWorld" or any other samples from the list of targets and press "⌘+B" to build the sample app. This should build the Urho3D library as well.
- To run the sample app, press "⌘+R".
- **// FIXME: Please submit PR to complete the install steps using staged install.**
- Select "Install" from the list of targets and press "⌘+B" to actually install the Urho3D library for later use.
</div>

38
website/docs/getting-started/quick-start.mdx
View File

@ -33,7 +33,7 @@ Windows host system requires WSL2.
## Install Urho3D Library with DBE
Clone the Urho3D project from the main branch, change directory to its project root, and execute the following commands to install the library for your desired target platform. Except for Android platform, which uses `~/.m2/repository/`, the default install location is: <code>~/stage/<em>&lt;platform&gt;</em>/</code>. The "~" here refers to home directory mounted from a docker volume and as such it is persistent in between docker runs.
Clone the Urho3D project from the main branch, change directory to its project root, and execute the following commands to install the library for your desired target platform. Except for Android platform, which uses `~/.m2/repository/`, the default install location is: <code>~/.urho3d/install/<em>&lt;platform&gt;</em>/</code>. The "~" here refers to home directory mounted from a docker volume and as such it is persistent in between docker runs.
<Tabs
className={styles.dbeInstall}
@ -54,10 +54,8 @@ Clone the Urho3D project from the main branch, change directory to its project r
```bash
git clone https://github.com/urho3d/Urho3D.git
cd Urho3D
# Build Urho3D library
script/dockerized.sh android
# Install Urho3D library to Maven local repository
script/dockerized.sh android rake install
script/dockerized.sh android rake build install
```
</TabItem>
@ -72,10 +70,8 @@ script/dockerized.sh android rake install
```bash
git clone https://github.com/urho3d/Urho3D.git
cd Urho3D
# Build Urho3D library, substitute '?' accordingly
ARM_ABI_FLAGS=? script/dockerized.sh arm
# Install Urho3D library to a local stage directory
script/dockerized.sh arm rake install
# Install Urho3D library to a default install location, substitute '?' accordingly
ARM_ABI_FLAGS=? script/dockerized.sh arm rake build install
```
</TabItem>
@ -84,10 +80,8 @@ script/dockerized.sh arm rake install
```bash
git clone https://github.com/urho3d/Urho3D.git
cd Urho3D
# Build Urho3D library
script/dockerized.sh linux
# Install Urho3D library to a local stage directory
script/dockerized.sh linux rake install
# Install Urho3D library to a default install location
script/dockerized.sh linux rake build install
```
</TabItem>
@ -96,10 +90,8 @@ script/dockerized.sh linux rake install
```bash
git clone https://github.com/urho3d/Urho3D.git
cd Urho3D
# Build Urho3D library, modify the "RPI_ABI" build option accordingly
RPI_ABI=RPI4 script/dockerized.sh rpi
# Install Urho3D library to a local stage directory
script/dockerized.sh rpi rake install
# Install Urho3D library to a default install location, modify the "RPI_ABI" build option accordingly
RPI_ABI=RPI4 script/dockerized.sh rpi rake build install
```
</TabItem>
@ -108,10 +100,8 @@ script/dockerized.sh rpi rake install
```bash
git clone https://github.com/urho3d/Urho3D.git
cd Urho3D
# Build Urho3D library
script/dockerized.sh web
# Install Urho3D library to a local stage directory
script/dockerized.sh web rake install
# Install Urho3D library to a default install location
script/dockerized.sh web rake build install
```
</TabItem>
@ -120,10 +110,8 @@ script/dockerized.sh web rake install
```bash
git clone https://github.com/urho3d/Urho3D.git
cd Urho3D
# Build Urho3D library
script/dockerized.sh mingw
# Install Urho3D library to a local stage directory
script/dockerized.sh mingw rake install
# Install Urho3D library to a default install location
script/dockerized.sh mingw rake build install
```
</TabItem>
@ -225,7 +213,7 @@ script/dockerized.sh mingw
:::note
This is not a copy/paste error. You can build your new UrhoApp exactly the same way as the Urho3D project itself!
This is not a copy/paste error. You can build your new UrhoApp exactly the same way as the Urho3D project itself! By default, DBE runs `rake build` command.
:::