Skip to content

Commit

Permalink
Move binary assets out of git
Browse files Browse the repository at this point in the history
Fixes Revolutionary-Games#32

The res directory has been removed. The directories res/scripts and
res/ogre_cfg have been moved up into the root directory.

CMake now offers an option to set the asset directory and throws an
error if it doesn't exist or is empty.

Asset creators can now put their files in the "testing" subdirectory of
an installation to override any other resource files.

Move scripts up one directory

Remove binary assets from git

Add "testing" resource directory

The content of this directory overrides all other resource
directories.

Move res/ogre_cfg to ./ogre_cfg

Let's get rid of that res directory

Remove unused music file

Will be added to the asset repository later

Remove res directory

The Blender files have been moved to the asset repository

Fix SVN URL in CMake warning

Add username / password hint to CMake asset warning

Promote CMake asset warning to an error

In theory, users could build Thrive without assets, but it
wouldn't do them any good because there's no way they could
execute it.

Better README.md

Add simple explanation for Subversion art asset

Add dependency list for Linux developers

Attempt to fix links

Write out ftp link since GitHub seems to filter them
  • Loading branch information
bkloster committed Nov 22, 2013
1 parent da4ebce commit 83066c1
Show file tree
Hide file tree
Showing 61 changed files with 97 additions and 15,925 deletions.
10 changes: 6 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Standard stuff
Thumbs.db
*.obj
*.pdb
Expand All @@ -23,10 +24,8 @@ _ReSharper*/
[Tt]est[Rr]esult*
*.vssscc
$tf*/

# Do not ignore the following, some resources are stored in these folders in the res/dist/ tree
# [Bb]in
# [Dd]ebug*/
[Bb]in
[Dd]ebug*/

# Libraries
*.lib
Expand Down Expand Up @@ -72,3 +71,6 @@ nbproject/

# Vim swap files
*.swp

