Browse Source

Remove empty build directory. Upgrade antkeeper-source submodule. Update README

master
C. J. Howard 1 year ago
parent
commit
d6b4a52408
8 changed files with 26 additions and 37 deletions
  1. +1
    -0
      .gitignore
  2. +2
    -2
      CMakeLists.txt
  3. +22
    -26
      README.md
  4. +0
    -2
      build/linux32/.gitignore
  5. +0
    -2
      build/linux64/.gitignore
  6. +0
    -2
      build/win32/.gitignore
  7. +0
    -2
      build/win64/.gitignore
  8. +1
    -1
      modules/antkeeper-source

+ 1
- 0
.gitignore View File

@ -1,2 +1,3 @@
bin bin
build
dist dist

+ 2
- 2
CMakeLists.txt View File

@ -3,7 +3,7 @@ if(${CMAKE_SOURCE_DIR} STREQUAL ${CMAKE_BINARY_DIR})
message(FATAL_ERROR "In-source builds prohibited. Call CMake from a build/<platform> directory.") message(FATAL_ERROR "In-source builds prohibited. Call CMake from a build/<platform> directory.")
endif() endif()
cmake_minimum_required(VERSION 3.25)
cmake_minimum_required(VERSION 3.28)
set(APPLICATION_NAME "Antkeeper") set(APPLICATION_NAME "Antkeeper")
set(APPLICATION_VERSION "0.0.1") set(APPLICATION_VERSION "0.0.1")
@ -52,7 +52,7 @@ else()
endif() endif()
# Options # Options
set(BLENDER "blender" CACHE FILEPATH "Path to Blender executable")
option(BLENDER "Path to Blender executable" "")
# Set compiler and linker flags # Set compiler and linker flags
if(MSVC) if(MSVC)

+ 22
- 26
README.md View File

@ -1,43 +1,35 @@
# Antkeeper Superbuild # Antkeeper Superbuild
This repository contains the superbuild system and all dependencies required to build Antkeeper.
This repository contains the build system and all dependencies required to build [Antkeeper](https://antkeeper.com/), a 3D ant colony simulation game.
## Download ## Download
Download the Antkeeper superbuild repository and all of its Git submodules:
Download the Antkeeper superbuild repository and its Git submodules (excluding `antkeeper-data`):
git clone --recursive https://github.com/antkeeper/antkeeper-superbuild.git
git -c submodule."modules/antkeeper-data".update=none clone --recursive https://github.com/antkeeper/antkeeper-superbuild.git .
> Note: The `antkeeper-data` submodule contains proprietary game data and is not publicly available. The game can be built without this submodule, but the game data is required to play Antkeeper. You can get a copy of the game data by purchasing Antkeeper at [antkeeper.com](https://antkeeper.com/).
> [!NOTE]
> The `antkeeper-data` submodule contains proprietary game data and is not publicly available. The game executable can be built without this submodule, but its data package is required to play Antkeeper. You can get a copy of the data package by purchasing Antkeeper at <https://antkeeper.com/>.
## Configuration & Building ## Configuration & Building
CMake is required to configure and build the application. Depending on the target platform, CMake should be invoked from one of the following directories:
### Windows
| Directory | Platform |
| :----------------------------- | :------------- |
| [build/linux32](build/linux32) | 32-bit Linux |
| [build/linux64](build/linux64) | 64-bit Linux |
| [build\win32](build/win32) | 32-bit Windows |
| [build\win64](build/win64) | 64-bit Windows |
Building for Windows requires CMake and Visual Studio Build Tools.
The following arguments may be passed to CMake during configuration:
Run the following commands in the `x64 Native Tools Command Prompt` to configure and build a 64-bit Windows release:
-DCMAKE_BUILD_TYPE // [Debug, Release]
cmake -B build\win64 -G "NMake Makefiles" -DCMAKE_BUILD_TYPE=Release
cmake --build build\win64 --config Release
### Linux ### Linux
Building for Linux requires CMake, GCC, G++, and GNU Make. Navigate to either the [build/linux32](build/linux32) or [build/linux64](build/linux64) directory and run the following commands:
cmake ../.. -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=...
cmake --build .
### Windows
Building for Linux requires CMake, GCC, G++, and GNU Make.
Building for Windows requires CMake and Visual Studio Build Tools. Additionally, [NSIS](http://nsis.sourceforge.net/) is required if you want to build a distributable installer program. In order to correctly build for your target architecture, you must use the `x86 Native Tools Command Prompt` or the `x64 Native Tools Command Prompt` for 32-bit and 64-bit applications, respectively. Then navigate to either the [build\win32](build/win32) or [build\win64](build/win64) directory and run the following commands:
Run the following commands to configure and build a 64-bit Linux release:
cmake ..\.. -G "NMake Makefiles" -DCMAKE_BUILD_TYPE=...
cmake --build .
cmake -B build/linux64 -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Release
cmake --build build/linux64 --config Release
## Running ## Running
@ -45,9 +37,13 @@ After building, a standalone version of the application will be located somewher
## Distribution ## Distribution
The built application can be packaged into a distributable format with the following command:
The built application can be packaged into a distributable format with the following commands:
cmake --build build\win64 --target dist
or
cmake --build . --target dist
cmake --build build/linux64 --target dist
The resulting package will be located in the `dist` directory. The resulting package will be located in the `dist` directory.
@ -55,11 +51,11 @@ The resulting package will be located in the `dist` directory.
If any changes have been made to the submodules, commit those first. Each submodule can then be updated to their latest commits with the following command: If any changes have been made to the submodules, commit those first. Each submodule can then be updated to their latest commits with the following command:
git submodule update --recursive --remote
git -c submodule."modules/antkeeper-data".update=none submodule update --recursive --remote
## License ## License
Antkeeper superbuild is licensed under the GNU General Public License, version 3. For more information, see [`LICENSE.md`](LICENSE.md).
Antkeeper superbuild is licensed under the GNU General Public License, version 3. For more information, see [LICENSE.md](./LICENSE.md).
### 3rd-Party Software ### 3rd-Party Software

+ 0
- 2
build/linux32/.gitignore View File

@ -1,2 +0,0 @@
*
!.gitignore

+ 0
- 2
build/linux64/.gitignore View File

@ -1,2 +0,0 @@
*
!.gitignore

+ 0
- 2
build/win32/.gitignore View File

@ -1,2 +0,0 @@
*
!.gitignore

+ 0
- 2
build/win64/.gitignore View File

@ -1,2 +0,0 @@
*
!.gitignore

+ 1
- 1
modules/antkeeper-source

@ -1 +1 @@
Subproject commit d5bb5887cc1705a80042c1f9b3b11cb188e0c99c
Subproject commit 628cbca31d424a95a53ded84d1164f8d7f2e85f2

Loading…
Cancel
Save