diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/404.html b/404.html new file mode 100644 index 00000000..1428cd50 --- /dev/null +++ b/404.html @@ -0,0 +1,711 @@ + + + + + + + + + + + + + + + + + + Riders.Tweakbox Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ +

404 - Not found

+ +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/BookOfTheTweakbox/charts/basic-layout.drawio b/BookOfTheTweakbox/charts/basic-layout.drawio new file mode 100644 index 00000000..1c8d6cc7 --- /dev/null +++ b/BookOfTheTweakbox/charts/basic-layout.drawio @@ -0,0 +1 @@ +5Vpbd9o4EP41nE0e4PiCjXkMJE3Tpt12YXPpS4+wZVsbYVFZ5pJfvyNbBgsMIWFD9qR5INZoNJJG33wzFjTs/nh+ydEk/sICTBuWEcwb9nnDsjrdDnxKwaIQ2I5ZCCJOgkJUEQzII1ZCQ0kzEuBUUxSMUUEmutBnSYJ9ockQ52ymq4WM6rNOUIQ3BAMf0U3pLQlEXEg9q7OSf8QkisuZTbdb9IxRqax2ksYoYLOKyL5o2H3OmCiexvM+ptJ3pV9urxa39PrBvfz0Pf2F/u59Hn69aRbGPjxnyHILHCfixaa7IzL/7HQFukGzH/eDx/PR159Ny1V7E4vSYTgA/6km4yJmEUsQvVhJe5xlSYClWQNaK51rxiYgNEH4DxZiocCAMsFAFIsxVb14TsSdHN5yVOu+0nM+V5bzxqJsJIIvKoNk877atxqWt8pxqeDsAfcZZRwkAQ5RRsGJvQClcb4HOe2eDlYHkbKM+8pbZ3fz7s2w/dP98+OnH9mUGndz2rQUzhGPsNihpzAoPV4Bqzq+S8zGGHYCChxTJMhURzRSgREt9ZZDvzEC+7AMFcNux2gZlT+1vEUZqLLX9tqu6eSfuvlis8piFV5rk3TKMCl5wjV0Q4U3NgydcY4WFbWJVEirGvBQ8cZKlOP7GVh3lLuniGbKlX2OkQB2soyzfPzJB8JTcVobE9doBMyo4RhREiXw7ANsMMCrN8VcEOCeM9UxJkFQhAxOySMa5fYkKtUuwbjTazjnIAlZIlTAdGsRuTN+5cR4XkeoalKNszRwqVFGy7TNjnaECicHoq+pw61p6wZYGKZYHHjetdHlbhz3xrlGQGWTZ3pwX57Y6mnb1CPFLCNltspPS1lczU22u935mvee6yqjxlUuGgOb93Ky1Fs+RWm6FEWaQtnKFUccnnRJKfjGWcTReLsm7GO0LpMxoh2g+ytjZUczzaPnDBS6k3kxSnWXdv7ClCHIXH/IiM/ThDxNCdfWzoUU85biNQzp2XAWE4EHE5TnhxlUVDpjhITSMhc1LDtwsBe0N7IU9HjWyHbd5Xw16KyicDv+N1H4FMqc1wKZdXSQDWcYPYzY/LgoG8Z4HV4NSR2FdVKqFbnn5LSyFLJaChS6sFhjrx28K3gqUvTc/TjRMV4JrfZ7L4xra899z22PItjYswi2Dqx5DzrlzZJwFyepcsFgoawOJEHhQynqqs+SkEQZh82y5CQ9PS5X9VAqyYrI+jWUrFASD8p95+eLy7NlK4IcaVAWLcVvlTMR9kK/jpRc38OjcF9SekHl1l17xWnXFG7dY5KU9+bwHZAkoliwZID5lPj46AhW86atFUg3Uu2XLCW+UtyZboGpBGxIuidLBRvLayA5VvIYR/4DuKtfm8tz7UuM+AtniWAo/AuQQL9fWFldR48rp71fXHmvFVfd9578a26/dlYCR7kO8w6sBJ64T6q/nrC3kPq2e64n9OGhWMF/epVhmhtEv3F1NcCQloP/z93VCy9UtsfjVv5oGi3T8HQOKUF34OXV2lWppY9/vburcqa3LUwhE1CK+dFzeoHo5T4MESNpLyAc0EPlyY9ZQEL5EKGxLFpHOEZTAkRUKQOuooRxPMz4KKM48fFqQwUUZUNaJ9JpE4oWRQdK8m5KSYDzHAQpCJawNPP75WfHfGHd+2r52Xz3b+dagq7l17fP1+abvrqb7adz4jAm/J2mxCIEdnydY3hr2as8/0O/z/FqrR6SE6G5+hq9UF/9FsG++Bc= \ No newline at end of file diff --git a/BookOfTheTweakbox/heap/index.html b/BookOfTheTweakbox/heap/index.html new file mode 100644 index 00000000..55e26fc4 --- /dev/null +++ b/BookOfTheTweakbox/heap/index.html @@ -0,0 +1,803 @@ + + + + + + + + + + + + + + + + + + + + + + + + Heap - Riders.Tweakbox Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Heap

+
+

Info

+

Explains how Sonic Riders' vanilla memory allocation system works.

+
+

Changes in Tweakbox

+
+

Todo

+

To be added.

+
+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/BookOfTheTweakbox/images/basic-layout.png b/BookOfTheTweakbox/images/basic-layout.png new file mode 100644 index 00000000..abec4d87 Binary files /dev/null and b/BookOfTheTweakbox/images/basic-layout.png differ diff --git a/BookOfTheTweakbox/images/hyperlink-example.png b/BookOfTheTweakbox/images/hyperlink-example.png new file mode 100644 index 00000000..43a9f414 Binary files /dev/null and b/BookOfTheTweakbox/images/hyperlink-example.png differ diff --git a/BookOfTheTweakbox/images/imagerenderer-example.png b/BookOfTheTweakbox/images/imagerenderer-example.png new file mode 100644 index 00000000..074c29de Binary files /dev/null and b/BookOfTheTweakbox/images/imagerenderer-example.png differ diff --git a/BookOfTheTweakbox/images/profileselector-example.png b/BookOfTheTweakbox/images/profileselector-example.png new file mode 100644 index 00000000..86654c25 Binary files /dev/null and b/BookOfTheTweakbox/images/profileselector-example.png differ diff --git a/BookOfTheTweakbox/images/tooltip-example.png b/BookOfTheTweakbox/images/tooltip-example.png new file mode 100644 index 00000000..321de8e4 Binary files /dev/null and b/BookOfTheTweakbox/images/tooltip-example.png differ diff --git a/BookOfTheTweakbox/index.html b/BookOfTheTweakbox/index.html new file mode 100644 index 00000000..ef04500d --- /dev/null +++ b/BookOfTheTweakbox/index.html @@ -0,0 +1,771 @@ + + + + + + + + + + + + + + + + + + + + + + + + Index - Riders.Tweakbox Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Book of the Tweakbox

+

Welcome to the Book of the Tweakbox (BOTT) for Riders Tweakbox. This page contains a collection of articles about the internals of both Riders Tweakbox itself, as well as Sonic Riders. The intended audience of this book is people wishing to work on Tweakbox, or wishing to understand Tweakbox and/or the base game.

+ + + + + + + + + + + + + + + + + + + + + +
PageDescription
IntroductionDescribes the general structure/layout of Tweakbox' source code.
Overlay Helper APIsUseful APIs for creating menus in Tweakbox.
HeapDescribes how Sonic Riders' memory allocator works.
+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/BookOfTheTweakbox/introduction/index.html b/BookOfTheTweakbox/introduction/index.html new file mode 100644 index 00000000..bf5eb0dc --- /dev/null +++ b/BookOfTheTweakbox/introduction/index.html @@ -0,0 +1,1304 @@ + + + + + + + + + + + + + + + + + + + + + + + + Introduction - Riders.Tweakbox Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Introduction

+
+

Info

+

Provides an introduction to Tweakbox' internal code structure, including how things are laid out.

+
+

Initialization

+
+

Info

+

Provides a simplified top level view of how initialization happens in Tweakbox.

+
+

+

Entry Point (Program)

+

The life of Tweakbox begins in Program.StartEx(), this method is responsible for the following:
+- Setting up 3rd party libraries (e.g. one time method calls).
+- Fetching Reloaded dependencies [e.g. File Redirector to use with music].
+- Adjusting anything runtime related.

+

Program then delegates to Tweakbox, which sets up Tweakbox' code.

+

Tweakbox Entry Point (Tweakbox)

+

