CHANGELOG.md

Changelog

Next version

Full Changelog

• WinFormUI/EventViewer: If last row is shown, then keep showing the last row as new events are added
• WinFormUI/Console: Always scroll to newest line added
• WinFormUI/EventViewer: Show custom events colored green and use their name instead of InternalCustomEvent
• WinFormUI/EventViewer: Show internal events colored gray.
• Don't exit WinFormUI if inactive (nothing depends on it). Once we start the UI, we expect it to be running until user exits
• Lua: added support for executing code when script shuts down. If you define an atexit function, it will be invoked at script shutdown.
• Added "Clear All Events" option when right-clicking in the events tab
• Added "Save events to file" option when right clicking in the events tab
• Generate correct lua handler code for custom events
• New component: JustGiving - monitor fundraisings and get events at new donations
• WinFormUI: Console lines are now timestamped
• WebWidgets: HTTP Server now listens on all IPs
• Core: When Lua scripts stop using a instance, then wait for a bit before shutting it down.
• Audio: Bugfix: Audio thread not shutting properly down
• If Slipstream is compiled in "Debug" and you got Seq installed, it will send all its logs there. It will also log all messages to file (same directory as executable).
• Verify that instance id are not reused for differnet lua libraries. This means that this script: require("api/audio"):instance({id="audio"}); require("api/iracing"):instance({id = "audio"}) will failed with error: errored: Id 'audio' with unexpected LuaLibrary 'api/iracing', but was previously used with LuaLibrary 'api/audio'
• New component: WebServer. A more general way of server content through http. Can replace WebWidget, so WebWidget will be deprecated
• New component: WebSocket. A websocket client.
• New IRacing event: IRacingTime - sent every second. Contains session time and session time remaining
• Fix init.lua auto-creation

0.10.0 (2021-10-07)

Full Changelog

• AudioComponent improved: Now removes any pending say/play commands if sender is removed (eg. script deleted or reloaded)
• Bugfix: Clear delayed functions (debounce and wait) on script restart
• WebWidget: Allow javascript to send WebWidgetData via js function sendData(data)
• Bugfix: Events seems to be were out of order judging by their timestamp
• Added support for custom events. To generate a custom event: internal:send_custom_event("Hello", { Custom = "Events", Are = "Supported", For = "World"}) These will be published as InternalCustomEvent events, having two fields: Name and Json. Use parse_json(event.Json) to get a LuaTable with the values as were sent via the event. Also adds generate_json(luaTable) to generate json string from a Lua table.
• Bugfix: WinFormUI wouldn't always pick up creation events, while it was initializing it's window.
• Bugfix: Auto-create "Scripts" directory if missing

0.9.0 (2021-08-21)

Full Changelog

• WinFormUI: Reworked UI. Now allows you to see scripts and which instances they use. And many other small tweaks
• Removed empty menu "Plugins"
• Lua: Added some lua code to make it possible to pick up events with the following code:

