Skip to content

Latest commit

 

History

History
239 lines (196 loc) · 14.9 KB

README.md

File metadata and controls

239 lines (196 loc) · 14.9 KB

Disclaimer: This fork is intended for personal use. These commits are published in case anyone is interested, and I might not be actively maintaining this (at least I will merge changes from the original repository from time to time).

Releases

Refer to the Releases section of the master branch.

Latest Versions

Changes

Note: Each list is sorted by the date published (newest first).

New Features

  • New Default Ruleset: Redefined
    • A ruleset with stricter timing, but a little wider note hitboxes overall.
      • Actually stricter towards Rainbow MAX.
      • Timing window values are defined based on frame duration of 60 FPS because of Unity's input polling behavior.
        • Judgement Frame Timing Array: [±1, ±3, ±5, ±8, ±11]
    • Designed for monitors with widescreen ratio (16:9).
    • This is put inside the build, so records can be saved with this ruleset, completely separated from others.
  • Sprite Sheet Property: randomOrientationSeed
    • VFX Skins Only
    • If Set, Randomly Rotates and Flips Each VFX Sprite Layer Instance
    • Possible Values: Any Positive Integer
      • If the same number is shared between different layers, they will be rotated / flipped by the same amount.
      • Default Value: -1 (Not Randomized)
  • Sprite Sheet Property: directionTracking
    • Note Skins Only
    • Possible Values: "none", "mirror", and "rotate"
      • "none": No note rotation or mirror.
      • "mirror": Mirror note depending on the scan direction it is in.
      • "rotate": Rotate note towards a type-specific target.
        • e.g. Rotate a Chain Head note towards its first Chain Node
    • Availability by Note Types...
      • Drag Note Head, Chain Note Head, Chain Node: All
      • Basic Note, Hold Note Head, Repeat Note Head, Repeat Note: "none" / "mirror"
      • Otherwise, directionTracking provides no effect.
    • This also makes non-circular note design possible.
  • Track Gain Metadata
    • TL;DR: A feature to make all tracks equally loud
    • A new input field called Gain in Editor > Track Setup > Metadata
      • Stores track-wide volume adjustment, in decibel.
        • Defaults to -6 dB.
      • Recommended approach for a proper gain value...
        • Get the full track (a.k.a. the one played in music player, not the game).
        • Measure per-track gain with ReplayGain.
          • Even better with target loudness of -16 dB (iTunes), Foobar2000 has this in Advanced Configuration.
    • Add an option to toggle per-track gain on or off
  • Base BGAs
    • In the Modifier Side Sheet, the "No Video" toggle has been changed into "Background Source" dropdown.
      • Possible Options...
        • Pattern BGA (No Video OFF)
        • Pattern Image (No Video ON)
        • Base BGA (One of the BGAs stored in the BGAs folder)
      • A few playback modes are provided, explained and can be set in Options.
      • In case there is no suitable video file for the chosen mode, fallback values are as follow...
        • Pattern BGA -> Base BGA -> Pattern Image
        • Pattern Image -> None (Black background, assuming the player requests minimum motion)
        • Base BGA -> Pattern BGA -> Pattern Image
    • Put video files with a supported format into the BGAs folder.
      • Now also supports custom location, the same as tracks and skins folders.
    • IMPORTANT: This will remove all track's "No Video" values inside per-track settings.
      • All other settings are still compatible with the official build.

Paths

  • Change Options, Ruleset, and Records JSON location to <Build Dir>/Configurations
    • This separates them from official ones, and other builds'.
  • Add an ability to use supported files inside track subfolder(s) Merged into the official build (1.0.2)
    • Those files are displayed, or stored into track.tech as a relative path separated by "/" (e.g. Notes/synth_001.ogg).

