mirror of
https://github.com/ClassiCube/ClassiCube.git
synced 2025-09-13 01:26:50 -04:00
Tidy up readme somewhat
This commit is contained in:
parent
680fd10daa
commit
bbfcfba18a
@ -6,7 +6,7 @@
|
|||||||
# - The root folder is ~/client/ (i.e. folder layout is ~/client/.git/, ~/client/src/, etc)
|
# - The root folder is ~/client/ (i.e. folder layout is ~/client/.git/, ~/client/src/, etc)
|
||||||
# First you need to install these packages: gcc, i686-w64-mingw32-gcc and x86_64-w64-mingw32-gcc
|
# First you need to install these packages: gcc, i686-w64-mingw32-gcc and x86_64-w64-mingw32-gcc
|
||||||
#
|
#
|
||||||
# You then need to install these packages: libx11-dev, libgl1-mesa-dev, libopenal-dev, libcurl4-gnutls-dev/libcurl4-openssl-dev
|
# You then need to install these packages: libx11-dev and libgl1-mesa-dev
|
||||||
# - if 32 bit, then install the 64 bit variants of all these packages (e.g. libx11-dev:amd64)
|
# - if 32 bit, then install the 64 bit variants of all these packages (e.g. libx11-dev:amd64)
|
||||||
# - if 64 bit, then install the 32 bit variants of all these packages (e.g. libx11-dev:i386)
|
# - if 64 bit, then install the 32 bit variants of all these packages (e.g. libx11-dev:i386)
|
||||||
#
|
#
|
||||||
@ -15,11 +15,6 @@
|
|||||||
# The alternate bit .so files should have been left behind in the mesa folder, so adding a symlink should make it compile again
|
# The alternate bit .so files should have been left behind in the mesa folder, so adding a symlink should make it compile again
|
||||||
# - for 32 bit: ln -sf /usr/lib/x86_64-linux-gnu/mesa/libGL.so.1 /usr/lib/x86_64-linux-gnu/libGL.so
|
# - for 32 bit: ln -sf /usr/lib/x86_64-linux-gnu/mesa/libGL.so.1 /usr/lib/x86_64-linux-gnu/libGL.so
|
||||||
# - for 64 bit: ln -sf /usr/lib/i386-linux-gnu/mesa/libGL.so.1 /usr/lib/i386-linux-gnu/libGL.so
|
# - for 64 bit: ln -sf /usr/lib/i386-linux-gnu/mesa/libGL.so.1 /usr/lib/i386-linux-gnu/libGL.so
|
||||||
#
|
|
||||||
# You should now be able to compile both 32 and 64 bit variants of the client for linux
|
|
||||||
# However! The default libcurl package will produce an executable that won't run on Arch (due to defining CURL_OPENSSL_3)
|
|
||||||
# As such, you may want to uninstall libcurl package, manually compile curl's source code for both 32 and 64 bit,
|
|
||||||
# then add the .so files to /usr/lib/i386-linux-gnu and /usr/lib/x86_64-linux-gnu/
|
|
||||||
|
|
||||||
# paths, change these as needed
|
# paths, change these as needed
|
||||||
SOURCE_DIR=~/client
|
SOURCE_DIR=~/client
|
||||||
|
17
readme.md
17
readme.md
@ -7,10 +7,9 @@ ClassiCube is a custom Minecraft Classic and ClassiCube client written in C that
|
|||||||
You can grab the latest stable binaries [from here](https://www.classicube.net/download/) and the very latest builds [from here](https://www.classicube.net/nightlies/).
|
You can grab the latest stable binaries [from here](https://www.classicube.net/download/) and the very latest builds [from here](https://www.classicube.net/nightlies/).
|
||||||
|
|
||||||
#### What ClassiCube is
|
#### What ClassiCube is
|
||||||
* Works with both ~~minecraft.net~~(classic has been removed by Mojang) and classicube.net accounts.
|
* A complete re-implementation of Minecraft Classic, with optional additions.
|
||||||
* Lightweight, minimal memory usage compared to the standard client.
|
* Lightweight, minimal memory usage compared to the vanilla client.
|
||||||
* Works with effectively all graphics cards that support OpenGL or Direct3D 9.
|
* 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.
|
It **does not** work with 'modern/premium' Minecraft servers.
|
||||||
|
|
||||||
@ -30,7 +29,7 @@ Run ClassiCube.exe, then click Singleplayer at the main menu.
|
|||||||
Run ClassiCube.exe. You can connect to LAN/locally hosted servers, ~~minecraft.net servers,~~ and classicube.net servers through the launcher.
|
Run ClassiCube.exe. You can connect to LAN/locally hosted servers, ~~minecraft.net servers,~~ and classicube.net servers through the launcher.
|
||||||
|
|
||||||
###### *Windows specific*
|
###### *Windows specific*
|
||||||
*If you are stuck using the built-in OpenGL 1.1 software renderer, you can use the MESA software renderer from either [here](http://download.qt.io/development_releases/prebuilt/llvmpipe/windows/) or [here](https://wiki.qt.io/Cross_compiling_Mesa_for_Windows) for slightly better performance. Typically though, this occurs because you have not installed GPU drivers.*
|
*If you are stuck using the built-in OpenGL 1.1 software renderer, you can use the MESA software renderer from [here](http://download.qt.io/development_releases/prebuilt/llvmpipe/windows/) for slightly better performance. Typically though, this occurs because you have not installed GPU drivers.*
|
||||||
|
|
||||||
### Compiling
|
### Compiling
|
||||||
|
|
||||||
@ -39,19 +38,19 @@ Run ClassiCube.exe. You can connect to LAN/locally hosted servers, ~~minecraft.n
|
|||||||
##### Compiling with Visual Studio:
|
##### Compiling with Visual Studio:
|
||||||
Open ClassiCube.sln and compile it.
|
Open ClassiCube.sln and compile it.
|
||||||
|
|
||||||
If you get a ```The Windows SDK version 5.1 was not found``` compilation error, [see here for how to fix](misc/compile-fixes.md#visual-studio-unsupported-platform-toolset)
|
If you get a ```The Windows SDK version 5.1 was not found``` compilation error, [see here for how to fix](doc/compile-fixes.md#visual-studio-unsupported-platform-toolset)
|
||||||
|
|
||||||
##### Compiling with MinGW-w64
|
##### Compiling with MinGW-w64
|
||||||
I am assuming you used the installer from https://sourceforge.net/projects/mingw-w64/
|
I am assuming you used the installer from https://sourceforge.net/projects/mingw-w64/
|
||||||
1. Install MinGW-W64
|
1. Install MinGW-W64
|
||||||
2. Use either *Run Terminal* from Start Menu or run *mingw-w64.bat* in the installation folder
|
2. Use either *Run Terminal* from Start Menu or run *mingw-w64.bat* in the installation folder
|
||||||
3. Compile with the same flags as under **Cross Compiling for windows**, but use *gcc* instead of *i586-mingw32msvc-gcc*
|
3. Compile with the same flags as under **Cross Compiling for windows**, but use *gcc* instead of *i686-w64-mingw32-gcc*
|
||||||
|
|
||||||
##### Compiling with MinGW
|
##### Compiling with MinGW
|
||||||
I am assuming you used the installer from http://www.mingw.org/
|
I am assuming you used the installer from http://www.mingw.org/
|
||||||
1. Install MinGW. You need mingw32-base-bin and msys-base-bin packages.
|
1. Install MinGW. You need mingw32-base-bin and msys-base-bin packages.
|
||||||
2. Run *msys.bat* in the *C:\MinGW\msys\1.0* folder.
|
2. Run *msys.bat* in the *C:\MinGW\msys\1.0* folder.
|
||||||
3. Compile with the same flags as under **Cross Compiling for windows**, but use *gcc* instead of *i586-mingw32msvc-gcc*
|
3. Compile with the same flags as under **Cross Compiling for windows**, but use *gcc* instead of *i686-w64-mingw32-gcc*
|
||||||
|
|
||||||
#### Linux
|
#### Linux
|
||||||
|
|
||||||
@ -61,7 +60,7 @@ Install appropriate libs as required. For ubuntu these are: libx11-dev, libxi-de
|
|||||||
|
|
||||||
##### Cross compiling for windows:
|
##### Cross compiling for windows:
|
||||||
|
|
||||||
```i586-mingw32msvc-gcc *.c -o ClassiCube.exe -mwindows -lws2_32 -lwininet -lwinmm -limagehlp -lcrypt32 -ld3d9```
|
```i686-w64-mingw32-gcc *.c -o ClassiCube.exe -mwindows -lws2_32 -lwininet -lwinmm -limagehlp -lcrypt32 -ld3d9```
|
||||||
|
|
||||||
##### Raspberry pi
|
##### Raspberry pi
|
||||||
Although the regular linux compiliation flags will work fine, to take full advantage of the hardware:
|
Although the regular linux compiliation flags will work fine, to take full advantage of the hardware:
|
||||||
@ -144,6 +143,6 @@ Further information (e.g. style) for the game's source code can be found in the
|
|||||||
* curl - HTTP/HTTPS for linux and macOS
|
* curl - HTTP/HTTPS for linux and macOS
|
||||||
* FreeType - Font handling for all platforms
|
* FreeType - Font handling for all platforms
|
||||||
* GCC - Compiles client for linux
|
* GCC - Compiles client for linux
|
||||||
* MinGW - Compiles client for windows
|
* MinGW-w64 - Compiles client for windows
|
||||||
* Clang - Compiles client for macOS
|
* Clang - Compiles client for macOS
|
||||||
* Emscripten - Compiles client for web
|
* Emscripten - Compiles client for web
|
Loading…
x
Reference in New Issue
Block a user