techmania-docs

Documentations of TECHMANIA projects, hosted in a repo so they can be localized.

---

Project maintained by techmania-team Hosted on GitHub Pages — Theme by mattgraham

Applies to version: 2.3

This page explains the files and folders important to the game, and how the game handles zip archives.

TL;DR

• Drop zips into the Tracks or Setlists folder next to TECHMANIA.exe, and the game will automatically extract them.
• You can create subfolders inside Tracks and Setlists to organize them too.

Folders

The following 6 folders are of significance:

• Tracks next to TECHMANIA.exe
  • This is the root folder of all tracks, and the “Select Track” screen will never go above this folder.
  • For any subfolder in Tracks, the game will look for a track.tech file in it. If found, the game will treat this folder as a track; otherwise the subfolder itself will show up in “Select Track”, allowing the player to navigate inside, regardless of content.
  • It is allowed to place files (other than track.tech) in subfolders of a track folder.
  • The content of track.tech is an object of type Track, serialized as JSON.
  • By default, a track folder is named <Artist> - <Title> - <creation time>, but the name does not matter. The game reads in artist and title from track.tech, not the folder’s name.
  • If the game finds an image file named eyecatch.jpg or eyecatch.png in a subfolder, that image will show up as the subfolder’s eyecatch, instead of the default folder icon.
  • There is an option to use a custom folder as the tracks folder.
• Setlists next to TECHMANIA.exe
  • Most points in tracks apply, but for setlists.
  • The setlist file is named setlist.tech, of type Setlist (link to be added later), serialized as JSON.
  • By default, a setlist folder is named <Title> - <creation time>.
• Skins next to TECHMANIA.exe
  • Contains subfolders corresponding to types of skins. Refer to Skins for details.
  • There is an option to use a custom folder as the skins folder.
• Themes next to TECHMANIA.exe
  • Contains themes.
  • There is an option to use a custom folder as the themes folder.
• TECHMANIA in documents folder
  • Stores game options (in options.json), custom ruleset (in ruleset.json), and records (in records.json). Refer to Rulesets for details on the custom ruleset. Refer to Records for details on records.
• C:\Users\<username>\AppData\LocalLow\TECHMANIA Team\TECHMANIA
  • The game writes logs to Player.log here, which may be useful for troubleshooting.
  • On 0.9 and before, the logs were at C:\Users\<username>\AppData\LocalLow\DJ Hitori\TECHMANIA.

Streaming assets on mobile

Players on PC can ignore this section.

To simplify the installation process of mobile builds, we include the official tracks, setlists and skins in a StreamingAssets folder, which is a special folder inside the project. These are automatically copied to an OS-specific location during installation.

The game contains special logic to combine the regular Tracks folder and tracks in the streaming assets, so the select track screen shows content from both. The same goes for setlists, skins and themes.

Refer to Unity documentation on Streaming Assets.

Zip archives

When the select track or select setlist screen scans a folder, it will look for and extract all zip archives it encounters. Please note the following:

• If the track.tech / setlist.tech file in a zip is inside a folder, TECHMANIA will extract the zip archive to the folder it’s in.
• If the track.tech / setlist.tech file in a zip is not inside a folder, TECHMANIA will create a new folder for the track or setlist, then extract the zip archive into it.
• If any error occurred during extraction, the game will log an error (refer to Folders section) and silently move on to the next archive.
• Extracted files will overwrite existing files if they have the same name.
• Successfully extracted archives will be deleted.