HappyFunTimes Docs

Changelog for Unity Plugin

  • 2.0

    • Make it 100% self contained.

      No more need for node.js. Now you can easily build using the normal builder and post your games on itch.io or steam, etc...

    • Move almost all the samples into the plugin.

      Before each sample was a separate repo. This was to make it easy to export and install each one into the HappyFunTimes app. Now that it's all standalone there's no need for that feature and all the samples can happily co-exist in the same project.

  • 1.3

    • Fixed GetAxis bug where asking for the wrong axis returned the first axis

    • Added Instructions support.

      Start HappyFunTimes with hft start --instrutions for instructions to appear. See docs

  • 1.2

    • Added Export/Install/Publish menu items

    • Added HFTGamepad.BUTTON_TOUCH for whether or not the user is touching the screen on the orientation and touch controllers.

    • Added ability to play sound through controller

      There are currently 2 ways to make sounds for the controllers.

      1. JSFX

        This is the recommended way as it's light weight.

        1. Go to the JSFX sound maker.

        2. Adjust the values until you get a sound you like.

        3. Copy the sound values (near top of the page just below the buttons) to a text file with the extension ".jsfx.txt" putting a name in front of each set of values. Save that file in Assets/WebPlayerTemplates/HappyFunTimes

        For example here is the sample sounds.jsfx.txt file

        coin      ["square",0.0000,0.4000,0.0000,0.0240,0.4080,0.3480,20.0000,909.0000,2400.0000,0.0000,0.0000,0.0000,0.0100,0.0003,0.0000,0.2540,0.1090,0.0000,0.0000,0.0000,0.0000,0.0000,1.0000,0.0000,0.0000,0.0000,0.0000]
        jump      ["square",0.0000,0.4000,0.0000,0.0960,0.0000,0.1720,20.0000,245.0000,2400.0000,0.3500,0.0000,0.0000,0.0100,0.0003,0.0000,0.0000,0.0000,0.5000,0.0000,0.0000,0.0000,0.0000,1.0000,0.0000,0.0000,0.0000,0.0000]
        coinland  ["square",0.0000,0.4000,0.0000,0.0520,0.3870,0.1160,20.0000,1050.0000,2400.0000,0.0000,0.0000,0.0000,0.0100,0.0003,0.0000,0.0000,0.0000,0.0000,0.0000,0.0000,0.0000,0.0000,1.0000,0.0000,0.0000,0.0000,0.0000]
        bonkhead  ["sine",0.0000,0.4000,0.0000,0.0000,0.5070,0.1400,20.0000,1029.0000,2400.0000,-0.7340,0.0000,0.0000,0.0100,0.0003,0.0000,0.0000,0.0000,0.3780,0.0960,0.0000,0.0000,0.0000,1.0000,0.0000,0.0000,0.0000,0.0000]
        land      ["sine",0.0000,0.4000,0.0000,0.1960,0.0000,0.1740,20.0000,1012.0000,2400.0000,-0.7340,0.0000,0.0000,0.0100,0.0003,0.0000,0.0000,0.0000,0.3780,0.0960,0.0000,0.0000,0.0000,1.0000,0.0000,0.0000,0.0000,0.0000]
        kicked    ["noise",0.0000,1.0000,0.0000,0.0400,0.0000,0.2320,20.0000,822.0000,2400.0000,-0.6960,0.0000,0.0000,0.0100,0.0003,0.0000,0.0000,0.0000,0.0000,0.0000,0.0000,0.0000,0.0000,1.0000,0.0000,0.0000,0.0270,0.0000]
        dropkick  ["sine",0.0000,1.0000,0.0000,0.0880,0.0000,0.3680,20.0000,653.0000,2400.0000,0.2360,0.0000,0.1390,47.1842,0.9623,-0.4280,0.0000,0.0000,0.4725,0.0000,0.0000,-0.0060,-0.0260,1.0000,0.0000,0.0000,0.0000,0.0000]
        bounce    ["noise",0.0000,1.0000,0.0000,0.0220,0.0000,0.1480,20.0000,309.0000,2400.0000,-0.3300,0.0000,0.0000,0.0100,0.0003,0.0000,0.0000,0.0000,0.0000,0.0000,0.0000,0.0000,0.0000,1.0000,0.0000,0.0000,0.0000,0.0000]
      2. Use sounds files

        Put sound files (.mp3 or .wav) in Assets/WebPlayerTemplates/HappyFunTimes/sounds They have to be in there because they must be served to the phone. Note that it's a good idea to keep them as small as possible because each time a player connects to the game his phone will have to download all the sounds. JSFX sounds comming soon.

      Playing Sounds

      To use the sounds, on some global gameobject (like LevelManager in all the samples) add an HFTGlobalSoundHelper script component.

      Then, on the prefab that gets spawned for your players, the same prefab you put an HFTInput or HFTGamepad script component add the HFTSoundPlayer script component.

      In your Awake or Start look it up

      private HFTSoundPlayer m_soundPlayer;
      void Awake()
           m_soundPlayer = GetComponent<HFTSoundPlayer>();

      To play a sound call m_soundPlayer.PlaySound with the name of the sound (no extension). In other words if you have sounds/explosion.mp3 then you can trigger that sound on the user's phone with


      Or if you named a JSFX sound like

      bounce    ["noise",0.0000,1.0000,0.0000,0.0220,0.0000,0.1480,20.0000,309.0000,2400.0000,-0.3300,0.0000,0.0000,0.0100,0.0003,0.0000,0.0000,0.0000,0.0000,0.0000,0.0000,0.0000,0.0000,1.0000,0.0000,0.0000,0.0000,0.0000]


