repository·master·Indexed 42 days ago
https://github.com/yoooi0/multifunplayerA synchronization engine that links video playback with hardware device motion using scripts. It supports multiple concurrent outputs, a wide range of video players (including DeoVR, MPV, VLC, and Plex), and various output protocols such as buttplug.io, TCP, UDP, and websockets. The tool features automatic script loading via naming conventions for TCode v0.2 and v0.3, and is extendable via a C# plugin system.
The application supports various output methods to control devices:
Protocols & Interfaces:
Device Support:
MultiFunPlayer integrates with a wide variety of video players and script management systems:
Video Players:
Script Repositories:
Follow these steps to set up synchronization:
Once connected, you can load scripts manually (drag and drop onto an axis File text box or use Script->Load) or automatically via naming conventions.
Before running MultiFunPlayer, ensure you have the following prerequisites installed on your system:
MultiFunPlayer is a true portable app; no files are created or edited outside of the executable folder.
You can download the latest stable release or check the latest pre-release builds via the following links:
The themeConfig object controls the visual components of the site:
Navbar Configuration:
title: The text displayed in the navbar.logo: An object containing alt text and src path for the site logo.items: An array of navigation items. Use type: 'doc' to link to specific documentation pages via docId.Footer Configuration:
style: The visual style (e.g., 'dark').links: An array of link groups. Each group has a title and an array of items (each with label and href).copyright: The copyright string displayed in the footer.themeConfig: ({
navbar: {
title: 'MultiFunPlayer',
logo: {
alt: 'Logo',
src: 'img/logo.svg',
},
items: [
{
type: 'doc',
docId: 'intro',
position: 'left',
label: 'Documentation',
},
],
},
footer: {
style: 'dark',
links: [
{
title: 'Links',
items: [
{
label: 'GitHub',
href: 'https://github.com/Yoooi0/MultiFunPlayer',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Yoooi0.`,
},
});The docusaurus.config.js file defines the site metadata, presets, and theme configuration for the MultiFunPlayer documentation site. Key configuration areas include:
title, tagline, favicon, url, and baseUrl.organizationName and projectName (used for GitHub Pages integration).onBrokenLinks (set to 'throw') and onBrokenMarkdownLinks (set to 'warn').defaultLocale and available locales.'classic' preset with specific settings for docs (including sidebarPath and editUrl), blog (disabled), and theme (custom CSS path).navbar (with logo and navigation items), footer (with links and copyright), and prism (syntax highlighting themes).import {themes as prismThemes} from 'prism-react-renderer';
/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'MultiFunPlayer',
tagline: 'Flexible application to synchronize various devices with media playback',
favicon: 'img/favicon.ico',
url: 'https://yoooi0.github.io',
baseUrl: '/MultiFunPlayer/',
organizationName: 'Yoooi0',
projectName: 'MultiFunPlayer',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
trailingSlash: false,
i18n: {
defaultLocale: 'en',
locales: ['en'],
},
presets: [
[
'classic',
({
docs: {
sidebarPath: './sidebars.js',
editUrl: 'https://github.com/Yoooi0/MultiFunPlayer/tree/master/Docs/',
},
blog: false,
theme: {
customCss: './src/css/custom.css',
},
}),
],
],
themeConfig: ({
navbar: {
title: 'MultiFunPlayer',
logo: {
alt: 'Logo',
src: 'img/logo.svg',
},
items: [
{
type: 'doc',
docId: 'intro',
position: 'left',
label: 'Documentation',
},
],
},
footer: {
style: 'dark',
links: [
{
title: 'Links',
items: [
{
label: 'GitHub',
href: 'https://github.com/Yoooi0/MultiFunPlayer',
},
{
label: 'Patreon',
href: 'https://www.patreon.com/yoooi',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Yoooi0.`,
},
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
},
}),
};
export default config;Within the presets array, the docs object allows you to customize how documentation is handled.
sidebarPath: Path to the file defining the sidebar structure (e.g., ./sidebars.js).editUrl: The URL where users can go to edit the documentation directly in the source repository (e.g., https://github.com/Yoooi0/MultiFunPlayer/tree/master/Docs/).// Inside presets -> classic -> docs
docs: {
sidebarPath: './sidebars.js',
editUrl: 'https://github.com/Yoooi0/MultiFunPlayer/tree/master/Docs/',
}MultiFunPlayer can automatically load scripts based on the currently played video file name if they follow specific naming patterns. The scripts must be named <video name>.<suffix>.funscript.
| Axis | Description | Valid file name suffix |
|---|---|---|
| L0 | Up/Down | .funscript |
| L1 | Forward/Backward | .surge.funscript |
| L2 | Left/Right | .sway.funscript |
| R0 | Twist | .twist.funscript |
| R1 | Roll | .roll.funscript |
| R2 | Pitch | .pitch.funscript |
| Axis | Description | Valid file name suffix |
|---|---|---|
| V0 | Vibrate | .vib.funscript |
| V1 | Pump | .lube.funscript |
| L3 | Suction | .suck.funscript |
| Axis | Description | Valid file name suffix |
|---|---|---|
| V0 | Vibrate | .vib.funscript |
| A0 | Valve | .valve.funscript |
| A1 | Suction | .suck.funscript |
| A2 | Lube | .lube.funscript |
These file names are matched in all script libraries and in the currently playing video directory.