README-CN.md

English

OsuRTDataProvider是什么？

OsuRTDataProvider是一个OsuSync插件,可以实时读取osu!数据.
它支持OSU!和OSU!Tourney。

OsuRTDataProvider能实时的从OSU!中获取以下内容(只支持正式版):

• BeatmapID
• 游戏状态
• Accuracy
• 生命值
• 当前连击
• 300数量
• 100数量
• 50数量
• Katu数量
• Geki数量
• Miss数量
• Mods
• 播放时间
• 分数
• 游戏模式

不同的OSU!客户端版本所需要的ORTDP插件版本也可能不同.

怎么使用(对于普通用户)

1. 下载 OsuSync。
2. 下载 OsuRTDataProvider。
3. 复制OsuRTDataProvider 到 {OsuSync Path}/Plugins 目录下。
4. 运行 OsuSync。
5. 安装其他依赖于此插件的插件，比如实时pp显示插件.
6. Enjoy!

Config.ini

[OsuRTDataProvider.SettingIni]

Setting Name	Default Value	Description
ListenInterval	100	监听数据的间隔(单位毫秒)。PS:如果太小可能会卡
EnableTourneyMode	False	启用Tourney模式?(实验性)
TeamSize	1	Tourney client的队伍大小
ForceOsuSongsDirectory		强制在指定路径中搜索Beatmap文件夹
GameMode	Auto	如果ModeFinder初始化失败. 请手动设置游戏模式(osu,mania,ctb,taiko,auto)
DisableProcessNotFoundInformation	False	隐藏"没有发现osu.exe进程"的消息提示
EnableModsChangedAtListening	False	尝试在非Play状态监听Mods变化

API

OsuRTDataProviderPlugin class

Property

        public OsuListenerManager ListenerManager;

        //如果config.ini中的EnableTourneyMode = false,该属性为null.
        public OsuListenerManager[] TourneyListenerManagers;
        public int TourneyListenerManagersCount;

如何编译

1. clone此repo
2. cloneSync
3. 引用sync项目进ortdp项目
4. 编译.

OsuListenerManager class

Event

        public delegate void OnBeatmapChangedEvt(Beatmap map);
        public delegate void OnHealthPointChangedEvt(double hp);
        public delegate void OnAccuracyChangedEvt(double acc);
        public delegate void OnComboChangedEvt(int combo);
        public delegate void OnModsChangedEvt(ModsInfo mods);
        public delegate void OnPlayingTimeChangedEvt(int ms);
        public delegate void OnHitCountChangedEvt(int hit);
        public delegate void OnStatusChangedEvt(OsuStatus last_status, OsuStatus status);
        public delegate void OnErrorStatisticsChangedEvt(ErrorStatisticsResult result);
        public delegate void OnPlayerChangedEvt(string player);
        public delegate void OnHitEventsChangedEvt(PlayType playType, List<HitEvent> hitEvents);

        /// <summary>
        /// Playing和Linsten时可用.
        /// 如果Beatmap太老, map.ID = -1.
        /// </summary>
        public event OnBeatmapChangedEvt OnBeatmapChanged;

        /// <summary>
        /// Playing时可用.
        /// </summary>
        public event OnHealthPointChangedEvt OnHealthPointChanged;

        /// <summary>
        /// Playing时可用.
        /// </summary>
        public event OnAccuracyChangedEvt OnAccuracyChanged;

        /// <summary>
        /// Playing时可用.
        /// </summary>
        public event OnComboChangedEvt OnComboChanged;

        /// <summary>
        /// Playing时可用.
        /// Playing->Listen时 , mods = ModsInfo.Empty
        /// </summary>
        public event OnModsChangedEvt OnModsChanged;

        /// <summary>
        /// Playing和Linsten时可用.
        /// </summary>
        public event OnPlayingTimeChangedEvt OnPlayingTimeChanged;

        /// <summary>
        /// Playing时可用.
        /// </summary>
        public event OnHitCountChangedEvt On300HitChanged;

        /// <summary>
        /// Playing时可用.
        /// </summary>
        public event OnHitCountChangedEvt On100HitChanged;

        /// <summary>
        /// Playing时可用.
        /// </summary>
        public event OnHitCountChangedEvt On50HitChanged;

        /// <summary>
        /// Playing时可用.
        /// </summary>
        public event OnHitCountChangedEvt OnMissHitChanged;

        /// <summary>
        /// 任何时候可用.
        /// </summary>
        public event OnStatusChangedEvt OnStatusChanged;

        /// <summary>
        /// Playing可用
        /// 错误分析(UnstableRate and Error Hit).
        /// </summary>
        public event OnErrorStatisticsChangedEvt OnErrorStatisticsChanged;

        /// <summary>
        /// Playing可用
        /// 玩家名改变(发生在观看replay时)
        /// </summary>
        public event OnPlayerChangedEvt OnPlayerChanged;

        /// <summary>
        /// Playing可用
        /// 打击事件改变 (https://osu.ppy.sh/help/wiki/osu!_File_Formats/Osr_(file_format))
        /// </summary>
        public event OnHitEventsChangedEvt OnHitEventsChanged;

OsuStatus enum

        public enum OsuStatus
        {
            NoFoundProcess,
            Unkonwn,
            Listening,
            Playing,
            Editing,
            Rank
        }