ClassiCube/readme.md

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

![screenshot_n](https://cloud.githubusercontent.com/assets/6509348/15708889/df3f104a-2844-11e6-8901-69a9d55da2f1.png)


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~~(classic has been removed by Mojang) 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, and both a flatgrass and vanilla-type map generator.

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 and Mac OSX: Either Wine or Mono.

#### Instructions
Initially, you will need to run launcher.exe to download the required assets from minecraft.net. 
Just click 'OK' to the dialog menu 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.

###### *Mono specific*
*If you are using Wine, you need to mark both ClassicalSharp.exe and Launcher.exe as executable, then type this into the terminal: `./Launcher.exe`
If you are using Mono, you just need to type `mono Launcher.exe` into the terminal.*

*Also when using older mono versions, you may need to run `mozroots --import --sync` to import trusted root certificates, otherwise you will get an 'Error writing headers' exception.*

*You must use either build using the Mono compiler or define `__MonoCS__` when building, otherwise you will get runtime errors when decompressing the map using Mono.*

#### Tips
* Press escape (after joining a world) to switch to the pause menu.
* Pause menu -> Key bindings lists all of the key combinations used by the client. 
* Note that toggling 'vsync' to on will minimise CPU usage, while off will maximimise chunk loading speed.
* Press F to cycle view distance. A smaller number of visible chunks can improve performance.

* If the server has disabled hacks, key combinations such as fly and speed will not do anything.
* 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>`.
Initial block in hand model. No left/right click animations yet though. 2015-11-15 18:48:51 -05:00			`ClassicalSharp is a custom Minecraft Classic client written in C# that works on Windows, Linux and OSX.`
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-06-30 21:15:53 -04:00			`It is not affiliated with (or supported by) Mojang AB, Minecraft, or Microsoft in any way.`

Update main screenshot on github. 2016-06-01 08:05:37 -04:00			`![screenshot_n](https://cloud.githubusercontent.com/assets/6509348/15708889/df3f104a-2844-11e6-8901-69a9d55da2f1.png)`
Update main screenshot to use default.png 2015-10-28 15:28:23 -04:00
Fix some things in launcher, update readme. 2015-10-23 03:23:03 -04:00
Fix hat rotating at wrong position, fixes #95. 2015-10-07 05:20:32 -04:00			`You can grab the latest stable binaries [here](https://github.com/UnknownShadow200/ClassicalSharp/releases).`
Cleanup readme. 2015-10-07 05:24:25 -04:00
Fix hat rotating at wrong position, fixes #95. 2015-10-07 05:20:32 -04: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-06-30 21:15:53 -04:00
			`#### What ClassicalSharp is`
Update the readme, also add notes about how to run the client using Wine. (Thanks Moosfet) 2016-01-12 05:53:17 -05:00			`* Works with both ~~minecraft.net~~(classic has been removed by Mojang) and classicube.net accounts.`
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-06-30 21:15:53 -04:00			`* Lightweight, minimal memory usage compared to the standard client.`
Fix issues with mouse cursor position on High-DPI displays. 2015-09-18 23:25:11 -04:00			`* Works with effectively all graphics cards that support OpenGL or Direct3D 9.`
Update the readme, also add notes about how to run the client using Wine. (Thanks Moosfet) 2016-01-12 05:53:17 -05:00			`* Provides single-player support, and both a flatgrass and vanilla-type map generator.`
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-06-30 21:15:53 -04:00
Some cleanup, simplify readme. 2015-09-29 18:33:35 -04: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-06-30 21:15:53 -04:00
			`#### Requirements`
Formatting and minor cleanup in readme. 2015-06-30 21:27:54 -04:00			`* Windows: .NET framework 2.0 or Mono. (Vista and later have .NET framework 2.0 built in)`
Cleanup readme. 2015-10-07 05:24:25 -04:00			`ClassicalSharp has been verified to work on Windows 2000, unsure about ME and 98.`
Update the readme, also add notes about how to run the client using Wine. (Thanks Moosfet) 2016-01-12 05:53:17 -05:00			`* Linux and Mac OSX: Either Wine or Mono.`
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-06-30 21:15:53 -04:00
			`#### Instructions`
Some cleanup, simplify readme. 2015-09-29 18:33:35 -04:00			`Initially, you will need to run launcher.exe to download the required assets from minecraft.net.`
Update the readme, also add notes about how to run the client using Wine. (Thanks Moosfet) 2016-01-12 05:53:17 -05:00			`Just click 'OK' to the dialog menu 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-06-30 21:15:53 -04:00
Fix Direct3D9 build clipping when standing next to a block, blocks should not be placed over players. (Thanks Empy) 2015-09-29 19:10:55 -04:00			`Singleplayer`
Some cleanup, simplify readme. 2015-09-29 18:33:35 -04: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-06-30 21:15:53 -04:00
Fix Direct3D9 build clipping when standing next to a block, blocks should not be placed over players. (Thanks Empy) 2015-09-29 19:10:55 -04:00			`Multiplayer`
Update the readme, also add notes about how to run the client using Wine. (Thanks Moosfet) 2016-01-12 05:53:17 -05:00			`Run launcher.exe. You can connect to LAN/locally hosted servers, ~~minecraft.net servers,~~ and classicube.net servers through the launcher.`
Add link to alternative launcher made by Umby24. 2015-10-16 05:35:55 -04:00
Fix some things in launcher, update readme. 2015-10-23 03:23:03 -04:00			`###### Mono specific`
Implement same logic in launchers table widget too. 2016-03-30 08:22:44 -04:00			*If you are using Wine, you need to mark both ClassicalSharp.exe and Launcher.exe as executable, then type this into the terminal: `./Launcher.exe`
			If you are using Mono, you just need to type `mono Launcher.exe` into the terminal.*
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-06-30 21:15:53 -04:00
Fix some things in launcher, update readme. 2015-10-23 03:23:03 -04:00			Also when using older mono versions, 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-06-30 21:15:53 -04:00
Implement same logic in launchers table widget too. 2016-03-30 08:22:44 -04:00			You must use either build using the Mono compiler or define `__MonoCS__` when building, otherwise you will get runtime errors when decompressing the map using Mono.
Update the readme, also add notes about how to run the client using Wine. (Thanks Moosfet) 2016-01-12 05:53:17 -05:00
Remove TexturePack command as it was replaced by gui long ago. 2015-10-23 03:33:51 -04:00			`#### Tips`
Fix some things in launcher, update readme. 2015-10-23 03:23:03 -04:00			`* Press escape (after joining a world) to switch to the pause menu.`
Fix mistake in readme. 2015-10-28 02:39:39 -04:00			`* Pause menu -> Key bindings lists all of the key combinations used by the client.`
Update the readme, also add notes about how to run the client using Wine. (Thanks Moosfet) 2016-01-12 05:53:17 -05:00			`* Note that toggling 'vsync' to on will minimise CPU usage, while off will maximimise chunk loading speed.`
Fix some things in launcher, update readme. 2015-10-23 03:23:03 -04:00			`* Press F to cycle view distance. A smaller number of visible chunks can improve performance.`

			`* If the server has disabled hacks, key combinations such as fly and speed will not do anything.`
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-06-30 21:15:53 -04:00			* To see a list of all built in commands, type `/client commands`.
Not sure why .sln was modified, update readme. 2015-08-31 16:53:17 -04:00			* To see help for a given built in command, type `/client help <command name>`.