查看“BallanceMMOClient”的源代码

{{Languages|zh|BallanceMMOClient/zh}}

{{Seealso|Main Page: [[Ballance Massive Multiplayer Online]]}}

{{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.<br />
However, in some of commands introduced in following content, this restriction will be removed. Please pay an attention to it.}}

== Download ==

* Download from [https://dl.bmmo.ml/ Publish Website]. Click "Download Standalone Package" to download. (Suggested)
* Join Multi-play QQ Group, and download from QQ Group Files.
* Join Ballance Discord Server.
* Download from the Release page of [https://github.com/Swung0x48/BallanceMMO 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 Settings ==

After installation, there are 2 way to configure your BallanceMMOClient settings<br />
First, you can enter BallanceMMOClient entry in BML Mods menu, then use its submenu to set the settings what you want set. If your settings is too long or contain complex words, you can use the next method instead.<br />
Method 2, Close game, navigate to {{code|ModLoader/Config/BallanceMMOClient.cfg}} and open it. Now, you can change all settings directly.

=== Core Settings ===

Server URL and player name are 2 essential settings for this plugin. You should fill them before any multiplayer game.

Player name setting locate in Player - Playername. Please choose a clear name. By the way, BMMO server will check your given name and remove all invalid characters, so the name adopted by the server may not exactly same with your set name.

Server URL setting locate in Remote - ServerAddress. You must set your server URL correctly, and stay in the same server with your friends/competitors, otherwise you can not do a normal multiplayer game. If the port of this field is omitted, the plugin will connect to the default port {{code|26676}}.

=== Other Settings ===

Spectator Mode setting locate in Remote - SpectatorMode. If enable it, you will enter spectator mode when joining multiplay server. The player in spectator mode will not be account into level ranking. And your ball position also will not be shared. Spectator mode are frequently used by tournament commentary and referee. The name of online players in spectator mode will have a extra star ({{code|*}}) prefix to indicate them.

Extrapolation setting locate in Gameplay - Extrapolation. If enable it, plugin will use extrapolation algorithm to smooth the movement of shadow ball to get better visual effect. If you disable it, the path of each players ball will be dispersed ("Flash"). The default of this setting is enable and we highly recommend all players enable it.

Player list color setting locate in Gameplay - PlayerListColor. This setting allow you customize the color of player list panel which displayed at the right-bottom corner of game window. Usually no need to modify this.

== Client Usage ==

=== Commands ===

There are the syntax of following commands introduction and some annotations.

* Use Space to split arguments. The argument without any modifier/bracket should be input directly.
* {{code|<u>n</u>a<u>m</u>e}} indicate the long name of this argument is {{code|name}}. the short name of this argument is {{code|nm}}. Input short name will call the same function.
* {{code|<nowiki><arg></nowiki>}} indicate this argument should be replaced with some string according to your requirement.
* {{code|<nowiki>[arg]</nowiki>}} indicate this argument is optional (use default value instead).
* {{code|<nowiki>arg1 | arg2</nowiki>}} Choose a argument between arg1 and arg2.
* You can use Tab to auto fill command name, player name and player ID, except {{code|/mmo kick}}. Just like some UNIX terminals.
* Command is case-insensitive. However, argument input by player is case-sensitive. Additionally, Tab Auto Fill rely on the function implemented by BML2, so it is also case-sensitive.

==== Server Status ====

* {{code|/mmo <u>c</u>onnect <nowiki>[address]</nowiki>}} – Connect your specified server. If address argument is omitted, use the server setting of this plugin instead.
* {{code|/mmo <u>d</u>isconnect}} – Leave current connected server.

==== Player Status ====

* {{code|/mmo <u>l</u>ist<nowiki>|</nowiki><u>l</u>ist-<u>i</u>d}} – Show a list containing all online player's name. if use {{code|list-id}} argument, a extra temporary internal player ID will be attached to its name.
* {{code|/mmo <u>g</u>et<u>m</u>ap}} – For all players, show which map player is playing and its corresponding sector. It is convenient for looking for players.
* {{code|/mmo <u>g</u>et<u>p</u>os}} – Show the position and ball type for all players.<ref name="single-player">For some reason about reducing computing and network resources, server will not send player's position and status data when the server only have a single player. So the shadow ball also can not move following player. Because of this, the position and ball type data is not correct when the server only have 1 player.</ref>
* {{code|/mmo <u>r</u>e<u>l</u>oad}} – Reload all players status in client. If player name label and its shadow ball are mismatched, this function may solve this issue.
* {{code|/mmo gettimestamp}} – Show all players extrapolation debug data.''This command is served for the developer of this mod.''

==== Player Interaction ====

* {{code|/mmo <u>s</u>ay <nowiki><text></nowiki>}} or {{code|/say <nowiki><text></nowiki>}} – Send a public message in server with a content of <text>.<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>.
* {{code|/mmo <u>w</u>hisper <nowiki><player name> <text></nowiki>}} or {{code|/mmo <u>w</u>hisper <nowiki>#<player ID> <text></nowiki>}} – Send a private message for your specified player. This message only can be seen by you and your specified player.
* {{code|/mmo announce <nowiki><text></nowiki>}} – Send a important public message in server. This message {{Color|'''support non-ASCII characters'''|red}} and will '''be shown at the center of game window for a while.'''
* {{code|/mmo bulletin <nowiki>[text]</nowiki>}} – Set server bulletin text. '''The bulletin text bar will constantly displayed at the top-center of game window.'''<ref>Bulletin text do not support line break. Please use a clear and short text for it. Additionally, bulletin will set to blank when all players disconnected from server.</ref>
* {{code|/mmo <u>a</u>nnounce<u>m</u>ap}} – Explicitly notify server which map you are playing and which section you are staying. (It is convenient fot notify other players)
* {{code|/mmo <u>t</u>ele<u>p</u>ort <nowiki><player name></nowiki>}} or {{code|/mmo <u>t</u>ele<u>p</u>ort <nowiki>#<player ID></nowiki>}} – Teleport to other player's position. Only works on Cheat Mode.<ref>Teleportation only can move you to other player's position. It can not switch your sector automatically and also can not restore element statues.This command is frequently used with {{code|/mmo getmap}}</ref><ref name="single-player" />
* {{code|/mmo kick <nowiki><player name> [reason]</nowiki>}} or {{code|/mmo kick <nowiki>#<player ID> [reason]</nowiki>}}: Kick the player from server with corresponding name (case-insensitive) or ID
* {{code|/mmo custommap <nowiki><Name|reset></nowiki>}}: Customize your map name which you are playing. This name will be reset when switching levels or sectors.

==== Tournament Status ====

* {{code|/mmo cheat <nowiki>on|off</nowiki>}} – Turn cheat mode on or off for all players online.
* {{code|/mmo countdown}} – Start the ready-set-go countdown.
* {{code|/mmo dnf}} – Forfeit the game (did-not-finish).
* {{code|/mmo rank reset}} – Run this before activating the countdown to reset all ranking (applies to a single race across multiple levels).
* {{code|/mmo <nowiki>ready|ready-cancel</nowiki>}} - Signify to other players that you are ready for the race or cancel the ready status.

==== Misc ====

* {{code|/mmo <nowiki>show|hide</nowiki>}} – Show / hide the console window for this mod. All status output from this mod will be available in the console, plus you can use commands of this mod in the console (without the {{code|/mmo}} prefix). Input and output in the console is no longer limited to standard ASCII characters.

=== Keyboard Shortcuts ===

==== Self Status ====

* {{code|Tab}}: Toggle name plates for other players.
* {{code|F3}}: Toggle debug information.
* {{code|F3 + A}}: Reload player status. Use this to readjust when name plates and shadow balls are offset.
* {{code|Ctrl + Tab}}: Show realtime status of players in the race, including current map and checkpoint. <ref>Hold Ctrl then press Tab. The order matters.</ref>
* {{code|Ctrl + <nowiki>`</nowiki>}}: Show shadow ball of yourself (after network latency). Useful for latency test.<ref>{{code|<nowiki>`</nowiki>}} key is to the left of {{code|1}} on a standard QWERTY keyboard and can be used to type tilde symbol ({{code|<nowiki>~</nowiki>}}) when combined with {{code|<nowiki>Shift</nowiki>}}</ref><ref name="single-player" />
* {{code|Ctrl + Shift + ↑}}: Reset camera. Useful when you accidentally set a nonstandard camera angle. Some rules force a player to forfeit the game if nonstandard camera angle is used.<ref>Please allow 1-2 seconds for the camera to readjust and do not move before it's done. You can do this while inside a transformer to avoid some time loss.</ref>

==== Tournament Status ====

* {{code|Ctrl + <nowiki>[3 or 2 or 1]</nowiki>}}: Start countdown.
* {{code|Ctrl + 0}}: Start the race. Resets the race timer for all players. Depending on settings of the server, the level may be restarted.
* {{code|Ctrl + 4}}: Notify the players to ready up.
* {{code|Ctrl + 5}}: Ask the players to confirm readiness.
* {{code|Ctrl + D}} (press twice consecutively: Forfeit the current level (did-not-finish).

== 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.

== References ==

<references />