How to use game assets package - TheXTech/TheXTech GitHub Wiki

Every game assets package is a complete set of game resources that are required to run the game.

This instruction has been written for players who want to play other games rather than official releases with pre-included assets. Every assets package is the 7z archive which contains a complete set of game resources such as default graphics, music, sounds, some settings, pre-included episodes, etc. Unlike pre-packed games, they are platform-independent and can be used on any operating system that has the native build of the TheXTech engine.

Windows, Linux, FreeBSD/OpenBSD/NetBSD, Haiku

Using the plan executable package that you can download at the Official TheXTech page or taken from the local build directory (if you compiled your own copy of the engine). On Windows and Linux, etc. operating systems it's the simplest way to run the game with an assets package. You could mix the executable package with the assets package and run the executable to start the game. Alternatively, you can run the game with the "-c /path/to/assets" command-line argument to select the assets directory from a different place.

macOS

Using the app template on macOS. Unlike other desktop platforms, for macOS, there is an app bundle available that contains no assets inside. It's called "app template". How to use it?

  • First off, unpack the app template at any convenient directory.
  • Then, open the directory inside the bundle: "TheXTech.app/Content/Resources/assets" and put the entire assets archive content into it.
  • As a final step, modify the "Content/Info.plist" file at any text editor (don't use default TextEditor application, it damages the file by enforced auto-replacements! Suggested to use VS-Code, Xcode, Atom, etc.) and change the "CFBundeName" value into the game title, for example, "My Super-Pooper game" (this title will be shown at the task manager!).
  • Now, try to launch the application. Be aware of the GateKeeper challenge that affects any unsigned bundles.

Android

Playing the game on Android. The engine itself is the standalone APK that gets installed globally. To play the game from assets, you should put an archive of assets on your device and use any available archivers (for example, built-in archiver of Total Commander) to extract the assets archive into a convenient directory (Suggested to put at phone storage for the best accessibility, but could work from the SD card too with a note that all game saves will be written at application's directory that is hard to access by normal user). And then, use the settings menu to select the directory that contains your unpacked assets.

Emscripten

Unlike other platforms, to get the specific game to work on Emscripten, you are required to build your own copy of the game by specifying the path to the assets directory to pre-include with the build. There is no other way to add custom files to the web version of the game.

PS-Vita

WIP