ClassiCube/readme.md

ClassicalSharp is a custom Minecraft Classic client written in C# that works on both Windows and Linux.
**It is not affiliated with (or supported by) Mojang AB, Minecraft, or Microsoft in any way.**

You can grab the latest stable binaries [here](https://github.com/UnknownShadow200/ClassicalSharp/releases).

You can grab the very latest OpenGL build [here](http://cs.classicube.net/latest.zip) and the latest Direct3D 9 build [here](http://cs.classicube.net/latest.DirectX.zip).

#### What ClassicalSharp is
* Works with both minecraft.net and classicube.net accounts.
* Lightweight, minimal memory usage compared to the standard client.
* Works with effectively all graphics cards that support OpenGL or Direct3D 9.
* Provides single-player support. (only flatgrass generator, but can load .dat, .cw and .fcm maps)

It **does not** work with 'modern/premium' Minecraft servers.

#### Requirements
* Windows: .NET framework 2.0 or Mono. (Vista and later have .NET framework 2.0 built in)
ClassicalSharp has been verified to work on Windows 2000, unsure about ME and 98.
* Linux: Mono.
* Mac OS X: Mono. (Not tested at all yet - likely just crashes)

#### Instructions
Initially, you will need to run launcher.exe to download the required assets from minecraft.net. 
Just click 'OK' to the dialog box that appears when you start the launcher.

**Singleplayer**
Run classicalsharp.exe.

**Multiplayer**
Run launcher.exe. You can connect to LAN/locally hosted servers, minecraft.net servers, and classicube.net servers through the launcher.

Alternatively, you can use [CSLauncher](https://github.com/umby24/CSLauncher/releases) instead of the default launcher included with ClassicalSharp - 
this launcher is very similar to ClassiCube's launcher and is simpler to use. (Thanks Umby24 for making this launcher)

##### Mono specific notes
*You must use either build using Mono compiler or define `__MonoCS__` when building, otherwise you will get runtime errors when decompressing the map using Mono.*
*Also, if you are using an older mono version, you may need to run `mozroots --import --sync` to import trusted root certificates, otherwise you will get an 'Error writing headers' exception.*

#### Key combinations
* Press escape (after joining a world) to switch to the pause menu. 
* Pause menu -> Key mappings lists all of the key combinations used by the client. 

Some points to note:
* If the server has disabled hacks, key combinations such as fly and speed will not do anything.
* Press F6 to cycle view distance. A smaller number of visible chunks can improve performance.
* Press F7 to toggle VSync on or off. (on minimises CPU usage)

#### Client commands
* To see a list of all built in commands, type `/client commands`.
* To see help for a given built in command, type `/client help <command name>`.
Formatting and minor cleanup in readme. 2015-07-01 11:27:54 +10:00			`ClassicalSharp is a custom Minecraft Classic client written in C# that works on both Windows and Linux.`
Fix clouds not moving when using Direct3D 9 build, remove somestuff from todo.txt and replace them with actual TODO comments in source code. Redesigned readme to use markdown and look nicer. 2015-07-01 11:15:53 +10:00			`It is not affiliated with (or supported by) Mojang AB, Minecraft, or Microsoft in any way.`

Fix hat rotating at wrong position, fixes #95. 2015-10-07 20:20:32 +11:00			`You can grab the latest stable binaries [here](https://github.com/UnknownShadow200/ClassicalSharp/releases).`
Cleanup readme. 2015-10-07 20:24:25 +11:00
Fix hat rotating at wrong position, fixes #95. 2015-10-07 20:20:32 +11:00			`You can grab the very latest OpenGL build [here](http://cs.classicube.net/latest.zip) and the latest Direct3D 9 build [here](http://cs.classicube.net/latest.DirectX.zip).`
Fix clouds not moving when using Direct3D 9 build, remove somestuff from todo.txt and replace them with actual TODO comments in source code. Redesigned readme to use markdown and look nicer. 2015-07-01 11:15:53 +10:00
			`#### What ClassicalSharp is`
			`* Works with both minecraft.net and classicube.net accounts.`
			`* Lightweight, minimal memory usage compared to the standard client.`
Fix issues with mouse cursor position on High-DPI displays. 2015-09-19 13:25:11 +10:00			`* Works with effectively all graphics cards that support OpenGL or Direct3D 9.`
Cleanup readme. 2015-10-07 20:24:25 +11:00			`* Provides single-player support. (only flatgrass generator, but can load .dat, .cw and .fcm maps)`
Fix clouds not moving when using Direct3D 9 build, remove somestuff from todo.txt and replace them with actual TODO comments in source code. Redesigned readme to use markdown and look nicer. 2015-07-01 11:15:53 +10:00
Some cleanup, simplify readme. 2015-09-30 08:33:35 +10:00			`It does not work with 'modern/premium' Minecraft servers.`
Fix clouds not moving when using Direct3D 9 build, remove somestuff from todo.txt and replace them with actual TODO comments in source code. Redesigned readme to use markdown and look nicer. 2015-07-01 11:15:53 +10:00
			`#### Requirements`
Formatting and minor cleanup in readme. 2015-07-01 11:27:54 +10:00			`* Windows: .NET framework 2.0 or Mono. (Vista and later have .NET framework 2.0 built in)`
Cleanup readme. 2015-10-07 20:24:25 +11:00			`ClassicalSharp has been verified to work on Windows 2000, unsure about ME and 98.`
Fix clouds not moving when using Direct3D 9 build, remove somestuff from todo.txt and replace them with actual TODO comments in source code. Redesigned readme to use markdown and look nicer. 2015-07-01 11:15:53 +10:00			`* Linux: Mono.`
			`* Mac OS X: Mono. (Not tested at all yet - likely just crashes)`

			`#### Instructions`
Some cleanup, simplify readme. 2015-09-30 08:33:35 +10:00			`Initially, you will need to run launcher.exe to download the required assets from minecraft.net.`
			`Just click 'OK' to the dialog box that appears when you start the launcher.`
Fix clouds not moving when using Direct3D 9 build, remove somestuff from todo.txt and replace them with actual TODO comments in source code. Redesigned readme to use markdown and look nicer. 2015-07-01 11:15:53 +10:00
Fix Direct3D9 build clipping when standing next to a block, blocks should not be placed over players. (Thanks Empy) 2015-09-30 09:10:55 +10:00			`Singleplayer`
Some cleanup, simplify readme. 2015-09-30 08:33:35 +10:00			`Run classicalsharp.exe.`
Fix clouds not moving when using Direct3D 9 build, remove somestuff from todo.txt and replace them with actual TODO comments in source code. Redesigned readme to use markdown and look nicer. 2015-07-01 11:15:53 +10:00
Fix Direct3D9 build clipping when standing next to a block, blocks should not be placed over players. (Thanks Empy) 2015-09-30 09:10:55 +10:00			`Multiplayer`
Some cleanup, simplify readme. 2015-09-30 08:33:35 +10:00			`Run launcher.exe. You can connect to LAN/locally hosted servers, minecraft.net servers, and classicube.net servers through the launcher.`

Fix markdown in readme. 2015-10-16 20:36:29 +11:00			`Alternatively, you can use [CSLauncher](https://github.com/umby24/CSLauncher/releases) instead of the default launcher included with ClassicalSharp -`
			`this launcher is very similar to ClassiCube's launcher and is simpler to use. (Thanks Umby24 for making this launcher)`
Add link to alternative launcher made by Umby24. 2015-10-16 20:35:55 +11:00
Some cleanup, simplify readme. 2015-09-30 08:33:35 +10:00			`##### Mono specific notes`
			You must use either build using Mono compiler or define `__MonoCS__` when building, otherwise you will get runtime errors when decompressing the map using Mono.
			Also, if you are using an older mono version, you may need to run `mozroots --import --sync` to import trusted root certificates, otherwise you will get an 'Error writing headers' exception.
Fix clouds not moving when using Direct3D 9 build, remove somestuff from todo.txt and replace them with actual TODO comments in source code. Redesigned readme to use markdown and look nicer. 2015-07-01 11:15:53 +10:00
			`#### Key combinations`
			`* Press escape (after joining a world) to switch to the pause menu.`
Update readme, fix non-compliant GL calls. 2015-09-24 15:56:35 +10:00			`* Pause menu -> Key mappings lists all of the key combinations used by the client.`
Fix clouds not moving when using Direct3D 9 build, remove somestuff from todo.txt and replace them with actual TODO comments in source code. Redesigned readme to use markdown and look nicer. 2015-07-01 11:15:53 +10:00
			`Some points to note:`
Try 2 at fitting things on one or two lines. 2015-07-01 12:00:38 +10:00			`* If the server has disabled hacks, key combinations such as fly and speed will not do anything.`
Update readme, fix non-compliant GL calls. 2015-09-24 15:56:35 +10:00			`* Press F6 to cycle view distance. A smaller number of visible chunks can improve performance.`
Mention in readme that you don't really need to turn off VSync anymore for faster chunk mesh building. 2015-09-05 09:39:46 +10:00			`* Press F7 to toggle VSync on or off. (on minimises CPU usage)`
Fix clouds not moving when using Direct3D 9 build, remove somestuff from todo.txt and replace them with actual TODO comments in source code. Redesigned readme to use markdown and look nicer. 2015-07-01 11:15:53 +10:00
			`#### Client commands`
			* To see a list of all built in commands, type `/client commands`.
Not sure why .sln was modified, update readme. 2015-09-01 06:53:17 +10:00			* To see help for a given built in command, type `/client help <command name>`.