# Asset directory
assets/*
39 changes: 32 additions & 7 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,20 @@ SET(OGRE_SDK ""
CACHE STRING "Path to the Ogre SDK"
)

set(ASSET_DIRECTORY ${CMAKE_SOURCE_DIR}/assets
CACHE PATH "Path to assets"
)

if(NOT IS_DIRECTORY ${ASSET_DIRECTORY}/models)
message(FATAL_ERROR
"Could not find assets in ${ASSET_DIRECTORY}.
Please use Subversion to download the assets:
svn co http://91.250.119.121/scm/svn/thrive_assets/trunk ${ASSET_DIRECTORY}
If you do not have an account for the repository, use anonymous / anonymous for username and password.
"
)
endif()


###############
# CMake Setup #
Expand Down Expand Up @@ -276,41 +290,52 @@ install(EXPORT lua
# OGRE config and media

install(FILES
${CMAKE_SOURCE_DIR}/res/ogre_cfg/resources.cfg
${CMAKE_SOURCE_DIR}/ogre_cfg/resources.cfg
DESTINATION bin
)

install(FILES
${CMAKE_SOURCE_DIR}/res/ogre_cfg/plugins.cfg
${CMAKE_SOURCE_DIR}/ogre_cfg/plugins.cfg
DESTINATION bin
CONFIGURATIONS Release
)

install(FILES
${CMAKE_SOURCE_DIR}/res/ogre_cfg/plugins_d.cfg
${CMAKE_SOURCE_DIR}/ogre_cfg/plugins_d.cfg
DESTINATION bin
CONFIGURATIONS Debug
RENAME plugins.cfg
)

install(DIRECTORY ${CMAKE_SOURCE_DIR}/res/models
install(DIRECTORY ${ASSET_DIRECTORY}/models
DESTINATION ./
CONFIGURATIONS Release Debug
FILES_MATCHING
PATTERN "*.mesh"
PATTERN "*.mesh.xml"
)

install(DIRECTORY ${CMAKE_SOURCE_DIR}/res/materials
install(DIRECTORY ${ASSET_DIRECTORY}/materials
DESTINATION ./
CONFIGURATIONS Release Debug
FILES_MATCHING
PATTERN "*.jpg"
PATTERN "*.jpeg"
PATTERN "*.material"
PATTERN "*.png"
)

install(DIRECTORY
${CMAKE_SOURCE_DIR}/res/fonts
${ASSET_DIRECTORY}/fonts
DESTINATION ./
CONFIGURATIONS Release Debug
FILES_MATCHING
PATTERN "*.ttf"
PATTERN "*.fontdef"
)

install(DIRECTORY
${CMAKE_SOURCE_DIR}/res/scripts
${CMAKE_SOURCE_DIR}/scripts
DESTINATION ./
CONFIGURATIONS Release Debug
)
Expand Down
57 changes: 56 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,57 @@
Thrive
======
======

This is the code repository for Thrive. For more information, visit
http://www.revolutionarygames.com.


Getting Involved
----------------
Depending on what you want to contribute, you need to take different steps
to get your development environment set up.

### Script Authors
If you only want to modify the Lua scripts, you can just download a
precompiled package from our build server at ftp://91.250.119.121/jenkins.
After unpacking, you will find the scripts in the aptly named `scripts`
subdirectory.

Be sure to have a look at the [styleguide][styleguide],
both for guidelines on code formatting and git usage.

### C++ Programmers
To compile Thrive yourself, you will not only need to clone this git
repository, but also the Subversion [asset repository][asset_repository],
username and password both "anonymous". The best place to put the assets
is in your code repository's `assets` subdirectory. If, for whatever
reason, you want to check it out to another place, you will have to modify
the `ASSET_DIRECTORY` variable in the CMake setup. Offloading art assets
into Subversion was necessary due to size constraints for GitHub repositories.

Windows developers should follow the procedure outlined in the [mingw setup
guide]().

For the time being, Linux developers will have to manually set up their build
environment. The dependencies at the time of this writing are

* gcc 4.7 or newer
* boost 1.52
* Ogre 1.8
* Bullet 2.81
* OpenAL Soft 1.15.1

Be sure to have a look at the [styleguide][styleguide],
both for guidelines on code formatting and git usage.

### Modellers and Sound Engineers
To work on the art assets, you can download a precompiled package from our
build server at ftp://91.250.119.121/jenkins. After unpacking, create a
subdirectory `testing` and place your assets in there. If they are used
anywhere in the game, they will be picked up by Thrive.

More detailed instructions for contributing art assets will follow soon.


[asset_repository]: http://91.250.119.121/scm/svn/thrive_assets/trunk "Asset Repository"
[mingw]: http://www.github.com/Revolutionary-Games/Thrive/blob/master/mingw_setup/readme.txt "MinGW setup guide"
[styleguide]: http://www.github.com/Revolutionary-Games/Thrive/blob/master/doc/style_guide.dox "Styleguide"
12 changes: 0 additions & 12 deletions mingw_setup/readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -193,18 +193,6 @@ Once done, you can let CMake know about the toolchain like this:
cmake -DCMAKE_TOOLCHAIN_FILE=/opt/mingw-w64/cmake/toolchain.cmake $SRC_DIR


Linux - Native Build
====================

Coming soon. Although, if you would like to do this, you probably already
know how. A few quick pointers:

* Ogre is required, ideally version 1.8+. An older version from your package
manager might work, it might not.

* gcc 4.7 recommended


Troubleshooting
===============

Expand Down
File renamed without changes.
File renamed without changes.
4 changes: 3 additions & 1 deletion res/ogre_cfg/resources.cfg → ogre_cfg/resources.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@ FileSystem=../fonts
FileSystem=../models
FileSystem=../materials/
FileSystem=../materials/textures
FileSystem=../media/models

# Keep this last so it overrides everything before
FileSystem=../testing
2 changes: 0 additions & 2 deletions res/blender/.gitignore

This file was deleted.

Binary file removed res/blender/hex.blend
Binary file not shown.
Binary file removed res/blender/microbe.blend
Binary file not shown.
Binary file removed res/blender/molecule.blend
Binary file not shown.
Binary file removed res/dist/media/music/Thrive_Main.mp3
Binary file not shown.
7 changes: 0 additions & 7 deletions res/fonts/thrive.fontdef

This file was deleted.

Binary file removed res/fonts/thrive.ttf
Binary file not shown.
95 changes: 0 additions & 95 deletions res/materials/background.material

This file was deleted.

Loading

0 comments on commit 83066c1

Please sign in to comment.