18,700
edits
Zukai: Difference between revisions
adding bindable actions and settings
m (another reminder for something to fill in later) |
(adding bindable actions and settings) |
||
| Line 11: | Line 11: | ||
|align="right" |[[User:Iritscen|Iritscen]] | |align="right" |[[User:Iritscen|Iritscen]] | ||
|- | |- | ||
|align="center"|[[/Change log|Change log]] | |align="center"|[[/Change log|Change log]] / | ||
|align="left"|[http://bugs.oni2.net/query?component=Zukai&order=priority&report=11 Bug reporting] | |align="left"|[http://bugs.oni2.net/query?component=Zukai&order=priority&report=11 Bug reporting] | ||
|- | |- | ||
| Line 38: | Line 38: | ||
[[Image:Zukai-MP Menu.jpg|thumb|350px|right]] | [[Image:Zukai-MP Menu.jpg|thumb|350px|right]] | ||
:Note: Make sure that you have forwarded port 2680 to your computer in your router's settings. | :Note: Make sure that you have forwarded port 2680 to your computer in your router's settings. | ||
:Note: Until there is metaserver support (i.e., a matchmaking lobby), you will need to coordinate games using a third-party program like | :Note: Until there is metaserver support (i.e., a matchmaking lobby), you will need to coordinate games using a third-party program like an instant messenger or an IRC client (our IRC channel is #Oni at EUIrc.net). | ||
# Decide what level you are going to play. Obtain the IP address of the player that will be hosting. If you get tired of dealing with IP addresses, players can sign up for a [http://www.noip.com/ No-IP] domain and provide that URL to players instead, e.g. iritscen.ddns.net. | # Decide what level you are going to play. Obtain the IP address of the player that will be hosting. If you get tired of dealing with IP addresses, players can sign up for a [http://www.noip.com/ No-IP] domain and provide that URL to players instead, e.g. iritscen.ddns.net. | ||
# Launch Oni. Look for the Zukai icon on the Main Menu (pictured, right) to make sure that the plugin is active. | # Launch Oni. Look for the Zukai icon on the Main Menu (pictured, right) to make sure that the plugin is active. | ||
| Line 47: | Line 47: | ||
==Bindable actions== | ==Bindable actions== | ||
Coming soon. | In addition to the [[Customizing/Binding|standard actions]] that you have always been able to bind using '''key_config.txt''', here is a list of actions added by the Zukai plugin for use in multiplayer mode. | ||
===All players=== | |||
Both hosts and clients can use these actions: | |||
;mp_menu | |||
:This brings up the Multiplayer Menu when you are in-game, allowing you to host, join, or exit a game. | |||
;mp_score | |||
:Holding this key down displays the scoreboard, along with match time and player ping. | |||
;mp_chat | |||
:Coming soon! | |||
;mp_graph_toggle, mp_graph_cycle | |||
:To turn on, and cycle through, graphs that display information about the state of the multiplayer game. The network graph shows the size of incoming and outgoing traffic, and the timing graph shows how much time the multiplayer code is taking to execute in each frame. | |||
===Hosts only=== | |||
These actions may only be available during this early phase of Zukai's development. They allow the host to change network settings for all players during a match, in order to see how performance is affected. You probably will want to talk to me before using them, but here they are: | |||
;latency_toggle, latency_up, latency_down | |||
:To turn on and adjust simulated latency. This feature is intended for use in matches with negligible real latency, e.g., LAN/loopback games, to reproduce the feel of an Internet game. If used in an Internet game, this will add additional latency on top of whatever natural latency already exists. | |||
;jitter_toggle, jitter_up, jitter_down | |||
:Simulated jitter (variations in latency) is automatically turned on when simulated latency is turned on, but you can use these actions to turn it off (to get flat simulated latency) or to alter the amount of jitter. | |||
;pkt_rate_up, pkt_rate_down | |||
:You can send gameplay data more or less frequently using these keys. The rate is measured as a delay in ticks, so raising the rate leads to sending data less frequently. | |||
;state_rate_up, state_rate_down | |||
:State events are communications between the client and the host which determine a client's correct position. As above, higher numbers mean less frequent events. | |||
;pos_tol_up, pos_tol_down | |||
:Not currently used. The "position tolerance" is how many world units a client's position can differ between his avatar on the host and his avatar on his own machine before his position is corrected. Higher numbers will mean that games are permitted to go further out of sync. Lower numbers will cause more frequent adjustments in position for clients. A world unit is four inches, so a position tolerance of 3 means "one foot". | |||
;sync_now | |||
:This is for developer use and does not have any effect in the MP builds which I am distributing. | |||
==Settings== | ==Settings== | ||
When Zukai first runs, it creates a blank '''zukai_settings.txt''' file in the same folder. You can currently add the following settings to configure aspects of multiplayer: | |||
{| class="wikitable" | |||
!Setting name | |||
!Usage | |||
!Default | |||
!Description | |||
|- | |||
|lock_these_settings | |||
|yes/no | |||
|no | |||
|Reserved for use with an upcoming feature. | |||
|- | |||
|send_log_after_match | |||
|yes/no | |||
|yes | |||
|You can turn off the automatic log upload that occurs after a match, but please don't do that unless it is causing issues. | |||
|- | |||
|log_everything_for | |||
|(category names,<br>comma-separated) | |||
|Game status,<br>Logging,<br>Network setup | |||
|This is for enabling extra logging by category. | |||
|- | |||
|log_all_cli_output | |||
|yes/no | |||
|no | |||
|If there is an issue with the automatic log reporting, turning this on will dump messages from the upload process into the system log (Console.app). | |||
|} | |||
[[Category:Modding projects]] | [[Category:Modding projects]] | ||