*   added mulit-touch support to HFTInput via the standard `GetTouch` function
    as well as `axes` and `buttons`

        public const int AXIS_TOUCH0_X = 13;
        public const int AXIS_TOUCH0_Y = 14;
        public const int AXIS_TOUCH1_X = 15;
        public const int AXIS_TOUCH1_Y = 16;
        public const int AXIS_TOUCH2_X = 17;
        public const int AXIS_TOUCH2_Y = 18;
        public const int AXIS_TOUCH3_X = 19;
        public const int AXIS_TOUCH3_Y = 20;
        public const int AXIS_TOUCH4_X = 21;
        public const int AXIS_TOUCH4_Y = 22;
        public const int AXIS_TOUCH5_X = 23;
        public const int AXIS_TOUCH5_Y = 24;
        public const int AXIS_TOUCH6_X = 25;
        public const int AXIS_TOUCH6_Y = 26;
        public const int AXIS_TOUCH7_X = 27;
        public const int AXIS_TOUCH7_Y = 28;
        public const int AXIS_TOUCH8_X = 29;
        public const int AXIS_TOUCH8_Y = 30;
        public const int AXIS_TOUCH9_X = 31;
        public const int AXIS_TOUCH9_Y = 32;

        public const int BUTTON_TOUCH0 = 18;
        public const int BUTTON_TOUCH1 = 19;
        public const int BUTTON_TOUCH2 = 20;
        public const int BUTTON_TOUCH3 = 21;
        public const int BUTTON_TOUCH4 = 22;
        public const int BUTTON_TOUCH5 = 23;
        public const int BUTTON_TOUCH6 = 24;
        public const int BUTTON_TOUCH7 = 25;
        public const int BUTTON_TOUCH8 = 26;
        public const int BUTTON_TOUCH9 = 27;

    Note: The Touch.rawPosition is currently in screen pixels of Unity
    not the controller. It's not clear what the best way to handle this

    The Unity `Input` API says those value are in pixels but they are
    assuming the game is running on the phone. In the case of HappyFunTimes
    though each phone is different so having it be in phone screen pixels
    would make no sense unless you also knew the resolution of each phone.
    I could provide that but that would make it more complicated for you.

    Personally I'd prefer normalized values (0.0 to 1.0). If you want those
    then take  `Touch.rawPosition` and divide `x` by `Screen.width` and `y` by `Screen.height`
    as in

        HFTInput.Touch touch = m_hftInput.GetTouch(0);
        float normalizedX = touch.x / Screen.width;
        float normalziedY = touch.y / Screen.height;

    Also note the AXIS versions of these are already normalized to
    a -1.0 to +1.0 range.

*   Changed sample HFTGamepad code to not issue an error if it's not actually
    connected to a controller.

    Users often leave a prefab in their scene. That prefab would generate
    errors because it's not actually connected to a controller and was
    trying to access the controllers `NetPlayer`.
  • 1.1

    • Moved samples into samples folder
  • 1.0

  • 0.0.7

    • Added maxPlayers to PlayerSpawner