The Tweakbox component is responsible for the following [in order]:
+- Sanity checks (e.g. ensure files don't use vanilla compression).
+- Setting up UI Menus.
+- Initialising all IConfiguration(s), ISingletonService(s) & IController(s) in this specific order.

+

Components

+
+

Info

+

Defines the common kinds/types of items you'll find in Tweakbox' source code.

+
+
+

Note

+

Unless stated otherwise, assume components are singletons, i.e. there is only ONE instance of each configuration in memory and it's reused everywhere.

+
+

Configs (IConfiguration)

+
+

Info

+

Stores an individual configuration for a component or a set of Tweakbox components.

+
+

Within Tweakbox' source, you will find two types of configurations, Binary and JSON.

+

JSON configurations are used when all of the data is known, and inherit from JsonConfigBase which provides all of the backbone code for the configuration(s).

+

Example:
+

// JsonConfigBase inherits from IConfiguration and provides all needed boilerplate code.
+public class TextureInjectionConfig : JsonConfigBase<TextureInjectionConfig, TextureInjectionConfig.Internal> 
+{
+    public class Internal
+    {
+        public bool DumpTextures = false;
+        public DumpingMode DumpingMode = DumpingMode.All;
+        public int DeduplicationMaxFiles = 2;
+    }
+
+    public enum DumpingMode
+    {
+        All = 0,
+        OnlyNew = 1,
+        Deduplicate = 2,
+    }
+}
+

+

Binary configurations are typically used when the data:
+- Needs to be small.
+- Contains unknown values (e.g. Not fully reversed Sonic Riders' game structs).

+

Example Binary configuration:
+

public unsafe class GearEditorConfig : IConfiguration
+{
+    private static GearEditorConfig _default = new GearEditorConfig();
+
+    /// <summary>
+    /// Extreme gears assigned to this config.
+    /// </summary>
+    public ExtremeGear[] Gears;
+
+    /// <summary>
+    /// Creates the default editor config.
+    /// </summary>
+    public GearEditorConfig()
+    {
+        Gears = new ExtremeGear[Player.OriginalNumberOfGears];
+        Player.Gears.CopyTo(Gears, Gears.Length);
+    }
+
+    /// <summary>
+    /// Creates a <see cref="GearEditorConfig"/> from the values present in game memory.
+    /// </summary>
+    public static GearEditorConfig FromGame() => new GearEditorConfig();
+
+    /// <summary>
+    /// Updates the game information with the gear data stored in the class.
+    /// </summary>
+    public unsafe void Apply() => Player.Gears.CopyFrom(Gears, Player.OriginalNumberOfGears);
+
+    /// <inheritdoc />
+    public Action ConfigUpdated { get; set; }
+    public byte[] ToBytes() => LZ4.CompressLZ4Stream(StructArray.GetBytes(Gears), LZ4Level.L12_MAX);
+
+    public void FromBytes(Span<byte> bytes)
+    {
+        var outputArray = new byte[StructArray.GetSize<ExtremeGear>(Player.OriginalNumberOfGears)];
+        var decompressed = LZ4.DecompressLZ4Stream(outputArray, bytes, out int bytesRead);
+
+        StructArray.FromArray(decompressed, out Gears, true, Player.OriginalNumberOfGears);
+        ConfigUpdated?.Invoke();
+    }
+
+    public IConfiguration GetCurrent() => FromGame();
+    public IConfiguration GetDefault() => _default;
+}
+

+

[Stores the whole array of all extreme gear data in Riders]

+

Services (ISingletonService)

+
+

Info

+

Provides various utility functions to be used throughout Tweakbox.
+Also a singleton.

+
+

Example API(s):

+
/// <summary>
+/// Keeps track of all music tracks provided by other mods (as well as the vanilla game)
+/// </summary>
+public class MusicService
+{
+    /// <summary>
+    /// Gets the name of a random alternative track for a given file name.
+    /// </summary>
+    /// <param name="fileName">The file name for which to get a replacement track.</param>
+    /// <param name="includeVanilla">Whether to include vanilla tracks or not.</param>
+    /// <param name="includePerStageTracks">Whether to include stage-specific tracks.</param>
+    /// <returns>Path to the replacement track.</returns>
+    public unsafe string GetRandomTrack(string fileName, bool includeVanilla, bool includePerStageTracks);
+
+    /// <summary>
+    /// Obtains all potential candidate tracks for a given stage.
+    /// </summary>
+    /// <param name="stageId">The stage index.</param>
+    /// <param name="files">List of files to add the candidates to.</param>
+    public void GetTracksForStage(int stageId, List<string> files);
+}
+
+
/// <summary>
+/// Converts Sonic Riders' PVRT texture format to DDS using the game's built-in converter.
+/// </summary>
+public class PvrtConverterService : ISingletonService
+{
+    /// <summary>
+    /// Converts a texture to DDS.
+    /// </summary>
+    /// <param name="pvrtData">The PVRT texture to convert.</param>
+    /// <returns>DDS data generated from PVRT.</returns>
+    public unsafe byte[] Convert(Span<byte> pvrtData);
+}
+
+

Controllers (IController)

+
+

Info

+

Controllers contain all the functionality that modifies directly how the game itself functions.
+These controllers usually 'hook' into the game code, by either replacing the method or injecting some assembly code.

+
+

Random Example(s):

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ControllerDescription
MusicInjectionControllerReplaces the music track(s) that will be loaded by the game.
IgnoreTurbulenceControllerThe 'C toggle' for ignoring turbulence if desired.
BorderlessWindowedControllerToggles the game's Borderless Windowed state during startup and in real time.
RailControllerControls the speed of the Rails.
AutoSectionControllerAutomates Left+Right inputs during automated sections.
+

Within controllers there exists one special case, EventController. This controller is implemented mainly in x86 assembly, split over multiple files and provides callbacks which you can subscribe to that modify various game behaviours.

+

For example:
+

EventController.SetRingsOnHit += SetRingsOnHit;
+private void SetRingsOnHit(Player* player) => player->Rings = 42;
+

+ +
+

Info

+

Menus use the IComponent interface and are created + registered during Tweakbox startup.

+
+

Random Example(s):

+ + + + + + + + + + + + + + + + + + + + + +
ControllerDescription
AboutMenuRenders the about page.
TweakboxSettingsRenders the Tweakbox general settings menu.
SlipstreamDebugShows slipstream data in real time.
+

Creating Menus

+

In practice, all menus inherit from ComponentBase or ComponentBase<TConfig>, which provide a default implementation of IComponent.

+

Sample dummy menu (via ComponentBase): +

// Renders 
+public class DummyMenu : ComponentBase
+{
+    public override string Name { get; set; } = "Dummy Menu";
+    public override void Render()
+    {
+        if (ImGui.Begin(Name, ref IsEnabled(), 0))
+        {
+            // Code to render menu here
+
+        }
+
+        ImGui.End();
+    }
+}
+

+

If you need to have a config for this menu, use ComponentBase<TConfig>.

+
// InfoEditorConfig is an IConfiguration
+public class InfoEditor : ComponentBase<InfoEditorConfig>, IComponent
+{
+    public override string Name { get; set; } = "Info Editor";
+
+    // Note the constructor, it passes some stuff to base class.
+    public InfoEditor(IO io) : base(io, io.InfoConfigFolder, io.GetInfoConfigFiles, ".json") { }
+
+    public override void Render()
+    {
+        if (ImGui.Begin(Name, ref IsEnabled(), 0))
+        {
+            // Provides the New/Delete/Load/Save part of the menu.
+            ProfileSelector.Render();
+
+            // Code to render menu here
+        }
+
+        ImGui.End();
+    }
+}
+
+

Registering Menus

+
+

Info

+

Custom Menus must be registered in Tweakbox.cs to show in the overlay.

+
+

Example:
+

new MenuBarItem("Main", new List<IComponent>()
+{
+    // Your custom menu here.
+    Benchmark(() => IoC.GetSingleton<DummyMenu>(), nameof(DummyMenu)), 
+
+    // Previously existing menus.
+    Benchmark(() => IoC.GetSingleton<NetplayMenu>(), nameof(NetplayMenu)),
+    Benchmark(() => IoC.GetSingleton<UserGuideWindow>(), nameof(UserGuideWindow)),
+    Benchmark(() => IoC.GetSingleton<AboutMenu>(), nameof(AboutMenu)),
+    Benchmark(() => IoC.GetSingleton<OpenSourceLibraries>(), nameof(OpenSourceLibraries)),
+})
+

+

Projects

+
+

Info

+

Provides a listing of projects within the Tweakbox source code.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ProjectDescription
Riders.Netplay.MessagesContains all code responsible for writing/reading individual messages over the network.
Riders.Netplay.Messages.TestsTest code for messages library; can be barebones at times.
Riders.Tweakbox.API.SDKCode for communicating with the Web Server providing server browser, ranking.
Riders.TweakboxMain mod code.
Riders.Tweakbox.CharacterPack.DXTest/example mod for adding custom character behaviours. [Ports SRDX 1.0.1 char stats to Tweakbox]
Riders.Tweakbox.GearpackTest/example mod for adding custom gear behaviours. [Ports all gears from all mods released before late 2021]
Riders.Tweakbox.InterfacesAPI for other mods to use. Recommend Reading: Dependency Injection in Reloaded-II
Sewer56.Hooks.UtilitiesHelper code for manipulating game functions with x86 assembly.
Sewer56.ImguiHelpers for creating menus. (Extensions for our Dear ImGui wrapper.)
Sewer56.SonicRidersAPI and definitions for hacking Sonic Riders
+

[Some projects have been omitted to keep the list simpler.]

+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/BookOfTheTweakbox/overlay-helpers/index.html b/BookOfTheTweakbox/overlay-helpers/index.html new file mode 100644 index 00000000..70a247d7 --- /dev/null +++ b/BookOfTheTweakbox/overlay-helpers/index.html @@ -0,0 +1,1033 @@ + + + + + + + + + + + + + + + + + + + + + + + + Overlay Helper APIs - Riders.Tweakbox Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Overlay Helpers

+
+

Info

+

Provides a small listing of helpful classes that may be used for creating UI elements.

+
+

Controls

+
+

Info

+

Contains all custom controls made for the Reloaded UI.

+
+

Tooltips

+
+

About

+

The Tooltip class can be used to display tooltips on individual UI elements.

+
+

+

(Using Tooltip.TextOnHover to display tooltip on last rendered UI element)

+

TextInputData

+
+

About

+

Allocates memory to use in controls that allow the user to manipulate text.

+
+
var username = new TextInputData("", TextLength);
+
+// Calling 'Render' will give you a textbox.
+username.Render("Username");
+
+

The Render method is just for convenience since TextBox (InputText) is the most common control.
+You could use username.Pointer with other text based controls as needed.

+

ProfileSelector

+
+

About

+

Standalone widget for loading configuration files.

+
+

+

Reflection

+
+

Info

+

Wrapper over some parts of the original API for easier drawing of UI elements. Could maybe use better name.

+
+
// Make a control to edit an integer with a parameter
+Reflection.MakeControl(ref bufferSize, "Default Buffer Size");
+
+

This is defined as:
+

// Internal Definition
+public static bool MakeControl(ref Int32 value, string name)
+{
+    return ImGui.DragScalar(name, (int)ImGuiDataType.ImGuiDataTypeS32, (IntPtr) Unsafe.AsPointer(ref value), 1.0F, IntPtr.Zero, IntPtr.Zero, null, 1);
+}
+

+

ImageRenderer

+
+

About

+

You can use this to render native DirectX textures inside the UI.

+
+

Example usage:

+
imageRenderer = new ImageRenderer();
+
+// TextureOut is `LPDIRECT3DTEXTURE9 *ppTexture` as seen in e.g. `D3DXCreateTextureFrom` APIs.
+var texturePtr = (IntPtr)(*currentImage.TextureOut);
+var texture = new Texture(texturePtr);
+var desc = texture.GetLevelDescription(0);
+imageRenderer.SetImageSize(new Vector2(desc.Width, desc.Height));
+imageRenderer.Render(texturePtr);
+
+

+ +
+

About

+

Clickable piece of text that opens a link or file.

+
+
+

Todo

+

Hyperlinks could be improved (change colour on hover, change mouse cursor) etc.

+
+

Use the Hyperlink.CreateText API.

+

+

Layout

+
+

Info

+

Contains helper classes related to setting up the layout of the windows and/or contents.

+
+

WIP

+

Miscellaneous

+

Finalized

+
+

Note

+

This API will probably be removed.

+
+

In the past our Dear ImGui Wrapper which is made using CppSharp didn't have finalizers, which meant not using a using statement or Dispose() may have led to memory leaks. This is no longer the case so this class no longer has any use.

+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/Changelogs/0.3.1/0.3.1/index.html b/Changelogs/0.3.1/0.3.1/index.html new file mode 100644 index 00000000..5a97394c --- /dev/null +++ b/Changelogs/0.3.1/0.3.1/index.html @@ -0,0 +1,848 @@ + + + + + + + + + + + + + + + + + + + + + + 0.3.1 - Riders.Tweakbox Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Changelog

+

The format is based on Keep a Changelog +and this project adheres to Semantic Versioning.

+

Early Access Notice

+

Please note that this project is not yet ready for public consumption. Netplay is still incomplete, buggy and a work in progress. I do not yet consider this project acceptable for normal end users.

+

Please report any issues (especially crashes) using the guidelines provided in Reporting Issues.

+

Do not ask for Tech Support (e.g. "How do I use this mod").

+

0.3.1 - 2021-02-26

+

Commits

+
    +
  • Added: Changelog for 0.3.0 14ecbd6
    • +
  • Changed: Make Netplay Descriptions more User Friendly 7bccddb
    • +
  • Changed: Added Documentation and Updated to 0.3.1 210b3be
    • +
  • Added: Github Pages Task 2df92ce
    • +
  • Fixed: AppVeyor not cloning submodules. 5e1cebd
    • +
  • Changed: Move releases to Github Releases f05ac5d
    • +
+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/Changelogs/0.4.0/0.4.0/index.html b/Changelogs/0.4.0/0.4.0/index.html new file mode 100644 index 00000000..bc40b66d --- /dev/null +++ b/Changelogs/0.4.0/0.4.0/index.html @@ -0,0 +1,965 @@ + + + + + + + + + + + + + + + + + + + + + + + + 0.4.0 - Riders.Tweakbox Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Changelog

+

The format is based on Keep a Changelog +and this project adheres to Semantic Versioning.

+

Early Access Notice

+

Please note that this project is not yet ready for public consumption. Netplay is still incomplete, buggy and a work in progress. I do not yet consider this project acceptable for normal end users.

+

Please report any issues (especially crashes) using the guidelines provided in Reporting Issues.

+

Do not ask for Tech Support (e.g. "How do I use this mod").

+

0.4.0 - 2021-03-03

+

Commits

+

Fixed

+
    +
  • Fixed: Ensure dotnet build removes any previous published builds. c45a435
    • +
  • Fixed: Course select now sets stage on menu exit. de66326
    • +
  • Fixed: Don't allow Modals (popups) at same level. Display one by one. 4f2fb13
    • +
  • Fixed: Possible crashes in RNG sync when only other player disconnects. 89c5711
    • +
  • Fixed: Character Selection not Synced under High Latency 291a56d
    • +
  • Fixed: Single Player Character Models crash in Heroes Story Mode 07fae38
    • +
+

Changed

+
    +
  • Changed: Make Tweaks Editor a bit more User Friendly 7b25adb
    • +
  • Changed: Do not use RunPlayerPhysicsSimulation. Causes crashes. 44eaddd
    • +
  • Changed: Borrow device from GraphicsController in FramePacingController b1a11b4
    • +
  • Changed: Set custom disconnection timeout. 03cc5dc
    • +
  • Changed: Display unexplained disconnections to user. 64d159f
    • +
  • Changed: Separate out Menu & Shell Rendering 0e98422
    • +
  • Changed: Combined Adaptive Jitter Buffer into Single Class 13edec7
    • +
+

Optimized

+
    +
  • Optimized: Remove only peers who didn't report ready in RNG sync f012235
    • +
  • Optimized: Reduce delay time before race is started using probability. 3985c01
    • +
  • Optimized: Make Time Deltas More Accurate 09e4921
    • +
  • Log: Make LogItem a struct to reduce heap allocations. 51e0730
    • +
+

Added

+
    +
  • Added: Prerequisites Section to Installation Page f38833c
    • +
  • Added: [Debug] Make Bad Internet Simulation Adjustable on the Fly e512cce
    • +
  • Added: Experiment for measuring jitter in jitter buffer. 7592027
    • +
  • Added: Adaptive Jitter Buffer 7b52367
    • +
  • Added: Low Latency "Adaptive" Jitter Buffer 0539d1b
    • +
  • Added: Code that would allow for changing buffers in the future. 09ce4e0
    • +
  • Added: Fast Increment Adaptive Buffer c641028
    • +
  • Added: Hybrid Jitter Buffer b24e6e9
    • +
  • Added: Jitter Buffer Options to Player Settings dbf4f27
    • +
  • Added: Tooltips to the various buffer settings. 816e8b7
    • +
  • Added: Additional notes to "Installation". 539f4cc
    • +
  • Added: Updated DearImguiSharp & Added First Time Welcome Screen f9bed60
    • +
  • Added: Disconnect Reasons for Clients 57023a0
    • +
  • Feature: Automatic Crash Dump Creation e2cf282
    • +
  • Added: Clone method for BitPackedArrays efeed89
    • +
  • Added: Small amounts of error handling throughout Netplay code. 7557505
    • +
  • Added: Logs can now log separately to UI and Console ba30ac0
    • +
  • Feature: Notify user on injection of incompatible DLL. 5522c04
    • +
  • Feature: Try Blocking DLL injection for DLLs that cause issues. 42a1f2d
    • +
  • Feature: Lie about successful DLL injection for blocked DLLs. 9888927
    • +
+

Removed

+
    +
  • Removed: Dead code from unused global config file. 75c16d5
    • +
+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/Changelogs/0.5.0/0.5.0/index.html b/Changelogs/0.5.0/0.5.0/index.html new file mode 100644 index 00000000..4d395880 --- /dev/null +++ b/Changelogs/0.5.0/0.5.0/index.html @@ -0,0 +1,1274 @@ + + + + + + + + + + + + + + + + + + + + + + + + 0.5.0 - Riders.Tweakbox Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Changelog

+

The format is based on Keep a Changelog +and this project adheres to Semantic Versioning.

+

This document lists all changes

+

Release Description (0.5.0)

+

This is a beta release. +It's huge, probably the biggest update since initial test builds but a beta version nonetheless.

+

Some of the features of this release are not fully tested; as I am unfortunately stressed, lacking in time and with real life things to sort out.

+

I'm willing to make some time to fix minor bugs but don't expect major development soon.

+

Early Access Notice

+

Please note that this project is not yet ready for public consumption. +Netplay still has flaws. Very minor issues, but flaws nonetheless. +I do not yet consider this project to be of production quality.

+

Please report any issues (especially crashes) using the guidelines provided in Reporting Issues.

+

Do not ask for Tech Support (e.g. "How do I use this mod").

+

Features

+

Graphics Improvements

+

Tweakbox 0.5.0 comes with many improvements with regards to how graphics and rendering are handled within the game.

+

To name a few changes:

+
    +
  • You can now change resolution in real time.
    • +
  • You can now go to full-screen without restarting the game.
    • +
  • The game can now instantly be minimized and maximized from/to full-screen.
    • +
  • The graphics menu has been simplified and made easier to use.
    • +
  • The game window no longer resets itself to the corner after a User Account Control (UAC) prompt is shown.
    • +
  • The game now fully supports Direct3D9Ex; and all its benefits.
    • +
+

+

Breaking Limits

+

Version 0.5.0 extends many of the built-in game limits to better accomodate modern hardware and mods of the future.

+

Examples include:

+
    +
  • The game can now load up to 768MB of assets at any given time. (from 50MB)*
    • +
  • The game can now execute 40960 tasks (objects, effects etc.) in total. (from 1024)
    • +
  • Stages can now have a maximum of 8192 collision objects. (from 600)
    • +
+

* This limit is further extended to 2GB is a patch known as 'Large Address Aware' is applied to the game's exe file. In 0.5.0, this limit was set at startup. In 0.5.4+, this limit is configurable and accessible via Tweakbox Settings -> Startup.

+

Discord Rich Presence Support

+

Tweakbox now ships with complete Discord information; including reporting both information about your current game status and your Netplay Session.

+

+

And of course, Discord invites are supported too:

+

+

Server Browser

+

You can now more easily find games hosted by other people by using the built-in server browser.

+

+

(This is just some test data)

+

The Server Browser is powered by a home made, in house built web server which was made specifically for Riders.Tweakbox. There will be more features in the future such as Ranked Play, Elo-like Match Making Rating and Statistics Tracking. Those are already implemented server side.

+

Netplay Modifiers

+

Support for various "Modifiers", or ways in which you can customize your own Netplay lobby have been added. For now, the features are limited but extended features will come in the future.

+

+

Turbulence everywhere... even in running mode.

+

Music Injection

+

Tweakbox now allows you to add custom ADX music to the game by creating external Reloaded-II mods.
+This allows you to provide alternative tracks to the game's default soundtrack.

+

When the game is about to play a music track, Tweakbox will randomly choose from one of your own music tracks.

+

+

Tweakbox allows you to replace music using two modes:

+
    +
  • Per Stage
    • +
  • Per File
    • +
+

The example above shows per-stage music injection.

+

There is no limit to this feature. If you want 20GB worth of 4000 music tracks or 500 music tracks for a single stage, be my guest.
+For more details, refer to Tweakbox' documentation.

+

Texture Injection

+

Tweakbox now allows you to replace textures in real-time by hijacking function calls to the Direct3D 9 API.
+Similar to how Dolphin Emulator handles it, you can inject textures without the need to modify game files.

+

+

Textures are supported in the following formats:

+
    +
  • PNG
    • +
  • DDS
    • +
  • DDS.LZ4 (Custom)
    • +
+

Creation of texture packs is easy, with a step by step guide available in the documentation.

+

Animated Texture Injection

+

If you desire a bit more style, and wish to flex on the people emulating the GameCube version of the game, Tweakbox allows you to add basic animation to any texture:

+

+

+

For more details, refer to Tweakbox' documentation.

+

Texture Dumping

+

You can also dump textures from the game as they are loaded in real-time.

+

+

The texture dump tool comes with multiple modes; such as:

+
    +
  • Only New mode which doesn't dump textures already dumped.
    • +
  • Deduplication mode, which puts textures with more than X duplicates in a Common folder.
    • +
+

Chances are that you wouldn't need to texture dump yourself though; as I've gone through the effort of dumping 3000+ textures on my own, with perfect dumps for every single stage.

+

With the improved texture dumping tools and some clever usage of them, the texture archive I made in the span of a day is more complete and accurate than what's been available for the GameCube version over the last 2 years.

+

Here's a link to my texture archive, it contains ~99% of all of the game's textures.

+

Texture Cache

+

Starting with 0.5.5+ Tweakbox also maintains a built-in texture cache to work around slow loading times of PNG textures.

+

When a PNG is loaded for the first time and its mipmaps are generated, the texture will be converted to the optimal DDS.LZ4 custom format for future use. Subsequent uses of the texture will instead load from the cache which is many magnitudes faster. The conversion happens in the background and is multithreaded, so you should not notice a difference in first time load performance compared to previously loading a PNG (< 0.5.5).

+

Editing the original PNG image will cause the cached texture for that file to be invalidated, and a new DDS.LZ4 will be automatically created. Please note that the underlying cached DDS is uncompresed and eats memory for breakfast. Consider manually creating DDSes with DXT1 / DXT5 if you are working with e.g. Animated Textures. More info in the documentation.

+

Object Layout Editor

+

Tweakbox now has a built-in, fully featured object layout editor; allowing you to:

+
    +
  • Add objects
    • +
  • Remove objects
    • +
  • Transform objects (scale, rotate, move)
    • +
  • Change object properties.
    • +
  • Save & Load Object Layouts.
    • +
  • Export object layout to GameCube/PS2/Xbox/PC.
    +... and much more
    • +
+

+

Oh, by the way, these itemboxes (and some others) are unused in the final game, hehehe.
+If you would like additional features, such as racing online with custom layouts, let me know.

+

By the way... you can also now play Battle Mode in regular race stages hehehe...

+

End of Race Synchronization & Pause Menu

+

The players now have their own individual pause menus, allowing you to restart and exit the race (if host) or disconnect from the current lobby.

+

+

+

The pause menu after the results screen has also been replaced with a custom menu allowing the host to choose what to do next.

+

Version & Other Sanity Checks

+

In Netplay, Tweakbox will now make basic sanity checks such as:

+
    +
  • Ensuring that all clients are running the same version of Tweakbox.
    • +
  • Ensuring all clients are using the same Tweakbox extensions/plugins.
    • +
  • Ensuring all clients are running the same game mode.
    • +
+

+

Turbulence Editing

+

Tweakbox now allows you to edit turbulence physics and speeds. For every single variation of Turbulence used by the game.

+

+

Of course, as with all features listed above and below, it syncs with host over Netplay.

+

Object Behaviour Changing

+

Tweakbox can now change the behaviour of some common objects in the game; for example:

+
    +
  • Making dash panels give you additional speed to your current speed.
    • +
  • Making dash panels multiply your current speed.
    • +
  • Making dash panels give you a minimum amount of speed.
    • +
+

+

Custom Deceleration Behaviour

+

Tweakbox can now change how the game handles deceleration; overriding the game's built in exponential deceleration with alternative options.

+

One of the options is Linear deceleration; which makes you decelerate at a constant rate regardless of how far above top speed you are.

+

You can now spam your "JCBCDPC"dsdasdasfdsjdfuisdfhsid(s).

+

+

The numbers in this screenshot are actually what Sonic Riders DX and Sonic Riders TE 1.3 use.

+

Boot to Stage

+

The mod now allows you to boot directly into a race (no menu navigation required) with a specific stage, character and gear combination. This is incredibly useful when testing mods.

+

Return to Track Select

+

The mod now allows you to return directly into the track select menu after returning from a race. +This works with all game modes, unlike the implementations in the current popular GameCube version mods.

+

Miscellaneous

+
    +
  • Changed: Connecting to a game does not freeze the game window until a connection is established.
    • +
  • Renamed: Various Tweaks to Tweakbox Settings.
    • +
  • Updated: Readme & Documentation Pages for all new and existing features.
    • +
  • Updated: Libraries used behind the hood.
    • +
  • Minor Performance Optimisations
    • +
+

... and more

+

Fixes

+
    +
  • Fixed: Having the same submenu open in the gear editor for multiple gears at once causes you to only be able to interact with the first one.
    • +
  • Fixed: Memory Leak in Boot To Menu
    • +
+

... and more

+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/Changelogs/0.5.0/AnimTexture.png b/Changelogs/0.5.0/AnimTexture.png new file mode 100644 index 00000000..c749fd45 Binary files /dev/null and b/Changelogs/0.5.0/AnimTexture.png differ diff --git a/Changelogs/0.5.0/AnimTexture.webp b/Changelogs/0.5.0/AnimTexture.webp new file mode 100644 index 00000000..60b12341 Binary files /dev/null and b/Changelogs/0.5.0/AnimTexture.webp differ diff --git a/Changelogs/0.5.0/Deceleration.png b/Changelogs/0.5.0/Deceleration.png new file mode 100644 index 00000000..bf15897b Binary files /dev/null and b/Changelogs/0.5.0/Deceleration.png differ diff --git a/Changelogs/0.5.0/DiscordRPC.png b/Changelogs/0.5.0/DiscordRPC.png new file mode 100644 index 00000000..4a964acf Binary files /dev/null and b/Changelogs/0.5.0/DiscordRPC.png differ diff --git a/Changelogs/0.5.0/DiscordRPCInvite.png b/Changelogs/0.5.0/DiscordRPCInvite.png new file mode 100644 index 00000000..787735cc Binary files /dev/null and b/Changelogs/0.5.0/DiscordRPCInvite.png differ diff --git a/Changelogs/0.5.0/GraphicsMenu.png b/Changelogs/0.5.0/GraphicsMenu.png new file mode 100644 index 00000000..91f86544 Binary files /dev/null and b/Changelogs/0.5.0/GraphicsMenu.png differ diff --git a/Changelogs/0.5.0/LayoutEditor.png b/Changelogs/0.5.0/LayoutEditor.png new file mode 100644 index 00000000..d01a1e17 Binary files /dev/null and b/Changelogs/0.5.0/LayoutEditor.png differ diff --git a/Changelogs/0.5.0/Modifiers.png b/Changelogs/0.5.0/Modifiers.png new file mode 100644 index 00000000..5b8b921f Binary files /dev/null and b/Changelogs/0.5.0/Modifiers.png differ diff --git a/Changelogs/0.5.0/MusicInjection.png b/Changelogs/0.5.0/MusicInjection.png new file mode 100644 index 00000000..fda9485b Binary files /dev/null and b/Changelogs/0.5.0/MusicInjection.png differ diff --git a/Changelogs/0.5.0/ObjectBehaviour.png b/Changelogs/0.5.0/ObjectBehaviour.png new file mode 100644 index 00000000..8495ecaf Binary files /dev/null and b/Changelogs/0.5.0/ObjectBehaviour.png differ diff --git a/Changelogs/0.5.0/ResultsAndPause1.png b/Changelogs/0.5.0/ResultsAndPause1.png new file mode 100644 index 00000000..d3771834 Binary files /dev/null and b/Changelogs/0.5.0/ResultsAndPause1.png differ diff --git a/Changelogs/0.5.0/ResultsAndPause2.png b/Changelogs/0.5.0/ResultsAndPause2.png new file mode 100644 index 00000000..decf7823 Binary files /dev/null and b/Changelogs/0.5.0/ResultsAndPause2.png differ diff --git a/Changelogs/0.5.0/ServerBrowser.png b/Changelogs/0.5.0/ServerBrowser.png new file mode 100644 index 00000000..ab297bca Binary files /dev/null and b/Changelogs/0.5.0/ServerBrowser.png differ diff --git a/Changelogs/0.5.0/TextureDump.png b/Changelogs/0.5.0/TextureDump.png new file mode 100644 index 00000000..74d30f74 Binary files /dev/null and b/Changelogs/0.5.0/TextureDump.png differ diff --git a/Changelogs/0.5.0/TextureInjection.png b/Changelogs/0.5.0/TextureInjection.png new file mode 100644 index 00000000..c342a537 Binary files /dev/null and b/Changelogs/0.5.0/TextureInjection.png differ diff --git a/Changelogs/0.5.0/Turbulence.png b/Changelogs/0.5.0/Turbulence.png new file mode 100644 index 00000000..cd7befd3 Binary files /dev/null and b/Changelogs/0.5.0/Turbulence.png differ diff --git a/Changelogs/0.5.0/VersionMismatch.png b/Changelogs/0.5.0/VersionMismatch.png new file mode 100644 index 00000000..7109c0fe Binary files /dev/null and b/Changelogs/0.5.0/VersionMismatch.png differ diff --git a/Changelogs/0.6.0/0.6.0/index.html b/Changelogs/0.6.0/0.6.0/index.html new file mode 100644 index 00000000..646b843b --- /dev/null +++ b/Changelogs/0.6.0/0.6.0/index.html @@ -0,0 +1,1246 @@ + + + + + + + + + + + + + + + + + + + + + + + + 0.6.0 - Riders.Tweakbox Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Changelog

+

The format is based on Keep a Changelog +and this project adheres to Semantic Versioning.

+

This document lists all changes

+

Release Description (0.6.0)

+

This is a beta release.

+

This release mostly consists of additional polish in existing features, albeit there are some new toys to play with (one of them is really impressive!).

+

Most of the features in this release have been tested, though there may be some odd things here and there around the edges; as I've still other things to do outside of Riders.

+

Please report bugs (no matter how minor); I'll do what I can to test them in a timely manner.

+

Early Access Notice

+

Please note that this project is not yet ready for public consumption. +Netplay still has flaws. Very minor issues, but flaws nonetheless. +I do not yet consider this project to be of production quality.

+

Please report any issues (especially crashes) using the guidelines provided in Reporting Issues.

+

Do not ask for Tech Support (e.g. "How do I use this mod").

+

Features

+

Custom Gear Support

+

The staple feature of this patch.

+

+

Tweakbox now supports the addition of fully custom gears; that is, having customized gears without having to replace the vanilla gears.

+

Here's some details:

+
    +
  • Custom gears can be normally selected from Character Select; no magic buttons required.
    • +
  • You can have up to 214 custom gears (255 gears total).
    • +
  • Custom gears are Supported in Netplay (requires more testing).
    • +
  • Custom gears can have custom icons and names in Character Select.
    • +
  • Custom gears can be edited from within the built-in gear editor.
    • +
  • You can export any gear from Gear Editor into a brand new custom gear.
    • +
+

What's left? +- Custom model support for custom gears. (Will implement on demand)

+

Enhanced Texture Tools

+

Some minor improvements have been made to existing texture injection tools used in Riders; for example the introduction of the texture viewer tool.

+

+

The texture viewer allows you to preview all currently loaded textures in real time; which makes the creation of texture packs or finding hashes for your custom textures more convenient.

+

Oh, by the way, this is the debug menu font! It's not there in the console releases <3.

+

+

It's also now possible reload textures in real time; allowing for changes to be seen without having to re-load the menu/stage; as well as see a list of all texture redirections that have been made. Useful stuff!

+

Widget Support

+

Tweakbox now has the ability to display various widgets on the screen.

+

Widgets can be pinned to any edge or corner of the screen and display information such as, FPS, Frame Time, CPU and Memory Usage to the screen.

+

+

The user can add or remove as many widgets as they like.

+

Cleaned Up Settings Menu

+

The layout of the settings menu has been cleaned up for better organization and accessibility. Related settings are now grouped together under expandable trees.

+

+

Forced Netplay Settings

+

Version 0.6.0 adds a feature which forces certain settings to be enabled while in Netplay mode:

+
    +
  • Enable return to Stage Select from Race/Survival/Tag
    • +
  • Enable driving backwards.
    • +
  • Enable FPS cap.
    • +
+

These features cannot be toggled while participating in Netplay; and are enabled to ensure consistency between all players.

+

Chatbox In Netplay

+

+

Come across a random player in Netplay? +Fear no more! You can talk now.

+

*You even get notified if your Netplay window is minimized, win-win!.

+

Enhanced Input Blocking

+

+

A few small changes here: +- You can customize the hotkey used to toggle passing input to the game. +- Blocking input passed to the game now works regardless of mod load order when used with Controller Hook. +- You can now make Tweakbox not pass inputs to game if any of its Windows are activated/being used.

+

Improved Logging Efficiency

+

Starting with version 0.6.0, Tweakbox uses an upcoming C# 10 feature called Improved Interpolated Strings which allows for more efficient logging.

+

Notably, if the log level/category for a specific message is not enabled, the string will not even be constructed at all; saving both time and unnecessary memory allocations without the need of writing repetive, redundant ugly checks on every log operation.

+

Heap Allocation Viewer

+

Starting with version 0.6.0, there's a cool little utility for tracking allocations made to the game's native heap.

+

+

This is a result of my study into how the game handles memory allocations.

+

Sometimes it doesn't seem to work perfectly yet for the Front side (if there's an issue, you'll experience game lag); as the front side of the heap wasn't really designed to be walked through, and game doesn't clean up properly sometimes. Most of the time however it works perfectly fine.

+

The back side works perfectly without issue.

+

Adding: "Game Modifiers"

+

The "Race Settings" in Netplay Menu has now been moved to the Tweakbox Settings menu and rebranded as Game Modifiers.

+

These settings can now be applied to any race; not just netplay races.

+

+

In addition, a number of new modifiers have been added, including: +- Disable Attacks for First X Milliseconds in Race.
+- No Screenpeeking (Netplay)
+- Custom Ring Loss on Death
+- Custom Ring Loss on Hit
+- No Turbulence
+- Slipstream

+

Improved Loading Times

+

Starting with version 0.6.0, race loading times have been improved by up to 60%. +Previously loading an 8 player race has taken around 2.5 seconds, now it takes 1.5 seconds.

+

Improved Startup Times

+

Tweakbox now obsoletes a third party file caching mechanism from CRI Middleware originally used in Riders. This improves the initial cold boot startup time by around 10 seconds.

+

Note: "Cold Booting" refers to running the game after a PC restart or after some time has passed since last launch.

+

Animated Texture Improvements

+

There's a collection of minor improvements related to animated textures:

+
    +
  • Texture Cache: Animated textures are now automatically packed into a single archive to improve performance.
    • +
+

The archive consists of a list of raw DDS files compressed using lz4. + This significantly improves load times when many frames are used.

+
    +
  • Animated textures will now load in the background without stalling the game startup process.
    • +
+

The game will now use the first frame of the animated texture until loading of the remaining frames is ready. +This prevents stutters on loading animated textures outside of load screens (e.g. Character Select).

+
    +
  • Tweakbox will now warn when high frame count animated textures are using an unoptimal format.
    • +
+

Layout Editor Improvements

+

The in-mod layout editor has received some minor improvements:

+
    +
  • +

    Safe Mode: Prevents updating object data in real time to ensure moving some objects (e.g. Rings) does not lead to crashes.

    +
    • +
  • +

    Autosave: The layout editor will now create an automatic save of the at regular time intervals. Useful in case you encounter a crash.

    +
    • +
+

+

In-Game Language Change

+

The language of both the game's text and voice can now be changed on the fly. +Some changes (e.g. menu voices) are applied in real time, however others (e.g. localized menu assets) only apply after the next loading screen.

+

Improved Tweakbox Startup Times

+

Startup time of Tweakbox itself has been improved in verison 0.6.0, by approximately 75%. Startup now takes 0.7 seconds, instead of 1.2 seconds.

+

Missing Model Fallback

+

When a model for a specific gear is missing (e.g. Sonic + Riders DX Advantage F); Tweakbox will now default to loading the default gear model for that gear type.

+

i.e. For boards it will load Default Gear, for skates it will load Darkness and for bikes it will load E-Rider.

+

This should prevent Tweakbox from crashing when from gear data from the GameCube mods are imported to Tweakbox. (Since those have custom model archives.)

+

Feature: Auto Decompress Game Data

+

Tweakbox will now automatically decompress all game files on boot if it detects that they have not been previously decompressed.

+

Miscellaneous

+
    +
  • Added: About Screen
    • +
  • Added: Toggle FPS Cap.
    • +
  • C#10 Features (Logging Improvements, File Scoped Namespaces)
    • +
  • Fixed: Workaround for CPU Usage monitoring not working for some users.
    • +
  • Fixed: Bad link in GitHub repository for documentation.
    • +
  • Fixed: Softlock in results screen on Netplay if host quits before client opens screen.
    • +
  • Fixed: Bug causing the last frame of an animated texture to be skipped.
    • +
  • Fixed: Tweakbox crashes under DXVK. (Might work on Linux now too)
    • +
  • Fixed: Tweakbox no longer crashes on failing to connect to NAT Punching Server.
    • +
  • Added: Tweakbox will now report unhandled errors/exceptions in the log.
    • +
  • Added: An option to disable particles in case of performance issues.
    • +
  • Added: Recommendation to use DXVK in the Graphics tab.
    • +
  • Changed: Do not fast forward if game resets frame counter (e.g. after load screens).
    • +
  • Improved: Texture decompression performance (by a tiny amount).
    • +
  • Changed: Made frame pacing more aggressive (slightly increased CPU usage for better pacing).
    • +
  • Changed: Made process high priority for frame pacing reasons.
    • +
+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/Changelogs/0.6.0/Chatbox.png b/Changelogs/0.6.0/Chatbox.png new file mode 100644 index 00000000..70ad2722 Binary files /dev/null and b/Changelogs/0.6.0/Chatbox.png differ diff --git a/Changelogs/0.6.0/CleanSettings.png b/Changelogs/0.6.0/CleanSettings.png new file mode 100644 index 00000000..ac9ea16b Binary files /dev/null and b/Changelogs/0.6.0/CleanSettings.png differ diff --git a/Changelogs/0.6.0/CustomGears.png b/Changelogs/0.6.0/CustomGears.png new file mode 100644 index 00000000..4bf5c7b3 Binary files /dev/null and b/Changelogs/0.6.0/CustomGears.png differ diff --git a/Changelogs/0.6.0/EnhancedInput.png b/Changelogs/0.6.0/EnhancedInput.png new file mode 100644 index 00000000..b8400f29 Binary files /dev/null and b/Changelogs/0.6.0/EnhancedInput.png differ diff --git a/Changelogs/0.6.0/HeapViewer.png b/Changelogs/0.6.0/HeapViewer.png new file mode 100644 index 00000000..2fb2fa0e Binary files /dev/null and b/Changelogs/0.6.0/HeapViewer.png differ diff --git a/Changelogs/0.6.0/ImprovedLayoutEditor.png b/Changelogs/0.6.0/ImprovedLayoutEditor.png new file mode 100644 index 00000000..81385d05 Binary files /dev/null and b/Changelogs/0.6.0/ImprovedLayoutEditor.png differ diff --git a/Changelogs/0.6.0/InfoWidgets.png b/Changelogs/0.6.0/InfoWidgets.png new file mode 100644 index 00000000..3a140429 Binary files /dev/null and b/Changelogs/0.6.0/InfoWidgets.png differ diff --git a/Changelogs/0.6.0/Modifiers.png b/Changelogs/0.6.0/Modifiers.png new file mode 100644 index 00000000..eab44c58 Binary files /dev/null and b/Changelogs/0.6.0/Modifiers.png differ diff --git a/Changelogs/0.6.0/TextureTools.png b/Changelogs/0.6.0/TextureTools.png new file mode 100644 index 00000000..d65e273f Binary files /dev/null and b/Changelogs/0.6.0/TextureTools.png differ diff --git a/Changelogs/0.6.0/TextureViewer.png b/Changelogs/0.6.0/TextureViewer.png new file mode 100644 index 00000000..f0619ab1 Binary files /dev/null and b/Changelogs/0.6.0/TextureViewer.png differ diff --git a/Images/API_Tutorial_0.png b/Images/API_Tutorial_0.png new file mode 100644 index 00000000..db5e56e6 Binary files /dev/null and b/Images/API_Tutorial_0.png differ diff --git a/Images/API_Tutorial_1.png b/Images/API_Tutorial_1.png new file mode 100644 index 00000000..9be7bee5 Binary files /dev/null and b/Images/API_Tutorial_1.png differ diff --git a/Images/API_Tutorial_2.png b/Images/API_Tutorial_2.png new file mode 100644 index 00000000..a6326798 Binary files /dev/null and b/Images/API_Tutorial_2.png differ diff --git a/Images/API_Tutorial_3.png b/Images/API_Tutorial_3.png new file mode 100644 index 00000000..b1354859 Binary files /dev/null and b/Images/API_Tutorial_3.png differ diff --git a/Images/API_Tutorial_4.png b/Images/API_Tutorial_4.png new file mode 100644 index 00000000..cff1f0c6 Binary files /dev/null and b/Images/API_Tutorial_4.png differ diff --git a/Images/Editors.png b/Images/Editors.png new file mode 100644 index 00000000..33eac088 Binary files /dev/null and b/Images/Editors.png differ diff --git a/Images/EnvironmentVariable.png b/Images/EnvironmentVariable.png new file mode 100644 index 00000000..2196ca4d Binary files /dev/null and b/Images/EnvironmentVariable.png differ diff --git a/Images/Gear_Tutorial_1.png b/Images/Gear_Tutorial_1.png new file mode 100644 index 00000000..c31284dc Binary files /dev/null and b/Images/Gear_Tutorial_1.png differ diff --git a/Images/Gear_Tutorial_2.png b/Images/Gear_Tutorial_2.png new file mode 100644 index 00000000..39a3a5e6 Binary files /dev/null and b/Images/Gear_Tutorial_2.png differ diff --git a/Images/Gear_Tutorial_3.png b/Images/Gear_Tutorial_3.png new file mode 100644 index 00000000..005a6e57 Binary files /dev/null and b/Images/Gear_Tutorial_3.png differ diff --git a/Images/Gear_Tutorial_4.png b/Images/Gear_Tutorial_4.png new file mode 100644 index 00000000..b9fae3fb Binary files /dev/null and b/Images/Gear_Tutorial_4.png differ diff --git a/Images/Gear_Tutorial_5.png b/Images/Gear_Tutorial_5.png new file mode 100644 index 00000000..451856fe Binary files /dev/null and b/Images/Gear_Tutorial_5.png differ diff --git a/Images/Gear_Tutorial_6.png b/Images/Gear_Tutorial_6.png new file mode 100644 index 00000000..30ea5f6e Binary files /dev/null and b/Images/Gear_Tutorial_6.png differ diff --git a/Images/Gear_Tutorial_7.png b/Images/Gear_Tutorial_7.png new file mode 100644 index 00000000..447713ae Binary files /dev/null and b/Images/Gear_Tutorial_7.png differ diff --git a/Images/Gear_Tutorial_8.png b/Images/Gear_Tutorial_8.png new file mode 100644 index 00000000..784f6696 Binary files /dev/null and b/Images/Gear_Tutorial_8.png differ diff --git a/Images/Gear_Tutorial_Animated_1.png b/Images/Gear_Tutorial_Animated_1.png new file mode 100644 index 00000000..58be9242 Binary files /dev/null and b/Images/Gear_Tutorial_Animated_1.png differ diff --git a/Images/Gear_Tutorial_Animated_2.png b/Images/Gear_Tutorial_Animated_2.png new file mode 100644 index 00000000..ffda9ca9 Binary files /dev/null and b/Images/Gear_Tutorial_Animated_2.png differ diff --git a/Images/Gear_Tutorial_Demo.png b/Images/Gear_Tutorial_Demo.png new file mode 100644 index 00000000..d5188e19 Binary files /dev/null and b/Images/Gear_Tutorial_Demo.png differ diff --git a/Images/Installation.png b/Images/Installation.png new file mode 100644 index 00000000..bad263b2 Binary files /dev/null and b/Images/Installation.png differ diff --git a/Images/IssueReport_Log_Part1.png b/Images/IssueReport_Log_Part1.png new file mode 100644 index 00000000..9446508d Binary files /dev/null and b/Images/IssueReport_Log_Part1.png differ diff --git a/Images/IssueReport_Log_Part2.png b/Images/IssueReport_Log_Part2.png new file mode 100644 index 00000000..c97f5f1b Binary files /dev/null and b/Images/IssueReport_Log_Part2.png differ diff --git a/Images/IssueReport_MiniDump.png b/Images/IssueReport_MiniDump.png new file mode 100644 index 00000000..148c7b55 Binary files /dev/null and b/Images/IssueReport_MiniDump.png differ diff --git a/Images/Music_Tutorial_1.png b/Images/Music_Tutorial_1.png new file mode 100644 index 00000000..20350b93 Binary files /dev/null and b/Images/Music_Tutorial_1.png differ diff --git a/Images/Music_Tutorial_2.png b/Images/Music_Tutorial_2.png new file mode 100644 index 00000000..f596fd0f Binary files /dev/null and b/Images/Music_Tutorial_2.png differ diff --git a/Images/Music_Tutorial_3.png b/Images/Music_Tutorial_3.png new file mode 100644 index 00000000..53f27b7b Binary files /dev/null and b/Images/Music_Tutorial_3.png differ diff --git a/Images/Music_Tutorial_4.png b/Images/Music_Tutorial_4.png new file mode 100644 index 00000000..97b3e031 Binary files /dev/null and b/Images/Music_Tutorial_4.png differ diff --git a/Images/Music_Tutorial_5.png b/Images/Music_Tutorial_5.png new file mode 100644 index 00000000..f3523a11 Binary files /dev/null and b/Images/Music_Tutorial_5.png differ diff --git a/Images/Music_Tutorial_6.png b/Images/Music_Tutorial_6.png new file mode 100644 index 00000000..fda9485b Binary files /dev/null and b/Images/Music_Tutorial_6.png differ diff --git a/Images/Music_Tutorial_7.png b/Images/Music_Tutorial_7.png new file mode 100644 index 00000000..d114096d Binary files /dev/null and b/Images/Music_Tutorial_7.png differ diff --git a/Images/Music_Tutorial_Settings.png b/Images/Music_Tutorial_Settings.png new file mode 100644 index 00000000..aabe2146 Binary files /dev/null and b/Images/Music_Tutorial_Settings.png differ diff --git a/Images/SRPC_Logo_Ver1.png b/Images/SRPC_Logo_Ver1.png new file mode 100644 index 00000000..f704897d Binary files /dev/null and b/Images/SRPC_Logo_Ver1.png differ diff --git a/Images/SingleScreen.png b/Images/SingleScreen.png new file mode 100644 index 00000000..439f66f4 Binary files /dev/null and b/Images/SingleScreen.png differ diff --git a/Images/Template/Photoshop.7z b/Images/Template/Photoshop.7z new file mode 100644 index 00000000..4e0dfe19 Binary files /dev/null and b/Images/Template/Photoshop.7z differ diff --git a/Images/Texture_Tutorial_1.png b/Images/Texture_Tutorial_1.png new file mode 100644 index 00000000..c5288b99 Binary files /dev/null and b/Images/Texture_Tutorial_1.png differ diff --git a/Images/Texture_Tutorial_2.png b/Images/Texture_Tutorial_2.png new file mode 100644 index 00000000..ab03534f Binary files /dev/null and b/Images/Texture_Tutorial_2.png differ diff --git a/Images/Texture_Tutorial_3.png b/Images/Texture_Tutorial_3.png new file mode 100644 index 00000000..8bdf02c2 Binary files /dev/null and b/Images/Texture_Tutorial_3.png differ diff --git a/Images/Texture_Tutorial_4.png b/Images/Texture_Tutorial_4.png new file mode 100644 index 00000000..42b526c3 Binary files /dev/null and b/Images/Texture_Tutorial_4.png differ diff --git a/Images/Texture_Tutorial_5.png b/Images/Texture_Tutorial_5.png new file mode 100644 index 00000000..1c940c20 Binary files /dev/null and b/Images/Texture_Tutorial_5.png differ diff --git a/Images/Texture_Tutorial_6.png b/Images/Texture_Tutorial_6.png new file mode 100644 index 00000000..05a21b70 Binary files /dev/null and b/Images/Texture_Tutorial_6.png differ diff --git a/Images/Texture_Tutorial_7.png b/Images/Texture_Tutorial_7.png new file mode 100644 index 00000000..93cc967c Binary files /dev/null and b/Images/Texture_Tutorial_7.png differ diff --git a/Images/Texture_Tutorial_8.png b/Images/Texture_Tutorial_8.png new file mode 100644 index 00000000..ffd551b5 Binary files /dev/null and b/Images/Texture_Tutorial_8.png differ diff --git a/Images/Texture_Tutorial_Animated_0.png b/Images/Texture_Tutorial_Animated_0.png new file mode 100644 index 00000000..a390f17a Binary files /dev/null and b/Images/Texture_Tutorial_Animated_0.png differ diff --git a/Images/Texture_Tutorial_Animated_1.png b/Images/Texture_Tutorial_Animated_1.png new file mode 100644 index 00000000..c749fd45 Binary files /dev/null and b/Images/Texture_Tutorial_Animated_1.png differ diff --git a/Images/Texture_Tutorial_Animated_2.png b/Images/Texture_Tutorial_Animated_2.png new file mode 100644 index 00000000..6e075574 Binary files /dev/null and b/Images/Texture_Tutorial_Animated_2.png differ diff --git a/Images/Texture_Tutorial_Animated_3.png b/Images/Texture_Tutorial_Animated_3.png new file mode 100644 index 00000000..18db7294 Binary files /dev/null and b/Images/Texture_Tutorial_Animated_3.png differ diff --git a/Images/Texture_Tutorial_Animated_4.png b/Images/Texture_Tutorial_Animated_4.png new file mode 100644 index 00000000..e4617d9a Binary files /dev/null and b/Images/Texture_Tutorial_Animated_4.png differ diff --git a/Preview/preview/index.html b/Preview/preview/index.html new file mode 100644 index 00000000..ed1a894c --- /dev/null +++ b/Preview/preview/index.html @@ -0,0 +1,750 @@ + + + + + + + + + + + + + + + + + + + + + + + + About - Riders.Tweakbox Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

About Preview Features

+

Preview features refer to currently "work-in-progress" features.

+

These features are generally available in the current release but are not finalized and/or may have potential slight changes in the future.

+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/Preview/tweakbox-api/index.html b/Preview/tweakbox-api/index.html new file mode 100644 index 00000000..2e3cd044 --- /dev/null +++ b/Preview/tweakbox-api/index.html @@ -0,0 +1,1148 @@ + + + + + + + + + + + + + + + + + + + + + + + + Tweakbox API - Riders.Tweakbox Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Tweakbox API

+

Starting with version 0.7.0, Tweakbox offers a built-in API which allows you to control Tweakbox functionality as well as perform certain other operations which affect the state of the game.

+

Getting Started

+

Setup usually takes around 2 minutes if you know what you're doing. If you're new to programming however, it might take you a while, be patient!

+

Create a Reloaded-II Mod.

+

Refer to the Reloaded-II wiki ("Building Mods") for guidance.

+

Clone this repository.

+
git clone --recursive https://github.com/Sewer56/Riders.Tweakbox.git
+
+

or add as git submodule

+
git submodule add https://github.com/Sewer56/Riders.Tweakbox.git
+git submodule update --init --recursive
+
+

Add Riders.Tweakbox.Interfaces to your project.

+

First add it to your solution by right clicking it. +Image

+

and find Riders.Tweakbox.Interfaces.csproj +Image

+

Then, add it as a project dependency to your Reloaded-II mod. +Image

+

Image

+

Add Riders.Tweakbox as a Reloaded II dependency.

+

Edit your project's ModConfig.json to include Riders.Tweakbox as part of the ModDependencies.

+

Image

+

Consume the Tweakbox API

+

In your Start function of the mod, grab an interface to the R-II.

+
// Get the API Controller
+_modLoader.GetController<ITweakboxApi>().TryGetTarget(out var apiAccessor);
+
+// Register to the tweakbox API
+var api = apiAccessor.Register($"{config.ModId}.{config.ModVersion}");
+
+// Use the API
+var gearApi = api.GetCustomGearApi();
+gearApi.RemoveVanillaGears();
+
+

More Information

+

Reloaded-II Documentation on Controllers

+

Example Usage

+

For more examples, consider looking at the example Riders.Tweakbox.Gearpack and Riders.Tweakbox.CharacterPack.DX projects contained in this repository.

+

Get Updated Pointers

+

Tweakbox rewrites some game code to make features such as custom gears possible. Therefore, some fields in libraries such as Sewer56.SonicRiders will need to be updated.

+

To obtain the updated pointers, use the GetPointers method.

+
// Update Gear Data Pointer
+var pointers = modImpl.GetPointers();
+Sewer56.SonicRiders.API.Player.Gears = new FixedArrayPtr<ExtremeGear>((ulong)pointers.Gears.Address, pointers.Gears.NumItems);
+
+

Add a Custom Gear to the Game

+
// ICustomGearApi obtained via api.GetCustomGearApi();
+public class BlueStarIIDX : CustomGearBase, IExtremeGear
+{
+    private BoostProperties _boostProperties = new BoostProperties()
+    {
+        AddedBoostChainMultiplier = 0.15f,
+        AddedBoostDurationLv3 = 30
+    };
+
+    /// <summary>
+    /// Initializes this custom gear.
+    /// </summary>
+    public override void Initialize(string gearsFolder, ICustomGearApi gearApi)
+    {
+        // Import a custom gear exported from the built-in `Export Custom Gear`
+        // function in the gear editor.
+        var data = gearApi.ImportFromFolder(Path.Combine(gearsFolder, "BlueStarII DX"));
+
+        // Attach a class that overrides gear behaviours (via IExtremeGear)
+        data.Behaviour = this;
+
+        // Add the custom gear to the game!
+        gearApi.AddGear(data);
+    }
+
+    // IExtremeGear API Callback
+    public BoostProperties GetBoostProperties() => _boostProperties;
+}
+
+

If you need to get the location of your mod's folder...

+
// In your mod's `Start` method.
+_modLoader.GetDirectoryForModId(MyModId)
+
+

Modify Character Behaviour (Simple)

+
public class Sonic : LateBoosterCharacter, ICustomStats
+{
+    private BoostProperties _boostProperties = new BoostProperties()
+    {
+        AddedBoostDurationLv2 = 60,
+        AddedBoostDurationLv3 = 60,
+    };
+
+    /// <summary>
+    /// Initializes this custom character.
+    /// </summary>
+    public void Initialize(Interfaces.ICustomCharacterApi characterApi)
+    {
+        Request = new ModifyCharacterRequest()
+        {
+            Behaviour = this, // Modifies the character behaviour.
+            CharacterId = (int) Characters.Sonic, // Character Index. See Sewer56.SonicRiders.Structures.Enums.Characters
+            CharacterName = "Sonic DX",
+            Stack = false                  // Does not combine with other mods.
+        };
+
+        // Modify your character!
+        characterApi.AddCharacterBehaviour(Request);
+    }
+
+    // Overrides for ICustomCharacter interface.
+    public ApiCharacterParameters GetCharacterParameters() => new ApiCharacterParameters()
+    {
+        SpeedMultiplierOffset = 0f
+    };
+
+    public BoostProperties GetBoostProperties() => _boostProperties;
+}
+
+

Usage: +

// Get API
+var characterApi = api.GetCustomCharacterApi();
+
+// Add character
+var sonic = new Sonic();
+sonic.Initialize(characterApi);
+

+

Modify Character Behaviour (Clean)

+

Here's an example of how you could implement character 'archetypes'/'classes' (categories) for a cleaner approach.

+

Base Character Class: +

public abstract class CustomCharacterBase : ICustomCharacter
+{
+    public ModifyCharacterRequest Request { get; private set; }
+    public abstract string Name { get; }
+    public abstract Characters Character { get; }
+
+    /// <summary>
+    /// Initializes this custom character.
+    /// </summary>
+    public void Initialize(Interfaces.ICustomCharacterApi characterApi)
+    {
+        Request = new ModifyCharacterRequest()
+        {
+            Behaviour = this,              // Modifies the character behaviour.
+            CharacterId = (int) Character, // Character Index. See Sewer56.SonicRiders.Structures.Enums.Characters
+            CharacterName = Name,
+            Stack = false                  // Does not combine with other mods.
+        };
+
+        // Modify your character!
+        characterApi.AddCharacterBehaviour(Request);
+    }
+}
+

+

Define the character class: +

// An implementation of Sonic Riders DX 1.0.0 Late Booster Character
+public abstract class LateBoosterCharacter : CustomCharacterBase, ICustomCharacter
+{
+    // These are all callbacks for the ICustomCharacter interface.
+    private BoostProperties _boostProperties = new BoostProperties()
+    {
+        AddedBoostDurationLv2 = 60,
+        AddedBoostDurationLv3 = 60,
+    };
+
+    public ApiCharacterParameters GetCharacterParameters() => new ApiCharacterParameters()
+    {
+        SpeedMultiplierOffset = 0f
+    };
+
+    public BoostProperties GetBoostProperties() => _boostProperties;
+}
+

+

Give the character that class (via inheritance): +

public class Sonic : LateBoosterCharacter, ICustomStats
+{
+    public override string Name { get; } = "Sonic DX";
+    public override Characters Character { get; } = Characters.Sonic;
+}
+

+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/animated-textures/index.html b/animated-textures/index.html new file mode 100644 index 00000000..f6af3c4a --- /dev/null +++ b/animated-textures/index.html @@ -0,0 +1,864 @@ + + + + + + + + + + + + + + + + + + + + + + + + Animated Textures - Riders.Tweakbox Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Animated Textures

+

Riders.Tweakbox provides basic support for animated textures.

+

In order to make an animated texture, you should create a folder with the name of the texture; and inside that folder, make files with file names corresponding to individual keyframes of the animation.

+

The built-in texture animator will play back your animation, starting with the last frame of animation. As Riders runs at 60 frames per second, a file with the name of 060, will run on the 60th frame.

+

Tip: When dealing with many textures, a tool like Bulk Rename Utility might come in handy.

+

Warning

+

It is recommended to use this feature sparringly.

+

High framerate animated textures are expensive on video memory, especially when paired with high resolutions. Going too far might make it hard for people with integrated graphics to run your mod.

+

PLEASE OPTIMISE YOUR ANIMATED TEXTURES +The examples here use PNGs for clarity; when you release your textures, you should use native DDS files.

+

Basic Example

+

Alternate between two colours using a specified time interval.

+

Screenshot +Screenshot

+

In this scenario, the green texture for 30 frames (0.5 seconds) before switching to the red texture. After another 30 frames, you will go back to the green texture.

+

More Colours

+
    +
  • The pink texture will show for 20 frames.
    • +
  • Then the green will show for 30 frames.
    • +
  • Then the light blue w ill show for 40 frames.
    • +
  • Then the blue will show for 50 frames. +repeat
    • +
+

Screenshot

+

Full Animation

+

Create Hyper Sonic by changing Super Sonic's texture every frame.

+

Screenshot +Screenshot

+

[Frame 74 of the Animation]

+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/assets/images/favicon.png b/assets/images/favicon.png new file mode 100644 index 00000000..1cf13b9f Binary files /dev/null and b/assets/images/favicon.png differ diff --git a/assets/javascripts/bundle.51d95adb.min.js b/assets/javascripts/bundle.51d95adb.min.js new file mode 100644 index 00000000..b20ec683 --- /dev/null +++ b/assets/javascripts/bundle.51d95adb.min.js @@ -0,0 +1,29 @@ +"use strict";(()=>{var Hi=Object.create;var xr=Object.defineProperty;var Pi=Object.getOwnPropertyDescriptor;var $i=Object.getOwnPropertyNames,kt=Object.getOwnPropertySymbols,Ii=Object.getPrototypeOf,Er=Object.prototype.hasOwnProperty,an=Object.prototype.propertyIsEnumerable;var on=(e,t,r)=>t in e?xr(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r,P=(e,t)=>{for(var r in t||(t={}))Er.call(t,r)&&on(e,r,t[r]);if(kt)for(var r of kt(t))an.call(t,r)&&on(e,r,t[r]);return e};var sn=(e,t)=>{var r={};for(var n in e)Er.call(e,n)&&t.indexOf(n)<0&&(r[n]=e[n]);if(e!=null&&kt)for(var n of kt(e))t.indexOf(n)<0&&an.call(e,n)&&(r[n]=e[n]);return r};var Ht=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports);var Fi=(e,t,r,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of $i(t))!Er.call(e,o)&&o!==r&&xr(e,o,{get:()=>t[o],enumerable:!(n=Pi(t,o))||n.enumerable});return e};var yt=(e,t,r)=>(r=e!=null?Hi(Ii(e)):{},Fi(t||!e||!e.__esModule?xr(r,"default",{value:e,enumerable:!0}):r,e));var fn=Ht((wr,cn)=>{(function(e,t){typeof wr=="object"&&typeof cn!="undefined"?t():typeof define=="function"&&define.amd?define(t):t()})(wr,function(){"use strict";function e(r){var n=!0,o=!1,i=null,a={text:!0,search:!0,url:!0,tel:!0,email:!0,password:!0,number:!0,date:!0,month:!0,week:!0,time:!0,datetime:!0,"datetime-local":!0};function s(T){return!!(T&&T!==document&&T.nodeName!=="HTML"&&T.nodeName!=="BODY"&&"classList"in T&&"contains"in T.classList)}function f(T){var Ke=T.type,We=T.tagName;return!!(We==="INPUT"&&a[Ke]&&!T.readOnly||We==="TEXTAREA"&&!T.readOnly||T.isContentEditable)}function c(T){T.classList.contains("focus-visible")||(T.classList.add("focus-visible"),T.setAttribute("data-focus-visible-added",""))}function u(T){T.hasAttribute("data-focus-visible-added")&&(T.classList.remove("focus-visible"),T.removeAttribute("data-focus-visible-added"))}function p(T){T.metaKey||T.altKey||T.ctrlKey||(s(r.activeElement)&&c(r.activeElement),n=!0)}function m(T){n=!1}function d(T){s(T.target)&&(n||f(T.target))&&c(T.target)}function h(T){s(T.target)&&(T.target.classList.contains("focus-visible")||T.target.hasAttribute("data-focus-visible-added"))&&(o=!0,window.clearTimeout(i),i=window.setTimeout(function(){o=!1},100),u(T.target))}function v(T){document.visibilityState==="hidden"&&(o&&(n=!0),B())}function B(){document.addEventListener("mousemove",z),document.addEventListener("mousedown",z),document.addEventListener("mouseup",z),document.addEventListener("pointermove",z),document.addEventListener("pointerdown",z),document.addEventListener("pointerup",z),document.addEventListener("touchmove",z),document.addEventListener("touchstart",z),document.addEventListener("touchend",z)}function re(){document.removeEventListener("mousemove",z),document.removeEventListener("mousedown",z),document.removeEventListener("mouseup",z),document.removeEventListener("pointermove",z),document.removeEventListener("pointerdown",z),document.removeEventListener("pointerup",z),document.removeEventListener("touchmove",z),document.removeEventListener("touchstart",z),document.removeEventListener("touchend",z)}function z(T){T.target.nodeName&&T.target.nodeName.toLowerCase()==="html"||(n=!1,re())}document.addEventListener("keydown",p,!0),document.addEventListener("mousedown",m,!0),document.addEventListener("pointerdown",m,!0),document.addEventListener("touchstart",m,!0),document.addEventListener("visibilitychange",v,!0),B(),r.addEventListener("focus",d,!0),r.addEventListener("blur",h,!0),r.nodeType===Node.DOCUMENT_FRAGMENT_NODE&&r.host?r.host.setAttribute("data-js-focus-visible",""):r.nodeType===Node.DOCUMENT_NODE&&(document.documentElement.classList.add("js-focus-visible"),document.documentElement.setAttribute("data-js-focus-visible",""))}if(typeof window!="undefined"&&typeof document!="undefined"){window.applyFocusVisiblePolyfill=e;var t;try{t=new CustomEvent("focus-visible-polyfill-ready")}catch(r){t=document.createEvent("CustomEvent"),t.initCustomEvent("focus-visible-polyfill-ready",!1,!1,{})}window.dispatchEvent(t)}typeof document!="undefined"&&e(document)})});var un=Ht(Sr=>{(function(e){var t=function(){try{return!!Symbol.iterator}catch(c){return!1}},r=t(),n=function(c){var u={next:function(){var p=c.shift();return{done:p===void 0,value:p}}};return r&&(u[Symbol.iterator]=function(){return u}),u},o=function(c){return encodeURIComponent(c).replace(/%20/g,"+")},i=function(c){return decodeURIComponent(String(c).replace(/\+/g," "))},a=function(){var c=function(p){Object.defineProperty(this,"_entries",{writable:!0,value:{}});var m=typeof p;if(m!=="undefined")if(m==="string")p!==""&&this._fromString(p);else if(p instanceof c){var d=this;p.forEach(function(re,z){d.append(z,re)})}else if(p!==null&&m==="object")if(Object.prototype.toString.call(p)==="[object Array]")for(var h=0;hd[0]?1:0}),c._entries&&(c._entries={});for(var p=0;p1?i(d[1]):"")}})})(typeof global!="undefined"?global:typeof window!="undefined"?window:typeof self!="undefined"?self:Sr);(function(e){var t=function(){try{var o=new e.URL("b","http://a");return o.pathname="c d",o.href==="http://a/c%20d"&&o.searchParams}catch(i){return!1}},r=function(){var o=e.URL,i=function(f,c){typeof f!="string"&&(f=String(f)),c&&typeof c!="string"&&(c=String(c));var u=document,p;if(c&&(e.location===void 0||c!==e.location.href)){c=c.toLowerCase(),u=document.implementation.createHTMLDocument(""),p=u.createElement("base"),p.href=c,u.head.appendChild(p);try{if(p.href.indexOf(c)!==0)throw new Error(p.href)}catch(T){throw new Error("URL unable to set base "+c+" due to "+T)}}var m=u.createElement("a");m.href=f,p&&(u.body.appendChild(m),m.href=m.href);var d=u.createElement("input");if(d.type="url",d.value=f,m.protocol===":"||!/:/.test(m.href)||!d.checkValidity()&&!c)throw new TypeError("Invalid URL");Object.defineProperty(this,"_anchorElement",{value:m});var h=new e.URLSearchParams(this.search),v=!0,B=!0,re=this;["append","delete","set"].forEach(function(T){var Ke=h[T];h[T]=function(){Ke.apply(h,arguments),v&&(B=!1,re.search=h.toString(),B=!0)}}),Object.defineProperty(this,"searchParams",{value:h,enumerable:!0});var z=void 0;Object.defineProperty(this,"_updateSearchParams",{enumerable:!1,configurable:!1,writable:!1,value:function(){this.search!==z&&(z=this.search,B&&(v=!1,this.searchParams._fromString(this.search),v=!0))}})},a=i.prototype,s=function(f){Object.defineProperty(a,f,{get:function(){return this._anchorElement[f]},set:function(c){this._anchorElement[f]=c},enumerable:!0})};["hash","host","hostname","port","protocol"].forEach(function(f){s(f)}),Object.defineProperty(a,"search",{get:function(){return this._anchorElement.search},set:function(f){this._anchorElement.search=f,this._updateSearchParams()},enumerable:!0}),Object.defineProperties(a,{toString:{get:function(){var f=this;return function(){return f.href}}},href:{get:function(){return this._anchorElement.href.replace(/\?$/,"")},set:function(f){this._anchorElement.href=f,this._updateSearchParams()},enumerable:!0},pathname:{get:function(){return this._anchorElement.pathname.replace(/(^\/?)/,"/")},set:function(f){this._anchorElement.pathname=f},enumerable:!0},origin:{get:function(){var f={"http:":80,"https:":443,"ftp:":21}[this._anchorElement.protocol],c=this._anchorElement.port!=f&&this._anchorElement.port!=="";return this._anchorElement.protocol+"//"+this._anchorElement.hostname+(c?":"+this._anchorElement.port:"")},enumerable:!0},password:{get:function(){return""},set:function(f){},enumerable:!0},username:{get:function(){return""},set:function(f){},enumerable:!0}}),i.createObjectURL=function(f){return o.createObjectURL.apply(o,arguments)},i.revokeObjectURL=function(f){return o.revokeObjectURL.apply(o,arguments)},e.URL=i};if(t()||r(),e.location!==void 0&&!("origin"in e.location)){var n=function(){return e.location.protocol+"//"+e.location.hostname+(e.location.port?":"+e.location.port:"")};try{Object.defineProperty(e.location,"origin",{get:n,enumerable:!0})}catch(o){setInterval(function(){e.location.origin=n()},100)}}})(typeof global!="undefined"?global:typeof window!="undefined"?window:typeof self!="undefined"?self:Sr)});var Qr=Ht((Lt,Kr)=>{/*! + * clipboard.js v2.0.11 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */(function(t,r){typeof Lt=="object"&&typeof Kr=="object"?Kr.exports=r():typeof define=="function"&&define.amd?define([],r):typeof Lt=="object"?Lt.ClipboardJS=r():t.ClipboardJS=r()})(Lt,function(){return function(){var e={686:function(n,o,i){"use strict";i.d(o,{default:function(){return ki}});var a=i(279),s=i.n(a),f=i(370),c=i.n(f),u=i(817),p=i.n(u);function m(j){try{return document.execCommand(j)}catch(O){return!1}}var d=function(O){var w=p()(O);return m("cut"),w},h=d;function v(j){var O=document.documentElement.getAttribute("dir")==="rtl",w=document.createElement("textarea");w.style.fontSize="12pt",w.style.border="0",w.style.padding="0",w.style.margin="0",w.style.position="absolute",w.style[O?"right":"left"]="-9999px";var k=window.pageYOffset||document.documentElement.scrollTop;return w.style.top="".concat(k,"px"),w.setAttribute("readonly",""),w.value=j,w}var B=function(O,w){var k=v(O);w.container.appendChild(k);var F=p()(k);return m("copy"),k.remove(),F},re=function(O){var w=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body},k="";return typeof O=="string"?k=B(O,w):O instanceof HTMLInputElement&&!["text","search","url","tel","password"].includes(O==null?void 0:O.type)?k=B(O.value,w):(k=p()(O),m("copy")),k},z=re;function T(j){return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?T=function(w){return typeof w}:T=function(w){return w&&typeof Symbol=="function"&&w.constructor===Symbol&&w!==Symbol.prototype?"symbol":typeof w},T(j)}var Ke=function(){var O=arguments.length>0&&arguments[0]!==void 0?arguments[0]:{},w=O.action,k=w===void 0?"copy":w,F=O.container,q=O.target,Le=O.text;if(k!=="copy"&&k!=="cut")throw new Error('Invalid "action" value, use either "copy" or "cut"');if(q!==void 0)if(q&&T(q)==="object"&&q.nodeType===1){if(k==="copy"&&q.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if(k==="cut"&&(q.hasAttribute("readonly")||q.hasAttribute("disabled")))throw new Error(`Invalid "target" attribute. You can't cut text from elements with "readonly" or "disabled" attributes`)}else throw new Error('Invalid "target" value, use a valid Element');if(Le)return z(Le,{container:F});if(q)return k==="cut"?h(q):z(q,{container:F})},We=Ke;function Ie(j){return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?Ie=function(w){return typeof w}:Ie=function(w){return w&&typeof Symbol=="function"&&w.constructor===Symbol&&w!==Symbol.prototype?"symbol":typeof w},Ie(j)}function Ti(j,O){if(!(j instanceof O))throw new TypeError("Cannot call a class as a function")}function nn(j,O){for(var w=0;w0&&arguments[0]!==void 0?arguments[0]:{};this.action=typeof F.action=="function"?F.action:this.defaultAction,this.target=typeof F.target=="function"?F.target:this.defaultTarget,this.text=typeof F.text=="function"?F.text:this.defaultText,this.container=Ie(F.container)==="object"?F.container:document.body}},{key:"listenClick",value:function(F){var q=this;this.listener=c()(F,"click",function(Le){return q.onClick(Le)})}},{key:"onClick",value:function(F){var q=F.delegateTarget||F.currentTarget,Le=this.action(q)||"copy",Rt=We({action:Le,container:this.container,target:this.target(q),text:this.text(q)});this.emit(Rt?"success":"error",{action:Le,text:Rt,trigger:q,clearSelection:function(){q&&q.focus(),window.getSelection().removeAllRanges()}})}},{key:"defaultAction",value:function(F){return yr("action",F)}},{key:"defaultTarget",value:function(F){var q=yr("target",F);if(q)return document.querySelector(q)}},{key:"defaultText",value:function(F){return yr("text",F)}},{key:"destroy",value:function(){this.listener.destroy()}}],[{key:"copy",value:function(F){var q=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body};return z(F,q)}},{key:"cut",value:function(F){return h(F)}},{key:"isSupported",value:function(){var F=arguments.length>0&&arguments[0]!==void 0?arguments[0]:["copy","cut"],q=typeof F=="string"?[F]:F,Le=!!document.queryCommandSupported;return q.forEach(function(Rt){Le=Le&&!!document.queryCommandSupported(Rt)}),Le}}]),w}(s()),ki=Ri},828:function(n){var o=9;if(typeof Element!="undefined"&&!Element.prototype.matches){var i=Element.prototype;i.matches=i.matchesSelector||i.mozMatchesSelector||i.msMatchesSelector||i.oMatchesSelector||i.webkitMatchesSelector}function a(s,f){for(;s&&s.nodeType!==o;){if(typeof s.matches=="function"&&s.matches(f))return s;s=s.parentNode}}n.exports=a},438:function(n,o,i){var a=i(828);function s(u,p,m,d,h){var v=c.apply(this,arguments);return u.addEventListener(m,v,h),{destroy:function(){u.removeEventListener(m,v,h)}}}function f(u,p,m,d,h){return typeof u.addEventListener=="function"?s.apply(null,arguments):typeof m=="function"?s.bind(null,document).apply(null,arguments):(typeof u=="string"&&(u=document.querySelectorAll(u)),Array.prototype.map.call(u,function(v){return s(v,p,m,d,h)}))}function c(u,p,m,d){return function(h){h.delegateTarget=a(h.target,p),h.delegateTarget&&d.call(u,h)}}n.exports=f},879:function(n,o){o.node=function(i){return i!==void 0&&i instanceof HTMLElement&&i.nodeType===1},o.nodeList=function(i){var a=Object.prototype.toString.call(i);return i!==void 0&&(a==="[object NodeList]"||a==="[object HTMLCollection]")&&"length"in i&&(i.length===0||o.node(i[0]))},o.string=function(i){return typeof i=="string"||i instanceof String},o.fn=function(i){var a=Object.prototype.toString.call(i);return a==="[object Function]"}},370:function(n,o,i){var a=i(879),s=i(438);function f(m,d,h){if(!m&&!d&&!h)throw new Error("Missing required arguments");if(!a.string(d))throw new TypeError("Second argument must be a String");if(!a.fn(h))throw new TypeError("Third argument must be a Function");if(a.node(m))return c(m,d,h);if(a.nodeList(m))return u(m,d,h);if(a.string(m))return p(m,d,h);throw new TypeError("First argument must be a String, HTMLElement, HTMLCollection, or NodeList")}function c(m,d,h){return m.addEventListener(d,h),{destroy:function(){m.removeEventListener(d,h)}}}function u(m,d,h){return Array.prototype.forEach.call(m,function(v){v.addEventListener(d,h)}),{destroy:function(){Array.prototype.forEach.call(m,function(v){v.removeEventListener(d,h)})}}}function p(m,d,h){return s(document.body,m,d,h)}n.exports=f},817:function(n){function o(i){var a;if(i.nodeName==="SELECT")i.focus(),a=i.value;else if(i.nodeName==="INPUT"||i.nodeName==="TEXTAREA"){var s=i.hasAttribute("readonly");s||i.setAttribute("readonly",""),i.select(),i.setSelectionRange(0,i.value.length),s||i.removeAttribute("readonly"),a=i.value}else{i.hasAttribute("contenteditable")&&i.focus();var f=window.getSelection(),c=document.createRange();c.selectNodeContents(i),f.removeAllRanges(),f.addRange(c),a=f.toString()}return a}n.exports=o},279:function(n){function o(){}o.prototype={on:function(i,a,s){var f=this.e||(this.e={});return(f[i]||(f[i]=[])).push({fn:a,ctx:s}),this},once:function(i,a,s){var f=this;function c(){f.off(i,c),a.apply(s,arguments)}return c._=a,this.on(i,c,s)},emit:function(i){var a=[].slice.call(arguments,1),s=((this.e||(this.e={}))[i]||[]).slice(),f=0,c=s.length;for(f;f{"use strict";/*! + * escape-html + * Copyright(c) 2012-2013 TJ Holowaychuk + * Copyright(c) 2015 Andreas Lubbe + * Copyright(c) 2015 Tiancheng "Timothy" Gu + * MIT Licensed + */var is=/["'&<>]/;Jo.exports=as;function as(e){var t=""+e,r=is.exec(t);if(!r)return t;var n,o="",i=0,a=0;for(i=r.index;i0&&i[i.length-1])&&(c[0]===6||c[0]===2)){r=0;continue}if(c[0]===3&&(!i||c[1]>i[0]&&c[1]=e.length&&(e=void 0),{value:e&&e[n++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")}function W(e,t){var r=typeof Symbol=="function"&&e[Symbol.iterator];if(!r)return e;var n=r.call(e),o,i=[],a;try{for(;(t===void 0||t-- >0)&&!(o=n.next()).done;)i.push(o.value)}catch(s){a={error:s}}finally{try{o&&!o.done&&(r=n.return)&&r.call(n)}finally{if(a)throw a.error}}return i}function D(e,t,r){if(r||arguments.length===2)for(var n=0,o=t.length,i;n1||s(m,d)})})}function s(m,d){try{f(n[m](d))}catch(h){p(i[0][3],h)}}function f(m){m.value instanceof Xe?Promise.resolve(m.value.v).then(c,u):p(i[0][2],m)}function c(m){s("next",m)}function u(m){s("throw",m)}function p(m,d){m(d),i.shift(),i.length&&s(i[0][0],i[0][1])}}function mn(e){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var t=e[Symbol.asyncIterator],r;return t?t.call(e):(e=typeof xe=="function"?xe(e):e[Symbol.iterator](),r={},n("next"),n("throw"),n("return"),r[Symbol.asyncIterator]=function(){return this},r);function n(i){r[i]=e[i]&&function(a){return new Promise(function(s,f){a=e[i](a),o(s,f,a.done,a.value)})}}function o(i,a,s,f){Promise.resolve(f).then(function(c){i({value:c,done:s})},a)}}function A(e){return typeof e=="function"}function at(e){var t=function(n){Error.call(n),n.stack=new Error().stack},r=e(t);return r.prototype=Object.create(Error.prototype),r.prototype.constructor=r,r}var $t=at(function(e){return function(r){e(this),this.message=r?r.length+` errors occurred during unsubscription: +`+r.map(function(n,o){return o+1+") "+n.toString()}).join(` + `):"",this.name="UnsubscriptionError",this.errors=r}});function De(e,t){if(e){var r=e.indexOf(t);0<=r&&e.splice(r,1)}}var Fe=function(){function e(t){this.initialTeardown=t,this.closed=!1,this._parentage=null,this._finalizers=null}return e.prototype.unsubscribe=function(){var t,r,n,o,i;if(!this.closed){this.closed=!0;var a=this._parentage;if(a)if(this._parentage=null,Array.isArray(a))try{for(var s=xe(a),f=s.next();!f.done;f=s.next()){var c=f.value;c.remove(this)}}catch(v){t={error:v}}finally{try{f&&!f.done&&(r=s.return)&&r.call(s)}finally{if(t)throw t.error}}else a.remove(this);var u=this.initialTeardown;if(A(u))try{u()}catch(v){i=v instanceof $t?v.errors:[v]}var p=this._finalizers;if(p){this._finalizers=null;try{for(var m=xe(p),d=m.next();!d.done;d=m.next()){var h=d.value;try{dn(h)}catch(v){i=i!=null?i:[],v instanceof $t?i=D(D([],W(i)),W(v.errors)):i.push(v)}}}catch(v){n={error:v}}finally{try{d&&!d.done&&(o=m.return)&&o.call(m)}finally{if(n)throw n.error}}}if(i)throw new $t(i)}},e.prototype.add=function(t){var r;if(t&&t!==this)if(this.closed)dn(t);else{if(t instanceof e){if(t.closed||t._hasParent(this))return;t._addParent(this)}(this._finalizers=(r=this._finalizers)!==null&&r!==void 0?r:[]).push(t)}},e.prototype._hasParent=function(t){var r=this._parentage;return r===t||Array.isArray(r)&&r.includes(t)},e.prototype._addParent=function(t){var r=this._parentage;this._parentage=Array.isArray(r)?(r.push(t),r):r?[r,t]:t},e.prototype._removeParent=function(t){var r=this._parentage;r===t?this._parentage=null:Array.isArray(r)&&De(r,t)},e.prototype.remove=function(t){var r=this._finalizers;r&&De(r,t),t instanceof e&&t._removeParent(this)},e.EMPTY=function(){var t=new e;return t.closed=!0,t}(),e}();var Or=Fe.EMPTY;function It(e){return e instanceof Fe||e&&"closed"in e&&A(e.remove)&&A(e.add)&&A(e.unsubscribe)}function dn(e){A(e)?e():e.unsubscribe()}var Ae={onUnhandledError:null,onStoppedNotification:null,Promise:void 0,useDeprecatedSynchronousErrorHandling:!1,useDeprecatedNextContext:!1};var st={setTimeout:function(e,t){for(var r=[],n=2;n0},enumerable:!1,configurable:!0}),t.prototype._trySubscribe=function(r){return this._throwIfClosed(),e.prototype._trySubscribe.call(this,r)},t.prototype._subscribe=function(r){return this._throwIfClosed(),this._checkFinalizedStatuses(r),this._innerSubscribe(r)},t.prototype._innerSubscribe=function(r){var n=this,o=this,i=o.hasError,a=o.isStopped,s=o.observers;return i||a?Or:(this.currentObservers=null,s.push(r),new Fe(function(){n.currentObservers=null,De(s,r)}))},t.prototype._checkFinalizedStatuses=function(r){var n=this,o=n.hasError,i=n.thrownError,a=n.isStopped;o?r.error(i):a&&r.complete()},t.prototype.asObservable=function(){var r=new U;return r.source=this,r},t.create=function(r,n){return new wn(r,n)},t}(U);var wn=function(e){ne(t,e);function t(r,n){var o=e.call(this)||this;return o.destination=r,o.source=n,o}return t.prototype.next=function(r){var n,o;(o=(n=this.destination)===null||n===void 0?void 0:n.next)===null||o===void 0||o.call(n,r)},t.prototype.error=function(r){var n,o;(o=(n=this.destination)===null||n===void 0?void 0:n.error)===null||o===void 0||o.call(n,r)},t.prototype.complete=function(){var r,n;(n=(r=this.destination)===null||r===void 0?void 0:r.complete)===null||n===void 0||n.call(r)},t.prototype._subscribe=function(r){var n,o;return(o=(n=this.source)===null||n===void 0?void 0:n.subscribe(r))!==null&&o!==void 0?o:Or},t}(E);var Et={now:function(){return(Et.delegate||Date).now()},delegate:void 0};var wt=function(e){ne(t,e);function t(r,n,o){r===void 0&&(r=1/0),n===void 0&&(n=1/0),o===void 0&&(o=Et);var i=e.call(this)||this;return i._bufferSize=r,i._windowTime=n,i._timestampProvider=o,i._buffer=[],i._infiniteTimeWindow=!0,i._infiniteTimeWindow=n===1/0,i._bufferSize=Math.max(1,r),i._windowTime=Math.max(1,n),i}return t.prototype.next=function(r){var n=this,o=n.isStopped,i=n._buffer,a=n._infiniteTimeWindow,s=n._timestampProvider,f=n._windowTime;o||(i.push(r),!a&&i.push(s.now()+f)),this._trimBuffer(),e.prototype.next.call(this,r)},t.prototype._subscribe=function(r){this._throwIfClosed(),this._trimBuffer();for(var n=this._innerSubscribe(r),o=this,i=o._infiniteTimeWindow,a=o._buffer,s=a.slice(),f=0;f0?e.prototype.requestAsyncId.call(this,r,n,o):(r.actions.push(this),r._scheduled||(r._scheduled=ut.requestAnimationFrame(function(){return r.flush(void 0)})))},t.prototype.recycleAsyncId=function(r,n,o){var i;if(o===void 0&&(o=0),o!=null?o>0:this.delay>0)return e.prototype.recycleAsyncId.call(this,r,n,o);var a=r.actions;n!=null&&((i=a[a.length-1])===null||i===void 0?void 0:i.id)!==n&&(ut.cancelAnimationFrame(n),r._scheduled=void 0)},t}(Ut);var On=function(e){ne(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t.prototype.flush=function(r){this._active=!0;var n=this._scheduled;this._scheduled=void 0;var o=this.actions,i;r=r||o.shift();do if(i=r.execute(r.state,r.delay))break;while((r=o[0])&&r.id===n&&o.shift());if(this._active=!1,i){for(;(r=o[0])&&r.id===n&&o.shift();)r.unsubscribe();throw i}},t}(Wt);var we=new On(Tn);var R=new U(function(e){return e.complete()});function Dt(e){return e&&A(e.schedule)}function kr(e){return e[e.length-1]}function Qe(e){return A(kr(e))?e.pop():void 0}function Se(e){return Dt(kr(e))?e.pop():void 0}function Vt(e,t){return typeof kr(e)=="number"?e.pop():t}var pt=function(e){return e&&typeof e.length=="number"&&typeof e!="function"};function zt(e){return A(e==null?void 0:e.then)}function Nt(e){return A(e[ft])}function qt(e){return Symbol.asyncIterator&&A(e==null?void 0:e[Symbol.asyncIterator])}function Kt(e){return new TypeError("You provided "+(e!==null&&typeof e=="object"?"an invalid object":"'"+e+"'")+" where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.")}function Ki(){return typeof Symbol!="function"||!Symbol.iterator?"@@iterator":Symbol.iterator}var Qt=Ki();function Yt(e){return A(e==null?void 0:e[Qt])}function Gt(e){return ln(this,arguments,function(){var r,n,o,i;return Pt(this,function(a){switch(a.label){case 0:r=e.getReader(),a.label=1;case 1:a.trys.push([1,,9,10]),a.label=2;case 2:return[4,Xe(r.read())];case 3:return n=a.sent(),o=n.value,i=n.done,i?[4,Xe(void 0)]:[3,5];case 4:return[2,a.sent()];case 5:return[4,Xe(o)];case 6:return[4,a.sent()];case 7:return a.sent(),[3,2];case 8:return[3,10];case 9:return r.releaseLock(),[7];case 10:return[2]}})})}function Bt(e){return A(e==null?void 0:e.getReader)}function $(e){if(e instanceof U)return e;if(e!=null){if(Nt(e))return Qi(e);if(pt(e))return Yi(e);if(zt(e))return Gi(e);if(qt(e))return _n(e);if(Yt(e))return Bi(e);if(Bt(e))return Ji(e)}throw Kt(e)}function Qi(e){return new U(function(t){var r=e[ft]();if(A(r.subscribe))return r.subscribe(t);throw new TypeError("Provided object does not correctly implement Symbol.observable")})}function Yi(e){return new U(function(t){for(var r=0;r=2;return function(n){return n.pipe(e?_(function(o,i){return e(o,i,n)}):me,Oe(1),r?He(t):zn(function(){return new Xt}))}}function Nn(){for(var e=[],t=0;t=2,!0))}function fe(e){e===void 0&&(e={});var t=e.connector,r=t===void 0?function(){return new E}:t,n=e.resetOnError,o=n===void 0?!0:n,i=e.resetOnComplete,a=i===void 0?!0:i,s=e.resetOnRefCountZero,f=s===void 0?!0:s;return function(c){var u,p,m,d=0,h=!1,v=!1,B=function(){p==null||p.unsubscribe(),p=void 0},re=function(){B(),u=m=void 0,h=v=!1},z=function(){var T=u;re(),T==null||T.unsubscribe()};return g(function(T,Ke){d++,!v&&!h&&B();var We=m=m!=null?m:r();Ke.add(function(){d--,d===0&&!v&&!h&&(p=jr(z,f))}),We.subscribe(Ke),!u&&d>0&&(u=new et({next:function(Ie){return We.next(Ie)},error:function(Ie){v=!0,B(),p=jr(re,o,Ie),We.error(Ie)},complete:function(){h=!0,B(),p=jr(re,a),We.complete()}}),$(T).subscribe(u))})(c)}}function jr(e,t){for(var r=[],n=2;ne.next(document)),e}function K(e,t=document){return Array.from(t.querySelectorAll(e))}function V(e,t=document){let r=se(e,t);if(typeof r=="undefined")throw new ReferenceError(`Missing element: expected "${e}" to be present`);return r}function se(e,t=document){return t.querySelector(e)||void 0}function _e(){return document.activeElement instanceof HTMLElement&&document.activeElement||void 0}function tr(e){return L(b(document.body,"focusin"),b(document.body,"focusout")).pipe(ke(1),l(()=>{let t=_e();return typeof t!="undefined"?e.contains(t):!1}),N(e===_e()),Y())}function Be(e){return{x:e.offsetLeft,y:e.offsetTop}}function Yn(e){return L(b(window,"load"),b(window,"resize")).pipe(Ce(0,we),l(()=>Be(e)),N(Be(e)))}function rr(e){return{x:e.scrollLeft,y:e.scrollTop}}function dt(e){return L(b(e,"scroll"),b(window,"resize")).pipe(Ce(0,we),l(()=>rr(e)),N(rr(e)))}var Bn=function(){if(typeof Map!="undefined")return Map;function e(t,r){var n=-1;return t.some(function(o,i){return o[0]===r?(n=i,!0):!1}),n}return function(){function t(){this.__entries__=[]}return Object.defineProperty(t.prototype,"size",{get:function(){return this.__entries__.length},enumerable:!0,configurable:!0}),t.prototype.get=function(r){var n=e(this.__entries__,r),o=this.__entries__[n];return o&&o[1]},t.prototype.set=function(r,n){var o=e(this.__entries__,r);~o?this.__entries__[o][1]=n:this.__entries__.push([r,n])},t.prototype.delete=function(r){var n=this.__entries__,o=e(n,r);~o&&n.splice(o,1)},t.prototype.has=function(r){return!!~e(this.__entries__,r)},t.prototype.clear=function(){this.__entries__.splice(0)},t.prototype.forEach=function(r,n){n===void 0&&(n=null);for(var o=0,i=this.__entries__;o0},e.prototype.connect_=function(){!zr||this.connected_||(document.addEventListener("transitionend",this.onTransitionEnd_),window.addEventListener("resize",this.refresh),xa?(this.mutationsObserver_=new MutationObserver(this.refresh),this.mutationsObserver_.observe(document,{attributes:!0,childList:!0,characterData:!0,subtree:!0})):(document.addEventListener("DOMSubtreeModified",this.refresh),this.mutationEventsAdded_=!0),this.connected_=!0)},e.prototype.disconnect_=function(){!zr||!this.connected_||(document.removeEventListener("transitionend",this.onTransitionEnd_),window.removeEventListener("resize",this.refresh),this.mutationsObserver_&&this.mutationsObserver_.disconnect(),this.mutationEventsAdded_&&document.removeEventListener("DOMSubtreeModified",this.refresh),this.mutationsObserver_=null,this.mutationEventsAdded_=!1,this.connected_=!1)},e.prototype.onTransitionEnd_=function(t){var r=t.propertyName,n=r===void 0?"":r,o=ya.some(function(i){return!!~n.indexOf(i)});o&&this.refresh()},e.getInstance=function(){return this.instance_||(this.instance_=new e),this.instance_},e.instance_=null,e}(),Jn=function(e,t){for(var r=0,n=Object.keys(t);r0},e}(),Zn=typeof WeakMap!="undefined"?new WeakMap:new Bn,eo=function(){function e(t){if(!(this instanceof e))throw new TypeError("Cannot call a class as a function.");if(!arguments.length)throw new TypeError("1 argument required, but only 0 present.");var r=Ea.getInstance(),n=new Ra(t,r,this);Zn.set(this,n)}return e}();["observe","unobserve","disconnect"].forEach(function(e){eo.prototype[e]=function(){var t;return(t=Zn.get(this))[e].apply(t,arguments)}});var ka=function(){return typeof nr.ResizeObserver!="undefined"?nr.ResizeObserver:eo}(),to=ka;var ro=new E,Ha=I(()=>H(new to(e=>{for(let t of e)ro.next(t)}))).pipe(x(e=>L(Te,H(e)).pipe(C(()=>e.disconnect()))),J(1));function de(e){return{width:e.offsetWidth,height:e.offsetHeight}}function ge(e){return Ha.pipe(S(t=>t.observe(e)),x(t=>ro.pipe(_(({target:r})=>r===e),C(()=>t.unobserve(e)),l(()=>de(e)))),N(de(e)))}function bt(e){return{width:e.scrollWidth,height:e.scrollHeight}}function ar(e){let t=e.parentElement;for(;t&&(e.scrollWidth<=t.scrollWidth&&e.scrollHeight<=t.scrollHeight);)t=(e=t).parentElement;return t?e:void 0}var no=new E,Pa=I(()=>H(new IntersectionObserver(e=>{for(let t of e)no.next(t)},{threshold:0}))).pipe(x(e=>L(Te,H(e)).pipe(C(()=>e.disconnect()))),J(1));function sr(e){return Pa.pipe(S(t=>t.observe(e)),x(t=>no.pipe(_(({target:r})=>r===e),C(()=>t.unobserve(e)),l(({isIntersecting:r})=>r))))}function oo(e,t=16){return dt(e).pipe(l(({y:r})=>{let n=de(e),o=bt(e);return r>=o.height-n.height-t}),Y())}var cr={drawer:V("[data-md-toggle=drawer]"),search:V("[data-md-toggle=search]")};function io(e){return cr[e].checked}function qe(e,t){cr[e].checked!==t&&cr[e].click()}function je(e){let t=cr[e];return b(t,"change").pipe(l(()=>t.checked),N(t.checked))}function $a(e,t){switch(e.constructor){case HTMLInputElement:return e.type==="radio"?/^Arrow/.test(t):!0;case HTMLSelectElement:case HTMLTextAreaElement:return!0;default:return e.isContentEditable}}function Ia(){return L(b(window,"compositionstart").pipe(l(()=>!0)),b(window,"compositionend").pipe(l(()=>!1))).pipe(N(!1))}function ao(){let e=b(window,"keydown").pipe(_(t=>!(t.metaKey||t.ctrlKey)),l(t=>({mode:io("search")?"search":"global",type:t.key,claim(){t.preventDefault(),t.stopPropagation()}})),_(({mode:t,type:r})=>{if(t==="global"){let n=_e();if(typeof n!="undefined")return!$a(n,r)}return!0}),fe());return Ia().pipe(x(t=>t?R:e))}function Me(){return new URL(location.href)}function ot(e){location.href=e.href}function so(){return new E}function co(e,t){if(typeof t=="string"||typeof t=="number")e.innerHTML+=t.toString();else if(t instanceof Node)e.appendChild(t);else if(Array.isArray(t))for(let r of t)co(e,r)}function M(e,t,...r){let n=document.createElement(e);if(t)for(let o of Object.keys(t))typeof t[o]!="undefined"&&(typeof t[o]!="boolean"?n.setAttribute(o,t[o]):n.setAttribute(o,""));for(let o of r)co(n,o);return n}function fr(e){if(e>999){let t=+((e-950)%1e3>99);return`${((e+1e-6)/1e3).toFixed(t)}k`}else return e.toString()}function fo(){return location.hash.substring(1)}function uo(e){let t=M("a",{href:e});t.addEventListener("click",r=>r.stopPropagation()),t.click()}function Fa(){return b(window,"hashchange").pipe(l(fo),N(fo()),_(e=>e.length>0),J(1))}function po(){return Fa().pipe(l(e=>se(`[id="${e}"]`)),_(e=>typeof e!="undefined"))}function Nr(e){let t=matchMedia(e);return Zt(r=>t.addListener(()=>r(t.matches))).pipe(N(t.matches))}function lo(){let e=matchMedia("print");return L(b(window,"beforeprint").pipe(l(()=>!0)),b(window,"afterprint").pipe(l(()=>!1))).pipe(N(e.matches))}function qr(e,t){return e.pipe(x(r=>r?t():R))}function ur(e,t={credentials:"same-origin"}){return ve(fetch(`${e}`,t)).pipe(ce(()=>R),x(r=>r.status!==200?Tt(()=>new Error(r.statusText)):H(r)))}function Ue(e,t){return ur(e,t).pipe(x(r=>r.json()),J(1))}function mo(e,t){let r=new DOMParser;return ur(e,t).pipe(x(n=>n.text()),l(n=>r.parseFromString(n,"text/xml")),J(1))}function pr(e){let t=M("script",{src:e});return I(()=>(document.head.appendChild(t),L(b(t,"load"),b(t,"error").pipe(x(()=>Tt(()=>new ReferenceError(`Invalid script: ${e}`))))).pipe(l(()=>{}),C(()=>document.head.removeChild(t)),Oe(1))))}function ho(){return{x:Math.max(0,scrollX),y:Math.max(0,scrollY)}}function bo(){return L(b(window,"scroll",{passive:!0}),b(window,"resize",{passive:!0})).pipe(l(ho),N(ho()))}function vo(){return{width:innerWidth,height:innerHeight}}function go(){return b(window,"resize",{passive:!0}).pipe(l(vo),N(vo()))}function yo(){return Q([bo(),go()]).pipe(l(([e,t])=>({offset:e,size:t})),J(1))}function lr(e,{viewport$:t,header$:r}){let n=t.pipe(X("size")),o=Q([n,r]).pipe(l(()=>Be(e)));return Q([r,t,o]).pipe(l(([{height:i},{offset:a,size:s},{x:f,y:c}])=>({offset:{x:a.x-f,y:a.y-c+i},size:s})))}(()=>{function e(n,o){parent.postMessage(n,o||"*")}function t(...n){return n.reduce((o,i)=>o.then(()=>new Promise(a=>{let s=document.createElement("script");s.src=i,s.onload=a,document.body.appendChild(s)})),Promise.resolve())}var r=class{constructor(n){this.url=n,this.onerror=null,this.onmessage=null,this.onmessageerror=null,this.m=a=>{a.source===this.w&&(a.stopImmediatePropagation(),this.dispatchEvent(new MessageEvent("message",{data:a.data})),this.onmessage&&this.onmessage(a))},this.e=(a,s,f,c,u)=>{if(s===this.url.toString()){let p=new ErrorEvent("error",{message:a,filename:s,lineno:f,colno:c,error:u});this.dispatchEvent(p),this.onerror&&this.onerror(p)}};let o=new EventTarget;this.addEventListener=o.addEventListener.bind(o),this.removeEventListener=o.removeEventListener.bind(o),this.dispatchEvent=o.dispatchEvent.bind(o);let i=document.createElement("iframe");i.width=i.height=i.frameBorder="0",document.body.appendChild(this.iframe=i),this.w.document.open(),this.w.document.write(` + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Building

+

This is a summary. For additional guidance, please refer to the Reloaded-II documentation.

+

To build the mod, you will require the following components:

+ +

Steps

+
    +
  • +

    Clone this repository (and its submodules). +

    git clone --recursive https://github.com/Sewer56/Riders.Tweakbox.git
+

    +
    • +
  • +

    Add an environment variable named RELOADEDIIMODS.

    +
    • +
+

Environment Variable

+

The value should be the of the Mods folder in your Reloaded folder.

+
    +
  • Open Riders.Tweakbox.sln in Visual Studio or your preferred editing environment of choice.
    • +
+

Publishing

+

Publishing builds this mod in an optimized format such that it is ready for end users to consume.

+
    +
  1. +

    Open a PowerShell prompt and navigate to the Riders.Tweakbox folder.

    +
    2. +
  2. +

    Run the Publish script with .\Publish.ps1.

    +
    3. +
  3. +

    This will automatically build the mod, make a folder called Publish and put a zipped compiled version of the mod there ready to be shared.

    +
    4. +
+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/custom-gears/index.html b/custom-gears/index.html new file mode 100644 index 00000000..3b2db929 --- /dev/null +++ b/custom-gears/index.html @@ -0,0 +1,940 @@ + + + + + + + + + + + + + + + + + + + + + + + + Custom Gears - Riders.Tweakbox Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Adding Gears

+

Tweakbox allows you to add custom gears to the game, expanding the vanilla game's total gear selection up to 255 gears.

+

Screenshot

+

Each custom gear can have its own icon, title and name and be selectable by any of the characters involved.

+

Getting Started

+

You can add additional gears by creating Reloaded II mods.

+

This is a short summary of how to create a mod; for a more in-depth guide on creating mods, please refer to the Reloaded-II documentation.

+

1. Make a new Mod

+

Screenshot

+

Screenshot

+

2. Enable it for Sonic Riders

+

Screenshot

+

Screenshot

+

And go to your mod directory.

+

3. Create the Gear Directory

+

Inside mod directory, create a folder called Tweakbox and inside it, a folder called Gears.

+

Screenshot

+

Screenshot

+

4. Create the Gear

+

Inside Tweakbox, go to the Gear Editor, make desired changes to your gear and select Export as Custom Gear.

+

Screenshot

+

5. Copy the Gear

+

Tweakbox should open a folder in Windows Explorer. +Copy this folder to the folder you created in Step 3.

+

Screenshot

+

Screenshot

+

Make sure your mod is enabled in Reloaded and restart the game.

+

6. Update the Gear

+

After restarting, your gear should show up in the Gear Editor.

+

If you need to make any further changes to the gear, perform them via the Gear Editor and then press the Update Custom Gear Data button.

+

Screenshot

+

Animated Textures

+

In order to use animated textures for the icon and gear title, create a folder with the same name as the PNG without an extension.

+

Inside, put your animated texture keyframes.

+

Screenshot

+

Screenshot

+

For more information refer to the Animated Textures page.

+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/custom-music/index.html b/custom-music/index.html new file mode 100644 index 00000000..b4bb6ed0 --- /dev/null +++ b/custom-music/index.html @@ -0,0 +1,990 @@ + + + + + + + + + + + + + + + + + + + + + + + + Music - Riders.Tweakbox Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Adding Music

+

Riders.Tweakbox allows you to add ADX music to the game to provide alternative tracks to the game's default soundtrack.

+

When the game is about to play a music track, Tweakbox will randomly choose from a collection of vanilla tracks + all of the user provided tracks.

+

Don't know how to create an ADX track? Google it!

+

Getting Started

+

You can add/replace music by creating Reloaded II mods.

+

This is a short summary of how to create a mod; for a more in-depth guide on creating mods, please refer to the Reloaded-II documentation.

+

1. Make a new Mod

+

Screenshot

+

Screenshot

+

2. Enable it for Sonic Riders

+

Screenshot

+

Screenshot

+

And go to your mod directory.

+

3. Create the Music Directory

+

Inside mod directory, create a folder called Tweakbox and inside it, a folder called Music.

+

Screenshot

+

Screenshot

+

4. Add the Music

+

Screenshot

+

Tweakbox detects newly added music in real time. If you add a track, it will become a candidate to be played next time.

+

Replacement Modes

+

Tweakbox supports two modes of music replacement:
+- Per File
+- Per Stage

+

Per File

+

In this mode, if you add a file with name equivalent to a vanilla track; it will (randomly) replace the vanilla track.

+

Screenshot

+

Per Stage

+

In this mode, you can add a music track to be (randomly) played on a specific stage.

+

To use this mode, name your music file STGXX where XX represents the index of the track, for example:

+
    +
  • 00 = Test Level
    • +
  • 01 = Metal City
    • +
  • 02 = Splash Canyon
    • +
  • 09 = Night Chase
    • +
+

Screenshot

+

Multiple Music Tracks

+

If you have multiple music tracks which you wish to include to replace a single track, put them in separate folders:

+

Screenshot

+

Screenshot

+

In this example, each of the folders has a file called S20.adx inside.
+In this example, we add 16 menu themes to the game.

+

Customizing Behaviour

+

You can customize the music injection behaviour inside Tweakbox Settings.

+

Screenshot

+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/features/index.html b/features/index.html new file mode 100644 index 00000000..f7ca72d7 --- /dev/null +++ b/features/index.html @@ -0,0 +1,993 @@ + + + + + + + + + + + + + + + + + + + + + + + + Features - Riders.Tweakbox Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Features

+

✔ Fully Implemented & Reliably Working
+⚠ Work in Progress / Has Issues
+❌ Not Yet Implemented
+💢 Not Yet Implemented (Low Priority)

+

🌍 Netplay / Online Multiplayer

+

Screenshot

+

🚀 General Features

+

✔ Single-Screen Mode
+✔ Split-Screen Mode
+✔ Spectator Mode
+✔ Multiplayer Online
+✔ Custom Jitter Buffer (Reduced Player Stuttering)
+✔ NAT Punching (No Port Forwarding Required)
+✔ Server Browser
+✔ Texture Injection
+✔ Music Injection
+💢 Custom Game Modes (Relay, Hide & Seek)

+ +

✔ Stage Select Menu
+✔ Character Select Menu
+✔ Race Settings Menu
+✔ Return Straight to Stage Select Post Race
+✔ Disconnect Clients Leaving Stage Select Post Race

+

💥 In-Race

+

✔ Accurate Physics (Speed, Rotation, Position, Turning, AnalogInput)
+✔ Accurate Attacks (Client-Side)
+✔ Accurate Race Start Time (~1 frame difference)
+✔ Player State
+✔ Game Data (Custom Gears/Physics)
+✔ Lap Counter
+✔ Race Finish Time
+✔ Skip Intro Cutscene
+✔ Control Player Post Race Finish (It's Funny!)

+

⚠ Random Number Generator*
+⚠ Separate Item Random Number Generator**

+

✔ Pauseless Pause Menu
+✔ Post-Race Pause/Results Menu Synchronization
+❌ Ramp/Trick Synchronization
+💢 Player Indicators in Split Screen
+💢 Player Indicators for 5P/6P/7P/8P
+💢 Lap Timer Synchronization
+💢 Battle Mode Spawn Synchronization
+💢 Battle Mode Health Synchronization
+💢 Movement Extrapolation (Roll-forward/Real-time prediction of player position)

+

* Desyncs in single-screen mode due to off-screen objects seeding RNG.
+** Can desync on extremely unstable connections.

+

🛑 Anti-Cheat

+

An optional feature for when things become more stable...

+

💢 Anti Lap Counter Manipulation
+💢 Anti Ring Counter Manipulation
+💢 Anti Teleport
+💢 Anti Gear & Physics Data Manipulation
+💢 Anti Speed Hack
+💢 Anti RNG Unrandomizer

+

✨ Graphics

+

✔ Use Direct3D 9Ex Renderer (better fullscreen, performance gains)
+✔ Fixed Performance Issues on Multi-core Systems
+✔ Fixed Frame Pacing (no more micro-stutters)
+✔ Borderless Windowed
+✔ Custom Resolution
+✔ Toggle Blur
+⚠ Dynamic Widescreen Hack*

+

* WIP, Suggest using GameMasterPlc's Widescreen EXE in the Meantime.

+

⚙️ Editors

+

✔ Gear Editor
+✔ Physics Editor
+- ✔ Running Physics
+- ✔ Character Type Stats

+

🎮 Gameplay

+

✔ Simulate Keyboard QTE Bug
+✔ Force Single Player Stages
+✔ Force Single Player Models

+

🌌 Miscellaneous

+

✔ Boot to Menu
+✔ Unlock All
+✔ Import Gear Data from Dolphin Emulator (GameCube Version)
+✔ Various Debug Tools

+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 00000000..765a660d --- /dev/null +++ b/index.html @@ -0,0 +1,804 @@ + + + + + + + + + + + + + + + + + + + + + + Riders.Tweakbox Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Home

+ +
+

Tweakbox for Sonic Riders

+
+ ⛸ Catch me if you can 🛹 +

All in one mod for Sonic Riders PC.

+
+ +

Also commonly known as the "Netplay Mod", Tweakbox is an all in one Reloaded II mod for Sonic Riders which adds various pieces of functionality to the PC version of Sonic Riders.

+

This project is currently a "work in progress"; while it is usable/playable, this project is not yet "ready for public consumption" at this moment in time. Tread at your own risk.

+

Samples

+
+
+

*Online Mutliplayer*

+
+ +
+
+

*Gear & Physics Editing*

+
+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/installation/index.html b/installation/index.html new file mode 100644 index 00000000..beea8e00 --- /dev/null +++ b/installation/index.html @@ -0,0 +1,845 @@ + + + + + + + + + + + + + + + + + + + + + + + + Installation - Riders.Tweakbox Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Installation

+
+

Please do not ask for Tech Support (e.g. "How do I use this mod"). The mod is incomplete, buggy and still a work in progress; it is not yet in a state I consider acceptable for normal end users. Thank you.

+
+

Prerequisites

+ +

Recommendations

+
    +
  • GameMaster's 16:9 EXE
    • +
  • Optional: Use either this or Tweakbox' (incomplete) widescreen hack. Resolution can be overwritten inside Tweakbox.
    • +
+

Instructions

+

This is a Reloaded-II mod.
+If you are unfamiliar with Reloaded-II, consider looking here.

+
    +
  • Download Riders.Tweakbox.zip.
    • +
  • Navigate to the Mods folder inside your Reloaded folder.
    • +
  • Create a folder called riders.utils.tweakbox.
    • +
  • Extract the contents of the zip to the folder you just created.
    • +
  • Enable inside the Reloaded-II launcher.
    • +
+

+

PLEASE report any bugs/inconsistencies/crashes as soon as you encounter them using the guidelines listed in reporting-issues.

+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/optimizing-textures/index.html b/optimizing-textures/index.html new file mode 100644 index 00000000..420fbaf5 --- /dev/null +++ b/optimizing-textures/index.html @@ -0,0 +1,908 @@ + + + + + + + + + + + + + + + + + + + + + + + + Optimizing Textures - Riders.Tweakbox Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Optimizing Textures

+

These are just very basic guidelines towards optimizing textures for efficiency, such that they can load fast, run fast and use little memory.

+

The optimizations here can also be manually applied by my texture optimisation tool.

+

My general advice is to make very high resolution textures and then simply scale them down to multiple target resolutions using an automated tool like mine.

+

Optimizing for Size

+

It is recommended that you scale your texture resolutions using powers of 2 compared to the original game.

+

The original game was optimized around displaying on a 480p screen, as such, if you are targeting a 960p screen and your texture was 128x128, your texture should be 256x256.

+

As a general rule of thumb:
+- For up to 720p target 2x original Resolution (960p)
+- For up to 1440p target 4x original Resolution (1920p)
+- For up to 5K target 8x original Resolution (3840p)

+

Ideally, you should provide separate downloads for the first two options above.

+

It is also important you maintain aspect ratio of the original textures and use powers of 2 for width and height.

+

Texture Compression

+

While Tweakbox supports PNGs, it is recommended that you only use them for testing as they are slow to load and use a lot of memory.

+

You should use instead use DDS files with native texture compression formats. +Unfortunately, as Riders runs on DirectX 9, support for efficient, high quality texture formats is limited.

+

The best candidates, DXT1 & DXT5 can be a tiny bit blocky and produce color banding where there are sporadic changes in colour (e.g. rainbow gradient). Uncompressed textures on the other hand (PNG, R8G8B8A8) are very memory inefficient.

+

Recommendation:

+
    +
  • UI elements: Use uncompressed textures (DDS w/ R8G8B8A8).
    • +
  • Stage elements: Use DXT1 (no transparency) & DXT5 (transparency) where applicable.
    • +
+

Uncompressed textures are very large, so consider using my optimisation tool with the custom DDS.LZ4 format supported by Tweakbox.

+

Memory Usage

+
    +
  • Doubling your resolution (256x256 -> 512x512) increases memory usage by 4 times.
    • +
+

Texture Formats

+
    +
  • R8G8B8A8 is uncompressed and uses 4 bytes per pixel.
    • +
  • DXT5 uses 1 byte per pixel. (75% reduction)
    • +
  • DXT1 uses 0.5 byte per pixel. (87.5% reduction)
    • +
+

PNGs are automatically decoded to R8G8B8A8, and thus use 4 bytes.

+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/reporting-issues/index.html b/reporting-issues/index.html new file mode 100644 index 00000000..39c2a816 --- /dev/null +++ b/reporting-issues/index.html @@ -0,0 +1,831 @@ + + + + + + + + + + + + + + + + + + + + + + + + Reporting Issues - Riders.Tweakbox Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Reporting Issues

+

I am currently interested in:
+- Netplay Crashes
+- Misc. Bugs

+

What to Include (Crash Reports)

+

When submitting a crash report, you should include the following:

+
+
    +
  • Reloaded Console Log
    • +
+

You can find the log if you navigate to %appdata%/Reloaded-Mod-Loader-II/Logs inside explorer.

+

Image

+

Sort by "Date Modified" and grab the latest log.

+

Image

+
+
    +
  • Crash Dump
    • +
+

Open Windows Explorer and navigate to %localappdata%/CrashDumps.

+

Image

+

Sort by "date modified" and copy the latest dump with SonicRiders.exe in the name.

+
+

If you are recording your gameplay, the moment of the crash would also be greatly appreciated.

+

Where to Report Issues?

+

Preferably if possible, please report issues to GitHub Issues.

+

Alternatively, you can contact me in the Extreme Gear Labs Discord Channel; use any channel of you liking.

+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/search/search_index.json b/search/search_index.json new file mode 100644 index 00000000..0b73b095 --- /dev/null +++ b/search/search_index.json @@ -0,0 +1 @@ +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Home","text":"Tweakbox for Sonic Riders \u26f8 Catch me if you can \ud83d\udef9

All in one mod for Sonic Riders PC.

Also commonly known as the \"Netplay Mod\", Tweakbox is an all in one Reloaded II mod for Sonic Riders which adds various pieces of functionality to the PC version of Sonic Riders.

This project is currently a \"work in progress\"; while it is usable/playable, this project is not yet \"ready for public consumption\" at this moment in time. Tread at your own risk.

"},{"location":"#samples","title":"Samples","text":"

*Online Mutliplayer*

*Gear & Physics Editing*

"},{"location":"animated-textures/","title":"Animated Textures","text":"

Riders.Tweakbox provides basic support for animated textures.

In order to make an animated texture, you should create a folder with the name of the texture; and inside that folder, make files with file names corresponding to individual keyframes of the animation.

The built-in texture animator will play back your animation, starting with the last frame of animation. As Riders runs at 60 frames per second, a file with the name of 060, will run on the 60th frame.

Tip: When dealing with many textures, a tool like Bulk Rename Utility might come in handy.

"},{"location":"animated-textures/#warning","title":"Warning","text":"

It is recommended to use this feature sparringly.

High framerate animated textures are expensive on video memory, especially when paired with high resolutions. Going too far might make it hard for people with integrated graphics to run your mod.

PLEASE OPTIMISE YOUR ANIMATED TEXTURES The examples here use PNGs for clarity; when you release your textures, you should use native DDS files.

"},{"location":"animated-textures/#basic-example","title":"Basic Example","text":"

Alternate between two colours using a specified time interval.

In this scenario, the green texture for 30 frames (0.5 seconds) before switching to the red texture. After another 30 frames, you will go back to the green texture.

"},{"location":"animated-textures/#more-colours","title":"More Colours","text":"
  • The pink texture will show for 20 frames.
  • Then the green will show for 30 frames.
  • Then the light blue w ill show for 40 frames.
  • Then the blue will show for 50 frames. repeat
"},{"location":"animated-textures/#full-animation","title":"Full Animation","text":"

Create Hyper Sonic by changing Super Sonic's texture every frame.

[Frame 74 of the Animation]

"},{"location":"building/","title":"Building","text":"

This is a summary. For additional guidance, please refer to the Reloaded-II documentation.

To build the mod, you will require the following components:

  • Git
  • .NET 6 SDK
  • Visual Studio 2022
"},{"location":"building/#steps","title":"Steps","text":"

  • Clone this repository (and its submodules). 

    git clone --recursive https://github.com/Sewer56/Riders.Tweakbox.git\n

  • Add an environment variable named RELOADEDIIMODS.

The value should be the of the Mods folder in your Reloaded folder.

  • Open Riders.Tweakbox.sln in Visual Studio or your preferred editing environment of choice.
"},{"location":"building/#publishing","title":"Publishing","text":"

Publishing builds this mod in an optimized format such that it is ready for end users to consume.

  1. Open a PowerShell prompt and navigate to the Riders.Tweakbox folder.

  2. Run the Publish script with .\\Publish.ps1.

  3. This will automatically build the mod, make a folder called Publish and put a zipped compiled version of the mod there ready to be shared.

"},{"location":"custom-gears/","title":"Adding Gears","text":"

Tweakbox allows you to add custom gears to the game, expanding the vanilla game's total gear selection up to 255 gears.

Each custom gear can have its own icon, title and name and be selectable by any of the characters involved.

"},{"location":"custom-gears/#getting-started","title":"Getting Started","text":"

You can add additional gears by creating Reloaded II mods.

This is a short summary of how to create a mod; for a more in-depth guide on creating mods, please refer to the Reloaded-II documentation.

"},{"location":"custom-gears/#1-make-a-new-mod","title":"1. Make a new Mod","text":""},{"location":"custom-gears/#2-enable-it-for-sonic-riders","title":"2. Enable it for Sonic Riders","text":"

And go to your mod directory.

"},{"location":"custom-gears/#3-create-the-gear-directory","title":"3. Create the Gear Directory","text":"

Inside mod directory, create a folder called Tweakbox and inside it, a folder called Gears.

"},{"location":"custom-gears/#4-create-the-gear","title":"4. Create the Gear","text":"

Inside Tweakbox, go to the Gear Editor, make desired changes to your gear and select Export as Custom Gear.

"},{"location":"custom-gears/#5-copy-the-gear","title":"5. Copy the Gear","text":"

Tweakbox should open a folder in Windows Explorer. Copy this folder to the folder you created in Step 3.

Make sure your mod is enabled in Reloaded and restart the game.

"},{"location":"custom-gears/#6-update-the-gear","title":"6. Update the Gear","text":"

After restarting, your gear should show up in the Gear Editor.

If you need to make any further changes to the gear, perform them via the Gear Editor and then press the Update Custom Gear Data button.

"},{"location":"custom-gears/#animated-textures","title":"Animated Textures","text":"

In order to use animated textures for the icon and gear title, create a folder with the same name as the PNG without an extension.

Inside, put your animated texture keyframes.

For more information refer to the Animated Textures page.

"},{"location":"custom-music/","title":"Adding Music","text":"

Riders.Tweakbox allows you to add ADX music to the game to provide alternative tracks to the game's default soundtrack.

When the game is about to play a music track, Tweakbox will randomly choose from a collection of vanilla tracks + all of the user provided tracks.

Don't know how to create an ADX track? Google it!

"},{"location":"custom-music/#getting-started","title":"Getting Started","text":"

You can add/replace music by creating Reloaded II mods.

This is a short summary of how to create a mod; for a more in-depth guide on creating mods, please refer to the Reloaded-II documentation.

"},{"location":"custom-music/#1-make-a-new-mod","title":"1. Make a new Mod","text":""},{"location":"custom-music/#2-enable-it-for-sonic-riders","title":"2. Enable it for Sonic Riders","text":"

And go to your mod directory.

"},{"location":"custom-music/#3-create-the-music-directory","title":"3. Create the Music Directory","text":"

Inside mod directory, create a folder called Tweakbox and inside it, a folder called Music.

"},{"location":"custom-music/#4-add-the-music","title":"4. Add the Music","text":"

Tweakbox detects newly added music in real time. If you add a track, it will become a candidate to be played next time.

"},{"location":"custom-music/#replacement-modes","title":"Replacement Modes","text":"

Tweakbox supports two modes of music replacement: - Per File - Per Stage

"},{"location":"custom-music/#per-file","title":"Per File","text":"

In this mode, if you add a file with name equivalent to a vanilla track; it will (randomly) replace the vanilla track.

"},{"location":"custom-music/#per-stage","title":"Per Stage","text":"

In this mode, you can add a music track to be (randomly) played on a specific stage.

To use this mode, name your music file STGXX where XX represents the index of the track, for example:

  • 00 = Test Level
  • 01 = Metal City
  • 02 = Splash Canyon
  • 09 = Night Chase

"},{"location":"custom-music/#multiple-music-tracks","title":"Multiple Music Tracks","text":"

If you have multiple music tracks which you wish to include to replace a single track, put them in separate folders:

In this example, each of the folders has a file called S20.adx inside. In this example, we add 16 menu themes to the game.

"},{"location":"custom-music/#customizing-behaviour","title":"Customizing Behaviour","text":"

You can customize the music injection behaviour inside Tweakbox Settings.

"},{"location":"features/","title":"Features","text":"

\u2714 Fully Implemented & Reliably Working \u26a0 Work in Progress / Has Issues \u274c Not Yet Implemented \ud83d\udca2 Not Yet Implemented (Low Priority)

"},{"location":"features/#netplay-online-multiplayer","title":"\ud83c\udf0d Netplay / Online Multiplayer","text":""},{"location":"features/#general-features","title":"\ud83d\ude80 General Features","text":"

\u2714 Single-Screen Mode \u2714 Split-Screen Mode \u2714 Spectator Mode \u2714 Multiplayer Online \u2714 Custom Jitter Buffer (Reduced Player Stuttering) \u2714 NAT Punching (No Port Forwarding Required) \u2714 Server Browser \u2714 Texture Injection \u2714 Music Injection \ud83d\udca2 Custom Game Modes (Relay, Hide & Seek)

"},{"location":"features/#menu-synchronization","title":"\ud83d\udcab Menu Synchronization","text":"

\u2714 Stage Select Menu \u2714 Character Select Menu \u2714 Race Settings Menu \u2714 Return Straight to Stage Select Post Race \u2714 Disconnect Clients Leaving Stage Select Post Race

"},{"location":"features/#in-race","title":"\ud83d\udca5 In-Race","text":"

\u2714 Accurate Physics (Speed, Rotation, Position, Turning, AnalogInput) \u2714 Accurate Attacks (Client-Side) \u2714 Accurate Race Start Time (~1 frame difference) \u2714 Player State \u2714 Game Data (Custom Gears/Physics) \u2714 Lap Counter \u2714 Race Finish Time \u2714 Skip Intro Cutscene \u2714 Control Player Post Race Finish (It's Funny!)

\u26a0 Random Number Generator* \u26a0 Separate Item Random Number Generator**

\u2714 Pauseless Pause Menu \u2714 Post-Race Pause/Results Menu Synchronization \u274c Ramp/Trick Synchronization \ud83d\udca2 Player Indicators in Split Screen \ud83d\udca2 Player Indicators for 5P/6P/7P/8P \ud83d\udca2 Lap Timer Synchronization \ud83d\udca2 Battle Mode Spawn Synchronization \ud83d\udca2 Battle Mode Health Synchronization \ud83d\udca2 Movement Extrapolation (Roll-forward/Real-time prediction of player position)

* Desyncs in single-screen mode due to off-screen objects seeding RNG. ** Can desync on extremely unstable connections.

"},{"location":"features/#anti-cheat","title":"\ud83d\uded1 Anti-Cheat","text":"

An optional feature for when things become more stable...

\ud83d\udca2 Anti Lap Counter Manipulation \ud83d\udca2 Anti Ring Counter Manipulation \ud83d\udca2 Anti Teleport \ud83d\udca2 Anti Gear & Physics Data Manipulation \ud83d\udca2 Anti Speed Hack \ud83d\udca2 Anti RNG Unrandomizer

"},{"location":"features/#graphics","title":"\u2728 Graphics","text":"

\u2714 Use Direct3D 9Ex Renderer (better fullscreen, performance gains) \u2714 Fixed Performance Issues on Multi-core Systems \u2714 Fixed Frame Pacing (no more micro-stutters) \u2714 Borderless Windowed \u2714 Custom Resolution \u2714 Toggle Blur \u26a0 Dynamic Widescreen Hack*

* WIP, Suggest using GameMasterPlc's Widescreen EXE in the Meantime.

"},{"location":"features/#editors","title":"\u2699\ufe0f Editors","text":"

\u2714 Gear Editor \u2714 Physics Editor - \u2714 Running Physics - \u2714 Character Type Stats

"},{"location":"features/#gameplay","title":"\ud83c\udfae Gameplay","text":"

\u2714 Simulate Keyboard QTE Bug \u2714 Force Single Player Stages \u2714 Force Single Player Models

"},{"location":"features/#miscellaneous","title":"\ud83c\udf0c Miscellaneous","text":"

\u2714 Boot to Menu \u2714 Unlock All \u2714 Import Gear Data from Dolphin Emulator (GameCube Version) \u2714 Various Debug Tools

"},{"location":"installation/","title":"Installation","text":"

Please do not ask for Tech Support (e.g. \"How do I use this mod\"). The mod is incomplete, buggy and still a work in progress; it is not yet in a state I consider acceptable for normal end users. Thank you.

"},{"location":"installation/#prerequisites","title":"Prerequisites","text":"
  • Reloaded-II. (Quick Start)
  • Unmodified Copy of PC Riders
"},{"location":"installation/#recommendations","title":"Recommendations","text":"
  • GameMaster's 16:9 EXE
  • Optional: Use either this or Tweakbox' (incomplete) widescreen hack. Resolution can be overwritten inside Tweakbox.
"},{"location":"installation/#instructions","title":"Instructions","text":"

This is a Reloaded-II mod. If you are unfamiliar with Reloaded-II, consider looking here.

  • Download Riders.Tweakbox.zip.
  • Navigate to the Mods folder inside your Reloaded folder.
  • Create a folder called riders.utils.tweakbox.
  • Extract the contents of the zip to the folder you just created.
  • Enable inside the Reloaded-II launcher.

PLEASE report any bugs/inconsistencies/crashes as soon as you encounter them using the guidelines listed in reporting-issues.

"},{"location":"optimizing-textures/","title":"Optimizing Textures","text":"

These are just very basic guidelines towards optimizing textures for efficiency, such that they can load fast, run fast and use little memory.

The optimizations here can also be manually applied by my texture optimisation tool.

My general advice is to make very high resolution textures and then simply scale them down to multiple target resolutions using an automated tool like mine.

"},{"location":"optimizing-textures/#optimizing-for-size","title":"Optimizing for Size","text":"

It is recommended that you scale your texture resolutions using powers of 2 compared to the original game.

The original game was optimized around displaying on a 480p screen, as such, if you are targeting a 960p screen and your texture was 128x128, your texture should be 256x256.

As a general rule of thumb: - For up to 720p target 2x original Resolution (960p) - For up to 1440p target 4x original Resolution (1920p) - For up to 5K target 8x original Resolution (3840p)

Ideally, you should provide separate downloads for the first two options above.

It is also important you maintain aspect ratio of the original textures and use powers of 2 for width and height.

"},{"location":"optimizing-textures/#texture-compression","title":"Texture Compression","text":"

While Tweakbox supports PNGs, it is recommended that you only use them for testing as they are slow to load and use a lot of memory.

You should use instead use DDS files with native texture compression formats. Unfortunately, as Riders runs on DirectX 9, support for efficient, high quality texture formats is limited.

The best candidates, DXT1 & DXT5 can be a tiny bit blocky and produce color banding where there are sporadic changes in colour (e.g. rainbow gradient). Uncompressed textures on the other hand (PNG, R8G8B8A8) are very memory inefficient.

"},{"location":"optimizing-textures/#recommendation","title":"Recommendation:","text":"
  • UI elements: Use uncompressed textures (DDS w/ R8G8B8A8).
  • Stage elements: Use DXT1 (no transparency) & DXT5 (transparency) where applicable.

Uncompressed textures are very large, so consider using my optimisation tool with the custom DDS.LZ4 format supported by Tweakbox.

"},{"location":"optimizing-textures/#memory-usage","title":"Memory Usage","text":"
  • Doubling your resolution (256x256 -> 512x512) increases memory usage by 4 times.
"},{"location":"optimizing-textures/#texture-formats","title":"Texture Formats","text":"
  • R8G8B8A8 is uncompressed and uses 4 bytes per pixel.
  • DXT5 uses 1 byte per pixel. (75% reduction)
  • DXT1 uses 0.5 byte per pixel. (87.5% reduction)

PNGs are automatically decoded to R8G8B8A8, and thus use 4 bytes.

"},{"location":"reporting-issues/","title":"Reporting Issues","text":"

I am currently interested in: - Netplay Crashes - Misc. Bugs

"},{"location":"reporting-issues/#what-to-include-crash-reports","title":"What to Include (Crash Reports)","text":"

When submitting a crash report, you should include the following:

  • Reloaded Console Log

You can find the log if you navigate to %appdata%/Reloaded-Mod-Loader-II/Logs inside explorer.

Sort by \"Date Modified\" and grab the latest log.

  • Crash Dump

Open Windows Explorer and navigate to %localappdata%/CrashDumps.

Sort by \"date modified\" and copy the latest dump with SonicRiders.exe in the name.

If you are recording your gameplay, the moment of the crash would also be greatly appreciated.

"},{"location":"reporting-issues/#where-to-report-issues","title":"Where to Report Issues?","text":"

Preferably if possible, please report issues to GitHub Issues.

Alternatively, you can contact me in the Extreme Gear Labs Discord Channel; use any channel of you liking.

"},{"location":"textures/","title":"Adding Textures","text":"

Riders.Tweakbox allows you to replace textures in real-time by hijacking function calls to the Direct3D 9 API.

"},{"location":"textures/#creating-a-texture-pack","title":"Creating a Texture Pack","text":"

You can add/replace textures by creating Reloaded II mods.

This is a short summary of how to create a mod; for a more in-depth guide on creating mods, please refer to the Reloaded-II documentation.

"},{"location":"textures/#1-make-a-new-mod","title":"1. Make a new Mod","text":""},{"location":"textures/#2-enable-it-for-sonic-riders","title":"2. Enable it for Sonic Riders","text":"

And go to your mod directory.

"},{"location":"textures/#3-create-the-texture-directory","title":"3. Create the Texture Directory","text":"

Inside mod directory, create a folder called Tweakbox and inside it, a folder called Textures.

"},{"location":"textures/#4-add-the-textures","title":"4. Add the Textures","text":"

Add textures in one of the supported formats.

Tweakbox detects newly added textures in real time; however cannot force Reload them. In other words, if you add a stage texture you will have to exit and re-enter the stage before the new texture takes effect.

"},{"location":"textures/#where-do-i-get-the-textures","title":"Where do I get the Textures?","text":"

The easiest way to get a hold of the stock textures is to use a known dumped texture set, such as the Community Sonic Riders Texture Library. (Has ~99% of the textures, neatly categorized).

Alternatively, you can dump them yourself from inside Tweakbox, if you visit the DirectX Texture Injection menu from Tweakbox.

"},{"location":"textures/#supported-formats","title":"Supported Formats","text":"
  • PNG
  • DDS
  • DDS.LZ4

In the case of DDS, there is no restriction on internal format; as long as DirectX supports it.

In the case of DDS.LZ4; it is a custom variant of DDS compressed with the LZ4 compression algorithm exported by my texture optimisation tool.

"},{"location":"BookOfTheTweakbox/","title":"Book of the Tweakbox","text":"

Welcome to the Book of the Tweakbox (BOTT) for Riders Tweakbox. This page contains a collection of articles about the internals of both Riders Tweakbox itself, as well as Sonic Riders. The intended audience of this book is people wishing to work on Tweakbox, or wishing to understand Tweakbox and/or the base game.

Page Description Introduction Describes the general structure/layout of Tweakbox' source code. Overlay Helper APIs Useful APIs for creating menus in Tweakbox. Heap Describes how Sonic Riders' memory allocator works."},{"location":"BookOfTheTweakbox/heap/","title":"Heap","text":"

Info

Explains how Sonic Riders' vanilla memory allocation system works.

"},{"location":"BookOfTheTweakbox/heap/#changes-in-tweakbox","title":"Changes in Tweakbox","text":"

Todo

To be added.

"},{"location":"BookOfTheTweakbox/introduction/","title":"Introduction","text":"

Info

Provides an introduction to Tweakbox' internal code structure, including how things are laid out.

"},{"location":"BookOfTheTweakbox/introduction/#initialization","title":"Initialization","text":"

Info

Provides a simplified top level view of how initialization happens in Tweakbox.

"},{"location":"BookOfTheTweakbox/introduction/#entry-point-program","title":"Entry Point (Program)","text":"

The life of Tweakbox begins in Program.StartEx(), this method is responsible for the following: - Setting up 3rd party libraries (e.g. one time method calls). - Fetching Reloaded dependencies [e.g. File Redirector to use with music]. - Adjusting anything runtime related.

Program then delegates to Tweakbox, which sets up Tweakbox' code.

"},{"location":"BookOfTheTweakbox/introduction/#tweakbox-entry-point-tweakbox","title":"Tweakbox Entry Point (Tweakbox)","text":"

The Tweakbox component is responsible for the following [in order]: - Sanity checks (e.g. ensure files don't use vanilla compression). - Setting up UI Menus. - Initialising all IConfiguration(s), ISingletonService(s) & IController(s) in this specific order.

"},{"location":"BookOfTheTweakbox/introduction/#components","title":"Components","text":"

Info

Defines the common kinds/types of items you'll find in Tweakbox' source code.

Note

Unless stated otherwise, assume components are singletons, i.e. there is only ONE instance of each configuration in memory and it's reused everywhere.

"},{"location":"BookOfTheTweakbox/introduction/#configs-iconfiguration","title":"Configs (IConfiguration)","text":"

Info

Stores an individual configuration for a component or a set of Tweakbox components.

Within Tweakbox' source, you will find two types of configurations, Binary and JSON.

JSON configurations are used when all of the data is known, and inherit from JsonConfigBase which provides all of the backbone code for the configuration(s).

Example: 

// JsonConfigBase inherits from IConfiguration and provides all needed boilerplate code.\npublic class TextureInjectionConfig : JsonConfigBase<TextureInjectionConfig, TextureInjectionConfig.Internal> {\npublic class Internal\n{\npublic bool DumpTextures = false;\npublic DumpingMode DumpingMode = DumpingMode.All;\npublic int DeduplicationMaxFiles = 2;\n}\n\npublic enum DumpingMode\n{\nAll = 0,\nOnlyNew = 1,\nDeduplicate = 2,\n}\n}\n

Binary configurations are typically used when the data: - Needs to be small. - Contains unknown values (e.g. Not fully reversed Sonic Riders' game structs).

Example Binary configuration: 

public unsafe class GearEditorConfig : IConfiguration\n{\nprivate static GearEditorConfig _default = new GearEditorConfig();\n\n/// <summary>\n/// Extreme gears assigned to this config.\n/// </summary>\npublic ExtremeGear[] Gears;\n\n/// <summary>\n/// Creates the default editor config.\n/// </summary>\npublic GearEditorConfig()\n{\nGears = new ExtremeGear[Player.OriginalNumberOfGears];\nPlayer.Gears.CopyTo(Gears, Gears.Length);\n}\n\n/// <summary>\n/// Creates a <see cref=\"GearEditorConfig\"/> from the values present in game memory.\n/// </summary>\npublic static GearEditorConfig FromGame() => new GearEditorConfig();\n\n/// <summary>\n/// Updates the game information with the gear data stored in the class.\n/// </summary>\npublic unsafe void Apply() => Player.Gears.CopyFrom(Gears, Player.OriginalNumberOfGears);\n\n/// <inheritdoc />\npublic Action ConfigUpdated { get; set; }\npublic byte[] ToBytes() => LZ4.CompressLZ4Stream(StructArray.GetBytes(Gears), LZ4Level.L12_MAX);\n\npublic void FromBytes(Span<byte> bytes)\n{\nvar outputArray = new byte[StructArray.GetSize<ExtremeGear>(Player.OriginalNumberOfGears)];\nvar decompressed = LZ4.DecompressLZ4Stream(outputArray, bytes, out int bytesRead);\n\nStructArray.FromArray(decompressed, out Gears, true, Player.OriginalNumberOfGears);\nConfigUpdated?.Invoke();\n}\n\npublic IConfiguration GetCurrent() => FromGame();\npublic IConfiguration GetDefault() => _default;\n}\n

[Stores the whole array of all extreme gear data in Riders]

"},{"location":"BookOfTheTweakbox/introduction/#services-isingletonservice","title":"Services (ISingletonService)","text":"

Info

Provides various utility functions to be used throughout Tweakbox. Also a singleton.

Example API(s): 

/// <summary>\n/// Keeps track of all music tracks provided by other mods (as well as the vanilla game)\n/// </summary>\npublic class MusicService\n{\n/// <summary>\n/// Gets the name of a random alternative track for a given file name.\n/// </summary>\n/// <param name=\"fileName\">The file name for which to get a replacement track.</param>\n/// <param name=\"includeVanilla\">Whether to include vanilla tracks or not.</param>\n/// <param name=\"includePerStageTracks\">Whether to include stage-specific tracks.</param>\n/// <returns>Path to the replacement track.</returns>\npublic unsafe string GetRandomTrack(string fileName, bool includeVanilla, bool includePerStageTracks);\n\n/// <summary>\n/// Obtains all potential candidate tracks for a given stage.\n/// </summary>\n/// <param name=\"stageId\">The stage index.</param>\n/// <param name=\"files\">List of files to add the candidates to.</param>\npublic void GetTracksForStage(int stageId, List<string> files);\n}\n
/// <summary>\n/// Converts Sonic Riders' PVRT texture format to DDS using the game's built-in converter.\n/// </summary>\npublic class PvrtConverterService : ISingletonService\n{\n/// <summary>\n/// Converts a texture to DDS.\n/// </summary>\n/// <param name=\"pvrtData\">The PVRT texture to convert.</param>\n/// <returns>DDS data generated from PVRT.</returns>\npublic unsafe byte[] Convert(Span<byte> pvrtData);\n}\n
"},{"location":"BookOfTheTweakbox/introduction/#controllers-icontroller","title":"Controllers (IController)","text":"

Info

Controllers contain all the functionality that modifies directly how the game itself functions. These controllers usually 'hook' into the game code, by either replacing the method or injecting some assembly code.

Random Example(s):

Controller Description MusicInjectionController Replaces the music track(s) that will be loaded by the game. IgnoreTurbulenceController The 'C toggle' for ignoring turbulence if desired. BorderlessWindowedController Toggles the game's Borderless Windowed state during startup and in real time. RailController Controls the speed of the Rails. AutoSectionController Automates Left+Right inputs during automated sections.

Within controllers there exists one special case, EventController. This controller is implemented mainly in x86 assembly, split over multiple files and provides callbacks which you can subscribe to that modify various game behaviours.

For example: 

EventController.SetRingsOnHit += SetRingsOnHit;\nprivate void SetRingsOnHit(Player* player) => player->Rings = 42;\n

"},{"location":"BookOfTheTweakbox/introduction/#menus-icomponent","title":"Menus (IComponent)","text":"

Info

Menus use the IComponent interface and are created + registered during Tweakbox startup.

Random Example(s):

Controller Description AboutMenu Renders the about page. TweakboxSettings Renders the Tweakbox general settings menu. SlipstreamDebug Shows slipstream data in real time."},{"location":"BookOfTheTweakbox/introduction/#creating-menus","title":"Creating Menus","text":"

In practice, all menus inherit from ComponentBase or ComponentBase<TConfig>, which provide a default implementation of IComponent.

Sample dummy menu (via ComponentBase): 

// Renders \npublic class DummyMenu : ComponentBase\n{\npublic override string Name { get; set; } = \"Dummy Menu\";\npublic override void Render()\n{\nif (ImGui.Begin(Name, ref IsEnabled(), 0))\n{\n// Code to render menu here\n\n}\n\nImGui.End();\n}\n}\n

If you need to have a config for this menu, use ComponentBase<TConfig>. 

// InfoEditorConfig is an IConfiguration\npublic class InfoEditor : ComponentBase<InfoEditorConfig>, IComponent\n{\npublic override string Name { get; set; } = \"Info Editor\";\n\n// Note the constructor, it passes some stuff to base class.\npublic InfoEditor(IO io) : base(io, io.InfoConfigFolder, io.GetInfoConfigFiles, \".json\") { }\n\npublic override void Render()\n{\nif (ImGui.Begin(Name, ref IsEnabled(), 0))\n{\n// Provides the New/Delete/Load/Save part of the menu.\nProfileSelector.Render();\n\n// Code to render menu here\n}\n\nImGui.End();\n}\n}\n
"},{"location":"BookOfTheTweakbox/introduction/#registering-menus","title":"Registering Menus","text":"

Info

Custom Menus must be registered in Tweakbox.cs to show in the overlay.

Example: 

new MenuBarItem(\"Main\", new List<IComponent>()\n{\n// Your custom menu here.\nBenchmark(() => IoC.GetSingleton<DummyMenu>(), nameof(DummyMenu)), // Previously existing menus.\nBenchmark(() => IoC.GetSingleton<NetplayMenu>(), nameof(NetplayMenu)),\nBenchmark(() => IoC.GetSingleton<UserGuideWindow>(), nameof(UserGuideWindow)),\nBenchmark(() => IoC.GetSingleton<AboutMenu>(), nameof(AboutMenu)),\nBenchmark(() => IoC.GetSingleton<OpenSourceLibraries>(), nameof(OpenSourceLibraries)),\n})\n

"},{"location":"BookOfTheTweakbox/introduction/#projects","title":"Projects","text":"

Info

Provides a listing of projects within the Tweakbox source code.

Project Description Riders.Netplay.Messages Contains all code responsible for writing/reading individual messages over the network. Riders.Netplay.Messages.Tests Test code for messages library; can be barebones at times. Riders.Tweakbox.API.SDK Code for communicating with the Web Server providing server browser, ranking. Riders.Tweakbox Main mod code. Riders.Tweakbox.CharacterPack.DX Test/example mod for adding custom character behaviours. [Ports SRDX 1.0.1 char stats to Tweakbox] Riders.Tweakbox.Gearpack Test/example mod for adding custom gear behaviours. [Ports all gears from all mods released before late 2021] Riders.Tweakbox.Interfaces API for other mods to use. Recommend Reading: Dependency Injection in Reloaded-II Sewer56.Hooks.Utilities Helper code for manipulating game functions with x86 assembly. Sewer56.Imgui Helpers for creating menus. (Extensions for our Dear ImGui wrapper.) Sewer56.SonicRiders API and definitions for hacking Sonic Riders

[Some projects have been omitted to keep the list simpler.]

"},{"location":"BookOfTheTweakbox/overlay-helpers/","title":"Overlay Helpers","text":"

Info

Provides a small listing of helpful classes that may be used for creating UI elements.

"},{"location":"BookOfTheTweakbox/overlay-helpers/#controls","title":"Controls","text":"

Info

Contains all custom controls made for the Reloaded UI.

"},{"location":"BookOfTheTweakbox/overlay-helpers/#tooltips","title":"Tooltips","text":"

About

The Tooltip class can be used to display tooltips on individual UI elements.

(Using Tooltip.TextOnHover to display tooltip on last rendered UI element)

"},{"location":"BookOfTheTweakbox/overlay-helpers/#textinputdata","title":"TextInputData","text":"

About

Allocates memory to use in controls that allow the user to manipulate text. 

var username = new TextInputData(\"\", TextLength);\n\n// Calling 'Render' will give you a textbox.\nusername.Render(\"Username\");\n

The Render method is just for convenience since TextBox (InputText) is the most common control. You could use username.Pointer with other text based controls as needed.

"},{"location":"BookOfTheTweakbox/overlay-helpers/#profileselector","title":"ProfileSelector","text":"

About

Standalone widget for loading configuration files.

"},{"location":"BookOfTheTweakbox/overlay-helpers/#reflection","title":"Reflection","text":"

Info

Wrapper over some parts of the original API for easier drawing of UI elements. Could maybe use better name.

// Make a control to edit an integer with a parameter\nReflection.MakeControl(ref bufferSize, \"Default Buffer Size\");\n

This is defined as: 

// Internal Definition\npublic static bool MakeControl(ref Int32 value, string name)\n{\nreturn ImGui.DragScalar(name, (int)ImGuiDataType.ImGuiDataTypeS32, (IntPtr) Unsafe.AsPointer(ref value), 1.0F, IntPtr.Zero, IntPtr.Zero, null, 1);\n}\n

"},{"location":"BookOfTheTweakbox/overlay-helpers/#imagerenderer","title":"ImageRenderer","text":"

About

You can use this to render native DirectX textures inside the UI.

Example usage: 

imageRenderer = new ImageRenderer();\n\n// TextureOut is `LPDIRECT3DTEXTURE9 *ppTexture` as seen in e.g. `D3DXCreateTextureFrom` APIs.\nvar texturePtr = (IntPtr)(*currentImage.TextureOut);\nvar texture = new Texture(texturePtr);\nvar desc = texture.GetLevelDescription(0);\nimageRenderer.SetImageSize(new Vector2(desc.Width, desc.Height));\nimageRenderer.Render(texturePtr);\n

"},{"location":"BookOfTheTweakbox/overlay-helpers/#hyperlinks","title":"Hyperlinks","text":"

About

Clickable piece of text that opens a link or file.

Todo

Hyperlinks could be improved (change colour on hover, change mouse cursor) etc.

Use the Hyperlink.CreateText API.

"},{"location":"BookOfTheTweakbox/overlay-helpers/#layout","title":"Layout","text":"

Info

Contains helper classes related to setting up the layout of the windows and/or contents.

WIP

"},{"location":"BookOfTheTweakbox/overlay-helpers/#miscellaneous","title":"Miscellaneous","text":""},{"location":"BookOfTheTweakbox/overlay-helpers/#finalized","title":"Finalized

Note

This API will probably be removed.

In the past our Dear ImGui Wrapper which is made using CppSharp didn't have finalizers, which meant not using a using statement or Dispose() may have led to memory leaks. This is no longer the case so this class no longer has any use.

","text":""},{"location":"Changelogs/0.3.1/0.3.1/","title":"Changelog","text":"

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

"},{"location":"Changelogs/0.3.1/0.3.1/#early-access-notice","title":"Early Access Notice","text":"

Please note that this project is not yet ready for public consumption. Netplay is still incomplete, buggy and a work in progress. I do not yet consider this project acceptable for normal end users.

Please report any issues (especially crashes) using the guidelines provided in Reporting Issues.

Do not ask for Tech Support (e.g. \"How do I use this mod\").

"},{"location":"Changelogs/0.3.1/0.3.1/#031-2021-02-26","title":"0.3.1 - 2021-02-26","text":""},{"location":"Changelogs/0.3.1/0.3.1/#commits","title":"Commits","text":"
  • Added: Changelog for 0.3.0 14ecbd6
  • Changed: Make Netplay Descriptions more User Friendly 7bccddb
  • Changed: Added Documentation and Updated to 0.3.1 210b3be
  • Added: Github Pages Task 2df92ce
  • Fixed: AppVeyor not cloning submodules. 5e1cebd
  • Changed: Move releases to Github Releases f05ac5d
"},{"location":"Changelogs/0.4.0/0.4.0/","title":"Changelog","text":"

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

"},{"location":"Changelogs/0.4.0/0.4.0/#early-access-notice","title":"Early Access Notice","text":"

Please note that this project is not yet ready for public consumption. Netplay is still incomplete, buggy and a work in progress. I do not yet consider this project acceptable for normal end users.

Please report any issues (especially crashes) using the guidelines provided in Reporting Issues.

Do not ask for Tech Support (e.g. \"How do I use this mod\").

"},{"location":"Changelogs/0.4.0/0.4.0/#040-2021-03-03","title":"0.4.0 - 2021-03-03","text":""},{"location":"Changelogs/0.4.0/0.4.0/#commits","title":"Commits","text":""},{"location":"Changelogs/0.4.0/0.4.0/#fixed","title":"Fixed","text":"
  • Fixed: Ensure dotnet build removes any previous published builds. c45a435
  • Fixed: Course select now sets stage on menu exit. de66326
  • Fixed: Don't allow Modals (popups) at same level. Display one by one. 4f2fb13
  • Fixed: Possible crashes in RNG sync when only other player disconnects. 89c5711
  • Fixed: Character Selection not Synced under High Latency 291a56d
  • Fixed: Single Player Character Models crash in Heroes Story Mode 07fae38
"},{"location":"Changelogs/0.4.0/0.4.0/#changed","title":"Changed","text":"
  • Changed: Make Tweaks Editor a bit more User Friendly 7b25adb
  • Changed: Do not use RunPlayerPhysicsSimulation. Causes crashes. 44eaddd
  • Changed: Borrow device from GraphicsController in FramePacingController b1a11b4
  • Changed: Set custom disconnection timeout. 03cc5dc
  • Changed: Display unexplained disconnections to user. 64d159f
  • Changed: Separate out Menu & Shell Rendering 0e98422
  • Changed: Combined Adaptive Jitter Buffer into Single Class 13edec7
"},{"location":"Changelogs/0.4.0/0.4.0/#optimized","title":"Optimized","text":"
  • Optimized: Remove only peers who didn't report ready in RNG sync f012235
  • Optimized: Reduce delay time before race is started using probability. 3985c01
  • Optimized: Make Time Deltas More Accurate 09e4921
  • Log: Make LogItem a struct to reduce heap allocations. 51e0730
"},{"location":"Changelogs/0.4.0/0.4.0/#added","title":"Added","text":"
  • Added: Prerequisites Section to Installation Page f38833c
  • Added: [Debug] Make Bad Internet Simulation Adjustable on the Fly e512cce
  • Added: Experiment for measuring jitter in jitter buffer. 7592027
  • Added: Adaptive Jitter Buffer 7b52367
  • Added: Low Latency \"Adaptive\" Jitter Buffer 0539d1b
  • Added: Code that would allow for changing buffers in the future. 09ce4e0
  • Added: Fast Increment Adaptive Buffer c641028
  • Added: Hybrid Jitter Buffer b24e6e9
  • Added: Jitter Buffer Options to Player Settings dbf4f27
  • Added: Tooltips to the various buffer settings. 816e8b7
  • Added: Additional notes to \"Installation\". 539f4cc
  • Added: Updated DearImguiSharp & Added First Time Welcome Screen f9bed60
  • Added: Disconnect Reasons for Clients 57023a0
  • Feature: Automatic Crash Dump Creation e2cf282
  • Added: Clone method for BitPackedArrays efeed89
  • Added: Small amounts of error handling throughout Netplay code. 7557505
  • Added: Logs can now log separately to UI and Console ba30ac0
  • Feature: Notify user on injection of incompatible DLL. 5522c04
  • Feature: Try Blocking DLL injection for DLLs that cause issues. 42a1f2d
  • Feature: Lie about successful DLL injection for blocked DLLs. 9888927
"},{"location":"Changelogs/0.4.0/0.4.0/#removed","title":"Removed","text":"
  • Removed: Dead code from unused global config file. 75c16d5
"},{"location":"Changelogs/0.5.0/0.5.0/","title":"Changelog","text":"

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

This document lists all changes

"},{"location":"Changelogs/0.5.0/0.5.0/#release-description-050","title":"Release Description (0.5.0)","text":"

This is a beta release. It's huge, probably the biggest update since initial test builds but a beta version nonetheless.

Some of the features of this release are not fully tested; as I am unfortunately stressed, lacking in time and with real life things to sort out.

I'm willing to make some time to fix minor bugs but don't expect major development soon.

"},{"location":"Changelogs/0.5.0/0.5.0/#early-access-notice","title":"Early Access Notice","text":"

Please note that this project is not yet ready for public consumption. Netplay still has flaws. Very minor issues, but flaws nonetheless. I do not yet consider this project to be of production quality.

Please report any issues (especially crashes) using the guidelines provided in Reporting Issues.

Do not ask for Tech Support (e.g. \"How do I use this mod\").

"},{"location":"Changelogs/0.5.0/0.5.0/#features","title":"Features","text":""},{"location":"Changelogs/0.5.0/0.5.0/#graphics-improvements","title":"Graphics Improvements","text":"

Tweakbox 0.5.0 comes with many improvements with regards to how graphics and rendering are handled within the game.

To name a few changes:

  • You can now change resolution in real time.
  • You can now go to full-screen without restarting the game.
  • The game can now instantly be minimized and maximized from/to full-screen.
  • The graphics menu has been simplified and made easier to use.
  • The game window no longer resets itself to the corner after a User Account Control (UAC) prompt is shown.
  • The game now fully supports Direct3D9Ex; and all its benefits.

"},{"location":"Changelogs/0.5.0/0.5.0/#breaking-limits","title":"Breaking Limits","text":"

Version 0.5.0 extends many of the built-in game limits to better accomodate modern hardware and mods of the future.

Examples include:

  • The game can now load up to 768MB of assets at any given time. (from 50MB)*
  • The game can now execute 40960 tasks (objects, effects etc.) in total. (from 1024)
  • Stages can now have a maximum of 8192 collision objects. (from 600)

* This limit is further extended to 2GB is a patch known as 'Large Address Aware' is applied to the game's exe file. In 0.5.0, this limit was set at startup. In 0.5.4+, this limit is configurable and accessible via Tweakbox Settings -> Startup.

"},{"location":"Changelogs/0.5.0/0.5.0/#discord-rich-presence-support","title":"Discord Rich Presence Support","text":"

Tweakbox now ships with complete Discord information; including reporting both information about your current game status and your Netplay Session.

And of course, Discord invites are supported too:

"},{"location":"Changelogs/0.5.0/0.5.0/#server-browser","title":"Server Browser","text":"

You can now more easily find games hosted by other people by using the built-in server browser.

(This is just some test data)

The Server Browser is powered by a home made, in house built web server which was made specifically for Riders.Tweakbox. There will be more features in the future such as Ranked Play, Elo-like Match Making Rating and Statistics Tracking. Those are already implemented server side.

"},{"location":"Changelogs/0.5.0/0.5.0/#netplay-modifiers","title":"Netplay Modifiers","text":"

Support for various \"Modifiers\", or ways in which you can customize your own Netplay lobby have been added. For now, the features are limited but extended features will come in the future.

Turbulence everywhere... even in running mode.

"},{"location":"Changelogs/0.5.0/0.5.0/#music-injection","title":"Music Injection","text":"

Tweakbox now allows you to add custom ADX music to the game by creating external Reloaded-II mods. This allows you to provide alternative tracks to the game's default soundtrack.

When the game is about to play a music track, Tweakbox will randomly choose from one of your own music tracks.

Tweakbox allows you to replace music using two modes:

  • Per Stage
  • Per File

The example above shows per-stage music injection.

There is no limit to this feature. If you want 20GB worth of 4000 music tracks or 500 music tracks for a single stage, be my guest. For more details, refer to Tweakbox' documentation.

"},{"location":"Changelogs/0.5.0/0.5.0/#texture-injection","title":"Texture Injection","text":"

Tweakbox now allows you to replace textures in real-time by hijacking function calls to the Direct3D 9 API. Similar to how Dolphin Emulator handles it, you can inject textures without the need to modify game files.

Textures are supported in the following formats:

  • PNG
  • DDS
  • DDS.LZ4 (Custom)

Creation of texture packs is easy, with a step by step guide available in the documentation.

"},{"location":"Changelogs/0.5.0/0.5.0/#animated-texture-injection","title":"Animated Texture Injection","text":"

If you desire a bit more style, and wish to flex on the people emulating the GameCube version of the game, Tweakbox allows you to add basic animation to any texture:

For more details, refer to Tweakbox' documentation.

"},{"location":"Changelogs/0.5.0/0.5.0/#texture-dumping","title":"Texture Dumping","text":"

You can also dump textures from the game as they are loaded in real-time.

The texture dump tool comes with multiple modes; such as:

  • Only New mode which doesn't dump textures already dumped.
  • Deduplication mode, which puts textures with more than X duplicates in a Common folder.

Chances are that you wouldn't need to texture dump yourself though; as I've gone through the effort of dumping 3000+ textures on my own, with perfect dumps for every single stage.

With the improved texture dumping tools and some clever usage of them, the texture archive I made in the span of a day is more complete and accurate than what's been available for the GameCube version over the last 2 years.

Here's a link to my texture archive, it contains ~99% of all of the game's textures.

"},{"location":"Changelogs/0.5.0/0.5.0/#texture-cache","title":"Texture Cache","text":"

Starting with 0.5.5+ Tweakbox also maintains a built-in texture cache to work around slow loading times of PNG textures.

When a PNG is loaded for the first time and its mipmaps are generated, the texture will be converted to the optimal DDS.LZ4 custom format for future use. Subsequent uses of the texture will instead load from the cache which is many magnitudes faster. The conversion happens in the background and is multithreaded, so you should not notice a difference in first time load performance compared to previously loading a PNG (< 0.5.5).

Editing the original PNG image will cause the cached texture for that file to be invalidated, and a new DDS.LZ4 will be automatically created. Please note that the underlying cached DDS is uncompresed and eats memory for breakfast. Consider manually creating DDSes with DXT1 / DXT5 if you are working with e.g. Animated Textures. More info in the documentation.

"},{"location":"Changelogs/0.5.0/0.5.0/#object-layout-editor","title":"Object Layout Editor","text":"

Tweakbox now has a built-in, fully featured object layout editor; allowing you to:

  • Add objects
  • Remove objects
  • Transform objects (scale, rotate, move)
  • Change object properties.
  • Save & Load Object Layouts.
  • Export object layout to GameCube/PS2/Xbox/PC. ... and much more

Oh, by the way, these itemboxes (and some others) are unused in the final game, hehehe. If you would like additional features, such as racing online with custom layouts, let me know.

By the way... you can also now play Battle Mode in regular race stages hehehe...

"},{"location":"Changelogs/0.5.0/0.5.0/#end-of-race-synchronization-pause-menu","title":"End of Race Synchronization & Pause Menu","text":"

The players now have their own individual pause menus, allowing you to restart and exit the race (if host) or disconnect from the current lobby.

The pause menu after the results screen has also been replaced with a custom menu allowing the host to choose what to do next.

"},{"location":"Changelogs/0.5.0/0.5.0/#version-other-sanity-checks","title":"Version & Other Sanity Checks","text":"

In Netplay, Tweakbox will now make basic sanity checks such as:

  • Ensuring that all clients are running the same version of Tweakbox.
  • Ensuring all clients are using the same Tweakbox extensions/plugins.
  • Ensuring all clients are running the same game mode.

"},{"location":"Changelogs/0.5.0/0.5.0/#turbulence-editing","title":"Turbulence Editing","text":"

Tweakbox now allows you to edit turbulence physics and speeds. For every single variation of Turbulence used by the game.

Of course, as with all features listed above and below, it syncs with host over Netplay.

"},{"location":"Changelogs/0.5.0/0.5.0/#object-behaviour-changing","title":"Object Behaviour Changing","text":"

Tweakbox can now change the behaviour of some common objects in the game; for example:

  • Making dash panels give you additional speed to your current speed.
  • Making dash panels multiply your current speed.
  • Making dash panels give you a minimum amount of speed.

"},{"location":"Changelogs/0.5.0/0.5.0/#custom-deceleration-behaviour","title":"Custom Deceleration Behaviour","text":"

Tweakbox can now change how the game handles deceleration; overriding the game's built in exponential deceleration with alternative options.

One of the options is Linear deceleration; which makes you decelerate at a constant rate regardless of how far above top speed you are.

You can now spam your \"JCBCDPC\"dsdasdasfdsjdfuisdfhsid(s).

The numbers in this screenshot are actually what Sonic Riders DX and Sonic Riders TE 1.3 use.

"},{"location":"Changelogs/0.5.0/0.5.0/#boot-to-stage","title":"Boot to Stage","text":"

The mod now allows you to boot directly into a race (no menu navigation required) with a specific stage, character and gear combination. This is incredibly useful when testing mods.

"},{"location":"Changelogs/0.5.0/0.5.0/#return-to-track-select","title":"Return to Track Select","text":"

The mod now allows you to return directly into the track select menu after returning from a race. This works with all game modes, unlike the implementations in the current popular GameCube version mods.

"},{"location":"Changelogs/0.5.0/0.5.0/#miscellaneous","title":"Miscellaneous","text":"
  • Changed: Connecting to a game does not freeze the game window until a connection is established.
  • Renamed: Various Tweaks to Tweakbox Settings.
  • Updated: Readme & Documentation Pages for all new and existing features.
  • Updated: Libraries used behind the hood.
  • Minor Performance Optimisations

... and more

"},{"location":"Changelogs/0.5.0/0.5.0/#fixes","title":"Fixes","text":"
  • Fixed: Having the same submenu open in the gear editor for multiple gears at once causes you to only be able to interact with the first one.
  • Fixed: Memory Leak in Boot To Menu

... and more

"},{"location":"Changelogs/0.6.0/0.6.0/","title":"Changelog","text":"

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

This document lists all changes

"},{"location":"Changelogs/0.6.0/0.6.0/#release-description-060","title":"Release Description (0.6.0)","text":"

This is a beta release.

This release mostly consists of additional polish in existing features, albeit there are some new toys to play with (one of them is really impressive!).

Most of the features in this release have been tested, though there may be some odd things here and there around the edges; as I've still other things to do outside of Riders.

Please report bugs (no matter how minor); I'll do what I can to test them in a timely manner.

"},{"location":"Changelogs/0.6.0/0.6.0/#early-access-notice","title":"Early Access Notice","text":"

Please note that this project is not yet ready for public consumption. Netplay still has flaws. Very minor issues, but flaws nonetheless. I do not yet consider this project to be of production quality.

Please report any issues (especially crashes) using the guidelines provided in Reporting Issues.

Do not ask for Tech Support (e.g. \"How do I use this mod\").

"},{"location":"Changelogs/0.6.0/0.6.0/#features","title":"Features","text":""},{"location":"Changelogs/0.6.0/0.6.0/#custom-gear-support","title":"Custom Gear Support","text":"

The staple feature of this patch.

Tweakbox now supports the addition of fully custom gears; that is, having customized gears without having to replace the vanilla gears.

Here's some details:

  • Custom gears can be normally selected from Character Select; no magic buttons required.
  • You can have up to 214 custom gears (255 gears total).
  • Custom gears are Supported in Netplay (requires more testing).
  • Custom gears can have custom icons and names in Character Select.
  • Custom gears can be edited from within the built-in gear editor.
  • You can export any gear from Gear Editor into a brand new custom gear.

What's left? - Custom model support for custom gears. (Will implement on demand)

"},{"location":"Changelogs/0.6.0/0.6.0/#enhanced-texture-tools","title":"Enhanced Texture Tools","text":"

Some minor improvements have been made to existing texture injection tools used in Riders; for example the introduction of the texture viewer tool.

The texture viewer allows you to preview all currently loaded textures in real time; which makes the creation of texture packs or finding hashes for your custom textures more convenient.

Oh, by the way, this is the debug menu font! It's not there in the console releases <3.

It's also now possible reload textures in real time; allowing for changes to be seen without having to re-load the menu/stage; as well as see a list of all texture redirections that have been made. Useful stuff!

"},{"location":"Changelogs/0.6.0/0.6.0/#widget-support","title":"Widget Support","text":"

Tweakbox now has the ability to display various widgets on the screen.

Widgets can be pinned to any edge or corner of the screen and display information such as, FPS, Frame Time, CPU and Memory Usage to the screen.

The user can add or remove as many widgets as they like.

"},{"location":"Changelogs/0.6.0/0.6.0/#cleaned-up-settings-menu","title":"Cleaned Up Settings Menu","text":"

The layout of the settings menu has been cleaned up for better organization and accessibility. Related settings are now grouped together under expandable trees.

"},{"location":"Changelogs/0.6.0/0.6.0/#forced-netplay-settings","title":"Forced Netplay Settings","text":"

Version 0.6.0 adds a feature which forces certain settings to be enabled while in Netplay mode:

  • Enable return to Stage Select from Race/Survival/Tag
  • Enable driving backwards.
  • Enable FPS cap.

These features cannot be toggled while participating in Netplay; and are enabled to ensure consistency between all players.

"},{"location":"Changelogs/0.6.0/0.6.0/#chatbox-in-netplay","title":"Chatbox In Netplay","text":"

Come across a random player in Netplay? Fear no more! You can talk now.

*You even get notified if your Netplay window is minimized, win-win!.

"},{"location":"Changelogs/0.6.0/0.6.0/#enhanced-input-blocking","title":"Enhanced Input Blocking","text":"

A few small changes here: - You can customize the hotkey used to toggle passing input to the game. - Blocking input passed to the game now works regardless of mod load order when used with Controller Hook. - You can now make Tweakbox not pass inputs to game if any of its Windows are activated/being used.

"},{"location":"Changelogs/0.6.0/0.6.0/#improved-logging-efficiency","title":"Improved Logging Efficiency","text":"

Starting with version 0.6.0, Tweakbox uses an upcoming C# 10 feature called Improved Interpolated Strings which allows for more efficient logging.

Notably, if the log level/category for a specific message is not enabled, the string will not even be constructed at all; saving both time and unnecessary memory allocations without the need of writing repetive, redundant ugly checks on every log operation.

"},{"location":"Changelogs/0.6.0/0.6.0/#heap-allocation-viewer","title":"Heap Allocation Viewer","text":"

Starting with version 0.6.0, there's a cool little utility for tracking allocations made to the game's native heap.

This is a result of my study into how the game handles memory allocations.

Sometimes it doesn't seem to work perfectly yet for the Front side (if there's an issue, you'll experience game lag); as the front side of the heap wasn't really designed to be walked through, and game doesn't clean up properly sometimes. Most of the time however it works perfectly fine.

The back side works perfectly without issue.

"},{"location":"Changelogs/0.6.0/0.6.0/#adding-game-modifiers","title":"Adding: \"Game Modifiers\"","text":"

The \"Race Settings\" in Netplay Menu has now been moved to the Tweakbox Settings menu and rebranded as Game Modifiers.

These settings can now be applied to any race; not just netplay races.

In addition, a number of new modifiers have been added, including: - Disable Attacks for First X Milliseconds in Race. - No Screenpeeking (Netplay) - Custom Ring Loss on Death - Custom Ring Loss on Hit - No Turbulence - Slipstream

"},{"location":"Changelogs/0.6.0/0.6.0/#improved-loading-times","title":"Improved Loading Times","text":"

Starting with version 0.6.0, race loading times have been improved by up to 60%. Previously loading an 8 player race has taken around 2.5 seconds, now it takes 1.5 seconds.

"},{"location":"Changelogs/0.6.0/0.6.0/#improved-startup-times","title":"Improved Startup Times","text":"

Tweakbox now obsoletes a third party file caching mechanism from CRI Middleware originally used in Riders. This improves the initial cold boot startup time by around 10 seconds.

Note: \"Cold Booting\" refers to running the game after a PC restart or after some time has passed since last launch.

"},{"location":"Changelogs/0.6.0/0.6.0/#animated-texture-improvements","title":"Animated Texture Improvements","text":"

There's a collection of minor improvements related to animated textures:

  • Texture Cache: Animated textures are now automatically packed into a single archive to improve performance.

The archive consists of a list of raw DDS files compressed using lz4. This significantly improves load times when many frames are used.

  • Animated textures will now load in the background without stalling the game startup process.

The game will now use the first frame of the animated texture until loading of the remaining frames is ready. This prevents stutters on loading animated textures outside of load screens (e.g. Character Select).

  • Tweakbox will now warn when high frame count animated textures are using an unoptimal format.
"},{"location":"Changelogs/0.6.0/0.6.0/#layout-editor-improvements","title":"Layout Editor Improvements","text":"

The in-mod layout editor has received some minor improvements:

  • Safe Mode: Prevents updating object data in real time to ensure moving some objects (e.g. Rings) does not lead to crashes.

  • Autosave: The layout editor will now create an automatic save of the at regular time intervals. Useful in case you encounter a crash.

"},{"location":"Changelogs/0.6.0/0.6.0/#in-game-language-change","title":"In-Game Language Change","text":"

The language of both the game's text and voice can now be changed on the fly. Some changes (e.g. menu voices) are applied in real time, however others (e.g. localized menu assets) only apply after the next loading screen.

"},{"location":"Changelogs/0.6.0/0.6.0/#improved-tweakbox-startup-times","title":"Improved Tweakbox Startup Times","text":"

Startup time of Tweakbox itself has been improved in verison 0.6.0, by approximately 75%. Startup now takes 0.7 seconds, instead of 1.2 seconds.

"},{"location":"Changelogs/0.6.0/0.6.0/#missing-model-fallback","title":"Missing Model Fallback","text":"

When a model for a specific gear is missing (e.g. Sonic + Riders DX Advantage F); Tweakbox will now default to loading the default gear model for that gear type.

i.e. For boards it will load Default Gear, for skates it will load Darkness and for bikes it will load E-Rider.

This should prevent Tweakbox from crashing when from gear data from the GameCube mods are imported to Tweakbox. (Since those have custom model archives.)

"},{"location":"Changelogs/0.6.0/0.6.0/#feature-auto-decompress-game-data","title":"Feature: Auto Decompress Game Data","text":"

Tweakbox will now automatically decompress all game files on boot if it detects that they have not been previously decompressed.

"},{"location":"Changelogs/0.6.0/0.6.0/#miscellaneous","title":"Miscellaneous","text":"
  • Added: About Screen
  • Added: Toggle FPS Cap.
  • C#10 Features (Logging Improvements, File Scoped Namespaces)
  • Fixed: Workaround for CPU Usage monitoring not working for some users.
  • Fixed: Bad link in GitHub repository for documentation.
  • Fixed: Softlock in results screen on Netplay if host quits before client opens screen.
  • Fixed: Bug causing the last frame of an animated texture to be skipped.
  • Fixed: Tweakbox crashes under DXVK. (Might work on Linux now too)
  • Fixed: Tweakbox no longer crashes on failing to connect to NAT Punching Server.
  • Added: Tweakbox will now report unhandled errors/exceptions in the log.
  • Added: An option to disable particles in case of performance issues.
  • Added: Recommendation to use DXVK in the Graphics tab.
  • Changed: Do not fast forward if game resets frame counter (e.g. after load screens).
  • Improved: Texture decompression performance (by a tiny amount).
  • Changed: Made frame pacing more aggressive (slightly increased CPU usage for better pacing).
  • Changed: Made process high priority for frame pacing reasons.
"},{"location":"Preview/preview/","title":"About Preview Features","text":"

Preview features refer to currently \"work-in-progress\" features.

These features are generally available in the current release but are not finalized and/or may have potential slight changes in the future.

"},{"location":"Preview/tweakbox-api/","title":"Tweakbox API","text":"

Starting with version 0.7.0, Tweakbox offers a built-in API which allows you to control Tweakbox functionality as well as perform certain other operations which affect the state of the game.

"},{"location":"Preview/tweakbox-api/#getting-started","title":"Getting Started","text":"

Setup usually takes around 2 minutes if you know what you're doing. If you're new to programming however, it might take you a while, be patient!

"},{"location":"Preview/tweakbox-api/#create-a-reloaded-ii-mod","title":"Create a Reloaded-II Mod.","text":"

Refer to the Reloaded-II wiki (\"Building Mods\") for guidance.

"},{"location":"Preview/tweakbox-api/#clone-this-repository","title":"Clone this repository.","text":"
git clone --recursive https://github.com/Sewer56/Riders.Tweakbox.git\n

or add as git submodule

git submodule add https://github.com/Sewer56/Riders.Tweakbox.git\ngit submodule update --init --recursive\n
"},{"location":"Preview/tweakbox-api/#add-riderstweakboxinterfaces-to-your-project","title":"Add Riders.Tweakbox.Interfaces to your project.","text":"

First add it to your solution by right clicking it.

and find Riders.Tweakbox.Interfaces.csproj

Then, add it as a project dependency to your Reloaded-II mod.

"},{"location":"Preview/tweakbox-api/#add-riderstweakbox-as-a-reloaded-ii-dependency","title":"Add Riders.Tweakbox as a Reloaded II dependency.","text":"

Edit your project's ModConfig.json to include Riders.Tweakbox as part of the ModDependencies.

"},{"location":"Preview/tweakbox-api/#consume-the-tweakbox-api","title":"Consume the Tweakbox API","text":"

In your Start function of the mod, grab an interface to the R-II.

// Get the API Controller\n_modLoader.GetController<ITweakboxApi>().TryGetTarget(out var apiAccessor);\n\n// Register to the tweakbox API\nvar api = apiAccessor.Register($\"{config.ModId}.{config.ModVersion}\");\n\n// Use the API\nvar gearApi = api.GetCustomGearApi();\ngearApi.RemoveVanillaGears();\n
"},{"location":"Preview/tweakbox-api/#more-information","title":"More Information","text":"

Reloaded-II Documentation on Controllers

"},{"location":"Preview/tweakbox-api/#example-usage","title":"Example Usage","text":"

For more examples, consider looking at the example Riders.Tweakbox.Gearpack and Riders.Tweakbox.CharacterPack.DX projects contained in this repository.

"},{"location":"Preview/tweakbox-api/#get-updated-pointers","title":"Get Updated Pointers","text":"

Tweakbox rewrites some game code to make features such as custom gears possible. Therefore, some fields in libraries such as Sewer56.SonicRiders will need to be updated.

To obtain the updated pointers, use the GetPointers method.

// Update Gear Data Pointer\nvar pointers = modImpl.GetPointers();\nSewer56.SonicRiders.API.Player.Gears = new FixedArrayPtr<ExtremeGear>((ulong)pointers.Gears.Address, pointers.Gears.NumItems);\n
"},{"location":"Preview/tweakbox-api/#add-a-custom-gear-to-the-game","title":"Add a Custom Gear to the Game","text":"
// ICustomGearApi obtained via api.GetCustomGearApi();\npublic class BlueStarIIDX : CustomGearBase, IExtremeGear\n{\nprivate BoostProperties _boostProperties = new BoostProperties()\n{\nAddedBoostChainMultiplier = 0.15f,\nAddedBoostDurationLv3 = 30\n};\n\n/// <summary>\n/// Initializes this custom gear.\n/// </summary>\npublic override void Initialize(string gearsFolder, ICustomGearApi gearApi)\n{\n// Import a custom gear exported from the built-in `Export Custom Gear`\n// function in the gear editor.\nvar data = gearApi.ImportFromFolder(Path.Combine(gearsFolder, \"BlueStarII DX\"));\n\n// Attach a class that overrides gear behaviours (via IExtremeGear)\ndata.Behaviour = this;\n\n// Add the custom gear to the game!\ngearApi.AddGear(data);\n}\n\n// IExtremeGear API Callback\npublic BoostProperties GetBoostProperties() => _boostProperties;\n}\n

If you need to get the location of your mod's folder...

// In your mod's `Start` method.\n_modLoader.GetDirectoryForModId(MyModId)\n
"},{"location":"Preview/tweakbox-api/#modify-character-behaviour-simple","title":"Modify Character Behaviour (Simple)","text":"
public class Sonic : LateBoosterCharacter, ICustomStats\n{\nprivate BoostProperties _boostProperties = new BoostProperties()\n{\nAddedBoostDurationLv2 = 60,\nAddedBoostDurationLv3 = 60,\n};\n\n/// <summary>\n/// Initializes this custom character.\n/// </summary>\npublic void Initialize(Interfaces.ICustomCharacterApi characterApi)\n{\nRequest = new ModifyCharacterRequest()\n{\nBehaviour = this, // Modifies the character behaviour.\nCharacterId = (int) Characters.Sonic, // Character Index. See Sewer56.SonicRiders.Structures.Enums.Characters\nCharacterName = \"Sonic DX\",\nStack = false                  // Does not combine with other mods.\n};\n\n// Modify your character!\ncharacterApi.AddCharacterBehaviour(Request);\n}\n\n// Overrides for ICustomCharacter interface.\npublic ApiCharacterParameters GetCharacterParameters() => new ApiCharacterParameters()\n{\nSpeedMultiplierOffset = 0f\n};\n\npublic BoostProperties GetBoostProperties() => _boostProperties;\n}\n

Usage: 

// Get API\nvar characterApi = api.GetCustomCharacterApi();\n\n// Add character\nvar sonic = new Sonic();\nsonic.Initialize(characterApi);\n

"},{"location":"Preview/tweakbox-api/#modify-character-behaviour-clean","title":"Modify Character Behaviour (Clean)","text":"

Here's an example of how you could implement character 'archetypes'/'classes' (categories) for a cleaner approach.

Base Character Class: 

public abstract class CustomCharacterBase : ICustomCharacter\n{\npublic ModifyCharacterRequest Request { get; private set; }\npublic abstract string Name { get; }\npublic abstract Characters Character { get; }\n\n/// <summary>\n/// Initializes this custom character.\n/// </summary>\npublic void Initialize(Interfaces.ICustomCharacterApi characterApi)\n{\nRequest = new ModifyCharacterRequest()\n{\nBehaviour = this,              // Modifies the character behaviour.\nCharacterId = (int) Character, // Character Index. See Sewer56.SonicRiders.Structures.Enums.Characters\nCharacterName = Name,\nStack = false                  // Does not combine with other mods.\n};\n\n// Modify your character!\ncharacterApi.AddCharacterBehaviour(Request);\n}\n}\n

Define the character class: 

// An implementation of Sonic Riders DX 1.0.0 Late Booster Character\npublic abstract class LateBoosterCharacter : CustomCharacterBase, ICustomCharacter\n{\n// These are all callbacks for the ICustomCharacter interface.\nprivate BoostProperties _boostProperties = new BoostProperties()\n{\nAddedBoostDurationLv2 = 60,\nAddedBoostDurationLv3 = 60,\n};\n\npublic ApiCharacterParameters GetCharacterParameters() => new ApiCharacterParameters()\n{\nSpeedMultiplierOffset = 0f\n};\n\npublic BoostProperties GetBoostProperties() => _boostProperties;\n}\n

Give the character that class (via inheritance): 

public class Sonic : LateBoosterCharacter, ICustomStats\n{\npublic override string Name { get; } = \"Sonic DX\";\npublic override Characters Character { get; } = Characters.Sonic;\n}\n

"}]} \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml new file mode 100644 index 00000000..4c5d86ea --- /dev/null +++ b/sitemap.xml @@ -0,0 +1,103 @@ + + + + http://sewer56.dev/Riders.Tweakbox/ + 2024-05-15 + daily + + + http://sewer56.dev/Riders.Tweakbox/animated-textures/ + 2024-05-15 + daily + + + http://sewer56.dev/Riders.Tweakbox/building/ + 2024-05-15 + daily + + + http://sewer56.dev/Riders.Tweakbox/custom-gears/ + 2024-05-15 + daily + + + http://sewer56.dev/Riders.Tweakbox/custom-music/ + 2024-05-15 + daily + + + http://sewer56.dev/Riders.Tweakbox/features/ + 2024-05-15 + daily + + + http://sewer56.dev/Riders.Tweakbox/installation/ + 2024-05-15 + daily + + + http://sewer56.dev/Riders.Tweakbox/optimizing-textures/ + 2024-05-15 + daily + + + http://sewer56.dev/Riders.Tweakbox/reporting-issues/ + 2024-05-15 + daily + + + http://sewer56.dev/Riders.Tweakbox/textures/ + 2024-05-15 + daily + + + http://sewer56.dev/Riders.Tweakbox/BookOfTheTweakbox/ + 2024-05-15 + daily + + + http://sewer56.dev/Riders.Tweakbox/BookOfTheTweakbox/heap/ + 2024-05-15 + daily + + + http://sewer56.dev/Riders.Tweakbox/BookOfTheTweakbox/introduction/ + 2024-05-15 + daily + + + http://sewer56.dev/Riders.Tweakbox/BookOfTheTweakbox/overlay-helpers/ + 2024-05-15 + daily + + + http://sewer56.dev/Riders.Tweakbox/Changelogs/0.3.1/0.3.1/ + 2024-05-15 + daily + + + http://sewer56.dev/Riders.Tweakbox/Changelogs/0.4.0/0.4.0/ + 2024-05-15 + daily + + + http://sewer56.dev/Riders.Tweakbox/Changelogs/0.5.0/0.5.0/ + 2024-05-15 + daily + + + http://sewer56.dev/Riders.Tweakbox/Changelogs/0.6.0/0.6.0/ + 2024-05-15 + daily + + + http://sewer56.dev/Riders.Tweakbox/Preview/preview/ + 2024-05-15 + daily + + + http://sewer56.dev/Riders.Tweakbox/Preview/tweakbox-api/ + 2024-05-15 + daily + + \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz new file mode 100644 index 00000000..97202e4e Binary files /dev/null and b/sitemap.xml.gz differ diff --git a/textures/index.html b/textures/index.html new file mode 100644 index 00000000..8e2a0cb2 --- /dev/null +++ b/textures/index.html @@ -0,0 +1,922 @@ + + + + + + + + + + + + + + + + + + + + + + + + Textures - Riders.Tweakbox Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Adding Textures

+

Riders.Tweakbox allows you to replace textures in real-time by hijacking function calls to the Direct3D 9 API.

+

Creating a Texture Pack

+

You can add/replace textures by creating Reloaded II mods.

+

This is a short summary of how to create a mod; for a more in-depth guide on creating mods, please refer to the Reloaded-II documentation.

+

1. Make a new Mod

+

Screenshot

+

Screenshot

+

2. Enable it for Sonic Riders

+

Screenshot

+

Screenshot

+

And go to your mod directory.

+

3. Create the Texture Directory

+

Inside mod directory, create a folder called Tweakbox and inside it, a folder called Textures.

+

Screenshot

+

Screenshot

+

4. Add the Textures

+

Add textures in one of the supported formats.

+

Screenshot

+

Tweakbox detects newly added textures in real time; however cannot force Reload them. In other words, if you add a stage texture you will have to exit and re-enter the stage before the new texture takes effect.

+

Where do I get the Textures?

+

The easiest way to get a hold of the stock textures is to use a known dumped texture set, such as the Community Sonic Riders Texture Library. +(Has ~99% of the textures, neatly categorized).

+

Alternatively, you can dump them yourself from inside Tweakbox, if you visit the DirectX Texture Injection menu from Tweakbox.

+

Screenshot

+

Supported Formats

+
    +
  • PNG
    • +
  • DDS
    • +
  • DDS.LZ4
    • +
+

In the case of DDS, there is no restriction on internal format; as long as DirectX supports it.

+

In the case of DDS.LZ4; it is a custom variant of DDS compressed with the LZ4 compression algorithm exported by my texture optimisation tool.

+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file