查看“BallanceMMOClient”的源代码

{{Languages|zh|BallanceMMOClient/zh}}

{{Appbox
|name=BallanceMMOClient
|screenshot=bmmo.png
|screenshotDesc=The multiplay game window implemented by BallanceMMOClient.
|author=Swung0x48
|suit=Ballance
|link=[https://github.com/Swung0x48/BallanceMMO GitHub repository]
|dependency=The Latest [[BML2]]
|status=active
|date=19 Apr, 2021 ({{AgeYM|2021|4|19}} ago)
|latest=None
|license=
* v1：Apache License
* v2 and v3：Unknow License
}}

{{Cquote|yyc12345|This is a brand-new, groundbreaking plugin. This plugin revives Ballance community.}}

'''BallanceMMOClient'''(abbr, BMMO) is a groundbreaking [[BML2]] plugin developed by Swung0x48. It allows a player to play Ballance with other players with low latency via a deployed central BMMO server. The ball of other players will be rendered as a shadow ball(half-transparent ball) in the game viewport, and a player name label will also be attached to it. Moreover, real-time chat, detect cheat status(cheat mode on or off) are also available. BMMO is enough stable to be used for some tournaments after a few iterations.

== Download ==

* Join Multi-play QQ Group, and download from QQ Group Files.
* Join Ballance Discord Server.
* Download from the Release page of GitHub repository.(Not suggested because publish is not in time.)
* Download project and build by yourself.(Not suggested because building this plugin is harder than imagine.)

Please read the requirement of server which you want to join and download correct version. '''In most instances, downloading the latest version is the best decision.''' Server will reject the connection of obsolete client after some updates.

== Client Usage ==

{{ambox|type=content
|issue='''Encoding Warning'''
|info=Due to the limitation of Ballance. Any non-ASCII character is not allowed in BallanceMMOClient, from server URL, username to message content. It means that you should not use any Chinese character, Katakana, Hiragana, Korea character, Cyrillic, Greek character and etc.}}

=== Install Client ===

Please ensure that you have installed the latest BML2. Then you need to put your downloaded zip file in {{code|ModLoader/Mods}} '''directly without decompression'''. If you have '''installed obsolete BMMO''' previously, '''please remove it instantly.''' Your installation is finished if you can see BallanceMMOClient entry in BML Mods menu.

=== Configurate Server and Username ===

After installation, there are 2 way to configure your server URL and username. If you are looking for some available servers, please check out the next chapter to get an available server.<br />
First, you can enter BallanceMMOClient entry in BML Mods menu, then use Remote and Player submenu to set server URL and username. If your server URL or username contain complex words, you can use the next method.<br />
Method 2, Close game, navigate to {{code|ModLoader/Config/BallanceMMOClient.cfg}} and open it. Now, you can change server URL and username directly.

=== Basic Operations ===

The following operations are frequently to be used. Please ensure that you have known them well before starting multi-play.

* {{code|/mmo c}} or {{code|/mmo connect}}: Connect to server.
* {{code|/mmo d}} or {{code|/mmo disconnect}}: Disconnect from server
* {{code|/mmo l}} or {{code|/mmo list}}: List all online player clients.
* {{code|/mmo s <message>}} or {{code|/mmo say <message>}}: Send message(since 3.1.5-beta5)<ref>Before 3.1.5-beta5, due to the implementation of BMMO, {{code|Space}} is not supported in message content. You need to use other symbol to split words if you need. For example, you can type {{code|wait/a/minute}} or {{code|wait-a-minute}} instead of {{code|wait a minute}}.</ref>.

After anti-cheat update(v3.1), BMMO supports more anti-cheat features.

* {{code|/mmo cheat [on or off]}}: Switch cheat mode '''for all online players'''. This command will force change each player's cheat mode without any notification. Please do not abuse this command.
* A global message will be showed in chat dialog if any player change its cheat mode. The name of cheating player will automatically be attached with {{code|[C]}}.

=== Advanced Operations ===

* F3 for switching the display of debug information. Debug information mainly show network transfer status.
* You can use keyboard to send contest preparation message quickly. It's mechanism is running {{code|/mmo say <message>}} with preset string.
** {{code|Left Ctrl + 3}}: Send {{code|3}}
** {{code|Left Ctrl + 2}}: Send {{code|3}}
** {{code|Left Ctrl + 1}}: Send {{code|1}}
** {{code|Left Ctrl + 0}}: Send {{code|GO!}}

== Available Servers ==

Considering the security of server, you should join corresponding Ballance community according to your multi-play requirements. Then, you can get an available server. Also, you can create a personal BMMO server and play with it. Its method will be introduced in the following chapter.<br />
If you want to play with Chinese Ballance players, you should join Multi-play QQ Group and get server URL within it.<br />
Or, there is a big latency when you are connecting to Chinese BMMO server, or you want to play Ballance with over world Ballance players, you can join Ballance [[Discord]] server and get server URL from {{code|#multiplay}} channel.

== History ==

There are 3 huge changes in BMMO history, according to its GitHub commit history.<br />
V1 is based on TCP connection. Some basic message structures are established in this version and the plugin has been tested in production environment a few times. But the biggest problem is the quality of connection will significantly drop if the client is in a bad network environments. This is unacceptable in some cases.<br />
V2 use [https://github.com/Swung0x48/SimpleRealTimeNetworking a custom transfer protocol developed by Swung0x48]. But quickly, this version was no longer maintained.<br />
V3 is current version and be used by every Ballance multi-play players. It still in active development. This version use [https://github.com/ValveSoftware/GameNetworkingSockets Valve's GameNetworkingSockets] as its network library. This version of BMMO is widely praised, relying on the low latency features provided by GameNetworkingSockets. The quality of connection is in acceptable range, even if you are living the opposite of the Pacific Ocean.

== Deploy a Personal Server ==

In general, creating an BMMO server on a Linux server is easier than a Windows server. You can check out the GitHub repository's README file of this plugin to know how to deploy a BMMO server.

== References ==

<references />