addEventHandler("InternalDependencyAdded", function(event)
  -- Example event: {"EventType":"InternalDependencyAdded", ... 
  ui:print(util:event_to_json(event))
end)

It will setup a handle() function for you that wires it up.

• Endpoints created, are now shown in menu under "Endpoints"

0.8.0 (2021-08-04)

Full Changelog

• IRacing: Adds pit-stop lua functions: pit_clear_all(), pit_clear_tyres(), pit_fast_repair(), pit_add_fuel(), pit_change_(left|right)_(front|rear)_tyre() and pit_clean_windshield()
• BUGFIX: Twitch messages would sometimes be dropped
• Remove persisting the location and size of the Slipstream UI. It could end up placing the Window off-screen, making it hard to reach.
• IRacing: Add FuelLeft attribute to IRacingCompletedLap and IRacingPitExit
• Rearchitected events: Now events are directed to a one or more recipients. And only scripts using that instance will be notified of its events. Meaning, you will not get IRacing events, if you don't have require("api/iracing"):instance(..)
• You need a new init.lua, so delete your existing init.lua to get a new one.
• IRacing: Adds pit-stop lua functions: pit_clear_all(), pit_clear_tyres(), pit_fast_repair(), pit_add_fuel(), pit_change_(left|right)_(front|rear)_tyre() and pit_clean_windshield()
• New Component: WebWidgets
• Merged UI components into WinFormUI. You need to change require("api/ui") to require("api/winformui")

0.7.0 (2021-04-30)

Full Changelog

• BREAKING CHANGE: Rearchitects how Slipstream exposes features to Lua. New init.lua required! For more information look at commit 21070e613ac46950b7d1a8465e22f85b5355865f

0.6.0 (2021-04-30)

Full Changelog

• adds WinFormUI component - containing the Slipstream UI. You need to add register_plugin({ plugin_name = "WinFormUIPlugin"}) to you init.lua to get it.
• add internal:shutdown() lua function that quits the application
• Adds InternalPlugin (automatically loaded)
• Adds UIPlugin that handles generic UI functionality. Needs to be added to your init.lua!

0.5.0 (2021-03-25)

Full Changelog

• No more version specific init.lua. From this point and forward, Slipstream only reads init.lua
• Event: Adds IRacingTrackPosition
• Adding ApplicationUpdate plugin to manage app install and auto updates using Squirrel.Windows
• Moved the init.lua default content to a resource

0.4.1 (2021-03-20)

Full Changelog

• Bugfix: Event IRacingCarInfo now sets LocalUser correctly
• Event: Added CurrentDriverLicense to IRacingCarInfo
• Event: Added Category to IRacingCurrentSession
• Event: Rename LuaManagerCommandDeduplicateEvents to LuaCommandDeduplicateEvents
• Lua: core:wait('name', .. ) can now redefine itself within the function invoked by wait.
• lua: Adds audio:send_devices(..), audio:set_output(..) to control which output device to use
• lua: Changed audio:play(..), audio:say(..) with another arguments to decide which plugin to use
• events: Adds AudioCommandSendDevices, AudioCommandSetOutputDevice and AudioOutputDevice
• New plugin: PlaybackPlugin. Allows you to save seen events and inject them again (for debugging and testing)
  • New events: PlaybackCommandInjectEvents (inject events from file), PlaybackCommandSaveEvents (save last events to file)
  • Menu items in UI are only shown if you register that plugin: register_plugin("PlaybackPlugin", "PlaybackPlugin")_
  • Lua: playback:save(filename), playback:load(filename). Saves and loads events (same as via menu in UI)
• lua: Changed syntax for register_plugin(id, name). Going forward it takes a single argument a lua table. Read docs
• UI: Removed settings menu. Now settings is specified in init.lua, making Settings redundant. If you remove your settings, a new one will be generated with instructions.
• Redesigned events converning the state of the current session
  • Removed events: IRacingCommandSendCurrentSession, IRacingCurrentSession and IRacingSessionState
  • Replaced with: IRacingPractice, IRacingQualify, IRacingRace, IRacingTesting, IRacingWarmup
  • If your script needs to get the current state, it can still use the lua function: iracing:send_session_state()
• TwitchPlugin: Add events TwitchUserSubscribed (both sub and resub), TwitchGiftedSubscription and TwitchRaided
• TwitchPlugin: Made it Throttle-aware, hopefully avoiding getting locked out of chat for 30mins
• IRacingPlugin: Added IRacingCarPosition
• New plugin: DiscordPlugin
• IRacingPlugin: Fix IRacingWeatherInfo - now reports actual values and not values from start of session.
• IRacingPlugin: Support sending "raw" game state events. Allowing you to act on data changes not directly represented as an event.
• IRacingPlugin: Rename IRacingCarCompletedLap to IRacingCompletedLap
• IRacingPlugin: Renamed FuelDiff to FuelDelta in IRacingCompletedLap, IRacingPitstopReport for consistency
• IRacingPlugin: Adds BestLap to IRacingCompletedLap.
• IRacingPlugin: Rename IRacingCompletedLap.Time to IRacingCompletedLap.LapTime.
• IRacingPlugin: Add IRacingCompletedLap.EstimatedLapTime - to show if this was a laptime as recorded by IRacing or by Slipstream in case IRacing doesn't provide a laptime
• IRacingPlugin: Change IRacingDriverIncident: Rename Incident(Count|Delta) to DriverIncident(Count|Delta). Added fields: TeamIncident(Count|Delta) and MyIncident(Count|Delta)
• IRacingPlugin: Adds: IRacingTowed event

0.4.0 (2020-01-10)

Full Changelog

• Lua: Deduplicate identical events. If one or more scripts sends the same event on the eventbus during start, they will be deduplicated. This means, that we avoid having the same response to the same command repeated several times. Fx. Having multiple scripts that asks for IRacing WeatherInfo upon start, will be deduplicated as only one response is needed for these scripts.
• Lua: Add iracing_send_car_info() that will make IRacingPlugin send all the CarInfo
• Lua: Add iracing_send_track_info() that will make IRacingPlugin send all TrackInfo
• Lua: Add iracing_send_weather_info() that will make IRacingPlugin send all WeatherInfo
• Lua: Add iracing_send_current_session() that will make IRacingPlugin send CurrentSession
• Lua: Add iracing_send_session_state() that will make IRacingPlugin send SessionState
• Lua: Add iracing_send_race_flags() that will make IRacingPlugin send race flags
• InternalInitialized event removed. Refactored to avoid having it
• Lua: Removed plugin_enable(), plugin_disable(). Register/Unregister them instead
• Renamed Events:
  • UICommandWriteToConsole is now UIMethodCollection
  • InternalReconfigured is now InternalCommandReconfigure
  • InternalBootupEvents is now InternalCommandDeduplicateEvents
  • InternalCommandDeduplicateEvents is now LuaManagerCommandDeduplicateEvents
• Plugin renamed: FileTriggerPlugin to LuaManagerPlugin
• UI: Stores/restores Window position and size
• Event: Adds TwitchReceivedMessage event (captures all messages, not only commands)
• Event: Removes TwitchReceivedCommand event as this is already sent as a TwitchReceivedMessage
• Event: Adds TwitchReceivedWhisper and TwitchCommandSendWhisper event
• Lua: send_twitch_whisper() / twitch:send_whisper_message()

0.3.0 (2020-01-05)

Full Changelog

Improvements

• Lua: Add event_to_json() function, that will convert a Slipstream event to a json string. Change debug.lua to use that, making it trivial.
• Lua: At start: Make sure all Lua script before IRacingPlugin publishes events
• UI: Will show all events, even if they are published before UI was ready
• Events renamed for consistency:
  • CommandPlayAudio to AudioCommandPlay
  • CommandSay to AudioCommandSay
  • CommandPluginEnable to InternalCommandPluginEnable
  • CommandPluginDisable to InternalCommandPluginDisable
  • CommandPluginRegister to InternalCommandPluginRegister
  • CommandPluginStates to InternalCommandPluginStates
  • CommandPluginUnregister to InternalCommandPluginUnregister
  • Initialized to InternalInitialized
  • PluginState to InternalPluginState
  • CommandTwitchSendMessage to TwitchCommandSendMessage
  • CommandWriteToConsole to UICommandWriteToConsole
• Buttons: Make simple buttons in UI using Lua (create_button("text")) and remove them again (delete_button("text"))
• Lua: Adds functions to control plugins: register_plugin, unregister_plugin, enable_plugin, disable_plugin
• init-.lua is read upon startup. Here you can define what plugins to register and enable. If file is not found, one is created

0.2.0 (2020-12-30)

Full Changelog

Improvements

• Replace DebugOutputPlugin with a Lua script (LuaScript/debug.lua)
• Twitch: Allow Twitchchannel to be configured (it was assumed that username and channel would be the same)
• Added TransmitterPlugin and ReceiverPlugin. Allows one instance of Slipstream to forward its events to another instance using a TCP/IP connection. This features SHOULD ONLY be used locally. There is no authentication or encryption of the events.
• Twitch: Optionally show twitch log
• TwitchConnected event are now sent when we joined the channel (not just connected to twitch servers)

Bugfixes

• Auto-create both "Audio" and "Scripts" directories

0.1.0 (2020-12-23)

Full Changelog

Initial version