From 3f0d3c8e988889177650bb14aadb0279c016bc42 Mon Sep 17 00:00:00 2001 From: Cubitect Date: Sat, 19 Dec 2015 12:14:46 +0100 Subject: [PATCH] made it more readable --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1b45151..5581ce6 100644 --- a/README.md +++ b/README.md @@ -6,17 +6,18 @@ The Cubitick minecraft mod is an analysis tool for the technical minecraft commu `/tickrate [rate]` Sets the tickrate of the world to `rate`. -`/ticksync [on/off]` -Controls if the player-tickrate should be independent of the world-tickrate. It is off (or false) by default. Enabling ticksync will use more vanilla code where possible (which might influence test results). Don't enable this at a world-tickrate of zero, or your game will freeze! +`/ticksync [true/false]` +Controls if the player-tickrate should be bound to the world-tickrate (false by default). When ticksync is enabled, the mod uses more vanilla code where possible (which might be relevant for testing). +Don't enable this at a world-tickrate of zero, or your game will freeze! ### Packet Analysis Cubitick 1.4.X comes bundled with a packet analysis tool which lets you view the content of some packets that are sent between the minecraft client and server. `/showpacket [PACKET_TYPE] [true/false]` -You can get a list of supported packet-types by running `/showpacket` without arguments. If you need to analyse packets of a particular type that are not yet supported, then you can try to contact me by email (probably slower) or on my [youtube channel](https://www.youtube.com/user/Cubitect) (probably faster) and I will try implement support in the next release. +You can get a list of supported packet-types using `/showpacket` without arguments. If you need to analyse packets of a particular type that are not yet supported, then you can try to contact me by email (probably slower) or on my [youtube channel](https://www.youtube.com/user/Cubitect) (probably faster) and I will try to implement support in the next release. `/rerender [fromX fromY fromZ toX toY toZ]` -When no arguments are specified, `/rerender` will do the same as pressing F3+A. However, if a region of block coordinates is defined by the argument, then the blocks in that region are marked to be rendered again (without reloading). This command is still experimental and might change syntax in future. +When no arguments are specified, `/rerender` will do the same as pressing F3+A. However, if a region of blocks is specified, then that region is marked in the code to be rendered again (without reloading). This command is still experimental and might change syntax in the future. ## Source The source code [here](https://github.com/Cubitect/Cubitick/tree/Cubitick-1.8) contains the modified classes in the decompiled minecraft code from [Mod Coder Pack](http://www.modcoderpack.com). The unmodified classes are not included.