Audio

  • Add volume slider values in decibel after the percentage values
    • Only percentages are stored in options. Decibel values are just for display.
  • Change underlying volume config value type from integer to decimal (int -> float).
    • Allows finer volume adjustment.
  • Change volume slider scaling to the actual amplitude-to-decibel amplitude-square-to-decibel formula.
    • Update: Used squared amplitude to make the slider more linear, and closer to human perception.
  • New fever sound effect, made by me.
  • With "Auto Keysound" on, reroute keysound audio sources to the keysound mixer track Merged into the official build (1.0.2)
    • This keeps keysounds from using the music volume (from settings) instead of keysound volume.
  • Fix Scan Jump Playing Keysounds Right at the Start Twice Merged into the official build (1.0.2)
  • Pattern Editor: Fixed Keysound Off-By-One Errors Merged into the official build (1.0.2)

Optimization

  • Eager keysound loading
    • This speeds up pattern load time, more apparent on faster storages (e.g. SSDs).
      • The problem stemmed from the pre-optimize coroutine only loading one file per frame.
    • Drawback: The game will freeze briefly while loading keysound.
  • (dirty change) Reduce GetComponent() calls in the Pattern Editor's Update() loop.
    • There are still resource hogs on note object culling (instantiate/destroy).
      • A new design is pretty much needed.
  • (dirty change) Convert timing variables from (float -> double).
    • Improves input and keysound playback precision.
  • Eliminate GetComponent() calls in the Update() loop. Merged into the official build (1.1)
    • This pretty much solves the "FPS drop on touch spam" problem.
    • I couldn't record a play on 1080p without stuttering on my laptop. With this fix, now I can!
  • Manually call garbage collector (GC) after finishing loading a game scene or a pattern editor.
    • To get rid of most CPU and memory hogs, right before a period that requires quick interaction.
  • Automagically merge all keysounds in hidden notes into a long one.
    • Greatly reduces the number of audio played at once, especially on easier patterns with a lot of keysounds.
    • Will extend this to auto keysound and auto assist tick in the future.
  • On gameplay initialization, remove all hidden notes with no keysound. Merged into the official build (1.1)
  • Disable all Console.Log()s on builds.
  • Rays casted from touches now ignore all inactive note hitboxes. Merged into the official build (1.0.2)
    • Was one of the causes of fps drop on touch spamming (e.g. jacking repeat notes) I managed to find.
    • Update: Stricter rule; Now ignores all but the notes currently in their judgement window.
  • Disable empty hits for long notes (Hold, Drag, Repeat Hold) Merged into the official build (1.0.2)
    • Reference: DJMax Respect V behavior.
  • (dirty change) Convert gameplay note collections from lists to dictionaries
    • For optimization, especially on rapid scan jumps in practice mode
  • Optimize Unity physics and shading
    • Since TECHMANIA does not actually utilize 3D-space shading, some settings are tweaked for unlit kind of shading.
    • Other minor game scene adjustments, such as 2D culling mask and clipping distance

Miscellaneous

  • Enable Rulesets on iOS and Android Except Custom
  • Fix Long Note Behavior with Brief Input Release
    • This is related to the Grace Period rule, and it should not apply to consecutive "begin pressing" inputs on a note.
    • In other words, on a long note, lifting finger early now counts only on the trail end portion!
  • Fix Curtain Open (Fade in From Black) Transition Not Completely Opening
    • Was the reason why the game screen sometimes looks dimmed.
  • Fix Practice Mode Shortcuts Being Available on Pause
  • Add default background settings and the "Always Use Default BG Settings" toggle, all in Options.
    • If the new toggle is on, background settings in the Modifier Side Sheet and Pause Menu also apply to defaults.
  • (dirty change) Some default values which are unavailable in settings
    • Default BGA brightness (from 10 to 6) Replaced with actual configurable value, described above.
  • Prevent screen settings applying at launch, so some command line arguments are usable (e.g. custom screen resolution)
    • You can still apply them in settings.
  • UI text changes
    • Tex Gyre Adventor as default font (TMP)
    • Readjusted text styling and spacing
    • Original fonts kept as fallbacks

Below is the content from the original README.

TECHMANIA

An open source rhythm game, written in Unity, playable with or without a touchscreen.

Download for Windows

Download for iOS/iPadOS

Trailer

Discord

Official website

Licensing

