Skip to content
This repository was archived by the owner on May 6, 2023. It is now read-only.

README_EN.md

Latest commit

 

History

History
88 lines (56 loc) · 3.77 KB

README_EN.md

File metadata and controls

88 lines (56 loc) · 3.77 KB

ManiaRTRender

中文版

What is it?

ManiaRTRender is a visualization plugin of OsuSync, used to mark colorful judgements and hit positions in the music game osu!mania. It is similar to ManiaReplayMaster. Different from MRM, it's a real-time render tool. Open the tool and begin the game, online rendering will be done, no need to input a replay file anymore.

DEMO: https://www.bilibili.com/video/BV1vE411c73P

Screenshots

Installation

Auto Installation

  1. Install OsuSync.

  2. Open Sync.exe, enter the following commands.

plugins install ManiaRTRender
plugins update

Manual Installation

  1. Install OsuSync.

  2. Install OsuRTDataProvider. Download the latest version as prompted, and copy it to OsuSync.

  3. Download ManiaRTRender. After extracting it, copy it to OsuSync as well.

  4. Open Sync.exe.

Function Menu

Right click in the tool window will open a function menu, as follows.

  • Hide Window in Idle: If checked, The whole renderer window will be hidden when the game is idle, and will show again after game starts.
  • Top Most: If checked, the renderer will remain at the top of the screen.
  • Close: Close the renderer window. Note: this operation is not reversible. You will need to restart sync.exe to reopen the renderer window.

Configuration

ManiaRTRender supports modifying falling speed, background picture, rendering FPS and UI sizes. You can modify {OsuSync}/config.ini directly (under [ManiaRTRender.SettingIni]). Also, you can use ConfigGUI plugin to modify it by GUI.

Setting Name Default Value Description
Speed 25 falling speed (not recommended to be too fast)
BackgroundPicture picture path, showing when the game hasn't started yet (empty to show default background)
BackgroundPictureInPlaying picture path, showing when the game starts (empty to show black background)
FPS 0 rendering FPS (0 to enable VSync)
NoteHeight 40 height of notes
HitHeight 5 height of hit objects
NoteStrokeWidth 3 stroke width of notes
RateSmoothFactor 0.8 Game Rate change factor (range: 0 - 1, higher to make falling down speed more stable but harder to change)

Note: set BackgroundPicture to a pure color image, and set the transparent color to this color in live streaming softwares (e.g., OBS), then this renderer can hide in idle and show in playing automatically.

TourneyMode

Please refer to the introduction of Tourney Mode in OsuRTDataProvider. Just to modify relevant tourney settings items in OsuRTDataProvider.

Compiling

git clone git@github.com:Keytoyze/ManiaRTRender.git ManiaRTRender
git clone git@github.com:OsuSync/Sync.git Sync
git clone git@github.com:OsuSync/OsuRTDataProvider.git OsuRTDataProvider
cd ManiaRTRender

Using Visual Studio to open ManiaRTRender.sln.

LICENSE

GNU General Public License v3.0