diff --git a/README.md b/README.md index 0fe484d..ff4357a 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,80 @@ # Minicraft3DS 3DS Homebrew port of Notch's ludum dare game "Minicraft" +Current Version: Version 1.5.1 -Dependencies: + +---------- + +**Download:** + +If you just want to download the game prebuilt check the releases tab in Github: +https://github.com/andre111/Minicraft3DS/releases +For building the game yourself look below. + + +---------- + + +**Dependencies:** + +For building and installing the dependencies look below. ctrulib by smea: https://github.com/smealum/ctrulib - citro3d by fincs: https://github.com/fincs/citro3d - sf2dlib by xerpi: https://github.com/xerpi/sf2dlib - sfillib by xerpi: https://github.com/xerpi/sfillib - zlib: http://www.zlib.net/ -Current Version: Version 1.2 + +---------- + + +**Building:** + +1. Install devkitARM by devkitPro + - On Windows download https://sourceforge.net/projects/devkitpro/files/Automated%20Installer/ + - And install atleast Minimal System and devkitARM + - This includes make, ctrulib and citro3d +2. Install zlib, libjpeg-turbo and libpng + - Download 3DS-Portlibs: https://github.com/devkitPro/3ds_portlibs + - Run these commands: + +``` + make zlib + make install-zlib + make libjpeg-turbo + make libpng + make install +``` + +3. Install sf2dlib + - Download https://github.com/xerpi/sf2dlib + - In the libsf2d directory run these commands: +``` + make + make install +``` +4. Install sfillib + - Download https://github.com/xerpi/sfillib + - In the libsfil directory run these commands: +``` + make + make install +``` + +5. You can now build Minicraft3DS 3dsx and elf files by running make + + +---------- + You can do anything with the source code (besides sell it) as long as you give proper credit to the right people. If you are going to make a mod of this version, be sure to give credit to Markus "Notch" Perrson because he did create the original game after all. This source code is subject to a lot of change for better optimization/cleanliness. -Forum thread: https://gbatemp.net/threads/release-beta-minicraft-3ds-homebrew-edition.399295/ + +---------- + + +Forum thread: https://gbatemp.net/threads/release-minicraft3ds-the-multiplayer-update.495945/