All code and assets are released under the MIT License, with the following exceptions:

  • Sound effects in TECHMANIA/Assets/Sfx are acquired from external resources, which use different licenses. Refer to TECHMANIA/Assets/Sfx/Attributions.md for details. Please note that some licenses prohibit commercial use.
  • Some included tracks in the releases are under separate licenses:
Track name License
f for fun CC BY-NC-ND 4.0
Yin-Yang Specialist (MUG ver) CC BY-NC-NA 4.0
v (Game Mix) CC BY-NC-SA 4.0
TAKE OUT CC BY-NC 4.0
Run 4 Cover CC BY-NC-ND 4.0
Ash Barrens CC BY-NC 4.0

Roadmap and progress

Refer to the Kanban.

Manual and documentation

Refer to the documentation website.

Platform

The game is designed for Windows PCs, with the Touch control scheme requiring a touchscreen monitor. Patterns using other control schemes are playable with a mouse and keyboard.

We also provide technical support for iOS/iPadOS, in that we are able to respond to bug reports and some feature requests. However please be aware of the following:

  • The game's UI is designed for PC and may be difficult to navigate on a phone;
  • The game's difficulty is tuned for PC and may prove too difficult for mobile players;
  • Some features in the included editor require mouse and keyboard, and therefore are unavailble to mobile users.

Builds for other platforms also exist, but are not officially supported at the moment.

Content policy

Per the MIT license, you are free to produce any Content with TECHMANIA, including but not limited to screenshots, videos and livestreams. Attributions are appreciated, but not required. However, please keep the following in mind:

  • If your Content features 3rd party music, it may be subject to copyright claims and/or takedowns. You may not hold TECHMANIA responsible for the resulting losses.
  • If your Content is publicly available and features any unofficial skin, you must clearly state so in the description of your Content, to avoid potential confusion.
  • If your Content is commercial, additional limitations apply:
    • Your Content cannot feature any official tracks.
    • Your Content cannot feature the Fever sound effect. You can swap the sound with one that allows commercial use, make a custom build, and produce Content from that build.

Feedback

For technical issues, read the contribution guidelines, then submit them to Issues.

For general discussions, head to Discord.

Making your own builds

Follow the standard building process:

  • Install Unity, making sure your Unity version matches this project's. Check the project's Unity version at ProjectVersion.txt.
  • Clone this repo, then open it from Unity.
  • File - Build Settings
  • Choose your target platform, then build.

Please note that the default skins are not part of the project, so you'll need to copy the Skins folder from an official release into your build folder, in order for your build to be playable. Alternatively, set up streaming assets in your local clone.

If the build fails or produces a platform-specific bug, you can submit an issue, but we do not guarantee support.

On streaming assets

In PC builds we release the base game and resources (official tracks and skins) separately so PC players don't need to redownload resources when updating. On mobile builds, however, it's more beneficial to include the resources in the release so the installation process is easier. To achieve this, we take advantage of streaming assets.

In order to keep this repo focused, the streaming assets folder (TECHMANIA/Assets/StreamingAssets) is ignored in .gitignore. To set up streaming assets in your local clone:

  • Create the following folders:
    • TECHMANIA/Assets/StreamingAssets
    • TECHMANIA/Assets/StreamingAssets/Tracks
    • TECHMANIA/Assets/StreamingAssets/Tracks/Official Tracks
    • TECHMANIA/Assets/StreamingAssets/Skins
  • Download Skins_and_Tracks.zip from an official release.
  • Copy everything:
    • from Skins_and_Tracks.zip/Tracks to TECHMANIA/Assets/StreamingAssets/Tracks/Official Tracks
    • from Skins_and_Tracks.zip/Skins to TECHMANIA/Assets/StreamingAssets/Skins

If done correctly, you should see official tracks and skins in the game even when they are not in the build folder.

Additionally, we perform the following optimizations / decorations for the mobile releases:

  • In tracks, convert .wav to .ogg, and .wmv to .mp4, in order to decrease file size and increase compatibility. When doing so, make sure to also update filenames in track.tech.
  • Copy TECHMANIA/Assets/Sprites/Logo.png to TECHMANIA/Assets/StreamingAssets/Tracks/Official Tracks so it shows up as eyecatch.

Platform-specific forks