TrueCraft/README.md

105 lines
3.9 KiB
Markdown
Raw Normal View History

2014-12-26 22:35:26 -07:00
# TrueCraft
2015-05-31 13:11:30 +02:00
[![Build Status](https://travis-ci.org/SirCmpwn/TrueCraft.svg?branch=master)](https://travis-ci.org/SirCmpwn/TrueCraft)
2015-02-01 14:12:28 -07:00
http://truecraft.io - blog and such
2014-12-27 22:53:22 -07:00
A completely
2014-12-26 22:35:26 -07:00
[clean-room](https://en.wikipedia.org/wiki/Clean_room_design) implementation of
2014-12-27 22:53:22 -07:00
Minecraft beta 1.7.3 (circa September 2011). No decompiled code has been used in
2015-05-14 19:30:04 -06:00
the development of this software. This is an **implementation** - not a clone.
TrueCraft is compatible with Minecraft beta 1.7.3 clients and servers.
2014-12-26 22:35:26 -07:00
2015-05-29 16:21:08 -06:00
![](https://a.pomf.se/yquumh.png)
2015-05-14 19:07:29 -06:00
2014-12-27 22:53:22 -07:00
I miss the old days of Minecraft, when it was a simple game. It was nearly
perfect. Most of what Mojang has added since beta 1.7.3 is fluff, life support
for a game that was "done" years ago. This is my attempt to get back to the
original spirit of Minecraft, before there were things like the End, or
all-in-one redstone devices, or village gift shops. A simple sandbox where you
can build and explore and fight with your friends. I miss that.
2014-12-26 22:35:26 -07:00
2014-12-27 22:53:22 -07:00
The goal of this project is effectively to fork Minecraft. Your contribution is
welcome, but keep in mind that I will mercilessly reject changes that aren't in
line with the vision. If you like the new Minecraft, please feel free to keep
playing it. If you miss the old Minecraft, join me.
2014-12-26 22:35:26 -07:00
2014-12-27 22:53:22 -07:00
### "What about Craft.Net?"
2014-12-26 22:35:26 -07:00
2014-12-27 22:53:22 -07:00
Craft.Net aims to support the latest version of Minecraft. That means I'm aiming
for a moving target every time Mojang updates the game, adding more features
that I don't like. I'm tired of Craft.Net. Let's do this instead.
2014-12-26 22:35:26 -07:00
2015-02-01 14:12:28 -07:00
## Compiling
**Use a recursive git clone.**
2014-12-26 22:35:26 -07:00
2015-02-01 14:12:28 -07:00
git clone --recursive git://github.com/SirCmpwn/TrueCraft.git
2015-05-01 07:02:04 -06:00
You need to restore Nuget packages. The easiest way is to open the solution up
in monodevelop or visual studio or the like and build from there. You can
alternatively acquire Nuget yourself and run this:
mono path/to/nuget.exe restore
From the root directory of the git repository. Then run:
2015-02-01 14:12:28 -07:00
xbuild
2014-12-28 20:26:22 -07:00
2015-05-01 07:02:04 -06:00
To compile it and you'll receive binaries in `TrueCraft/bin/Debug/`.
2014-12-28 20:26:22 -07:00
2015-05-01 08:15:23 -06:00
Note: if you have a problem with nuget connecting, run `mozroots --import
--sync`.
Note: TrueCraft requires mono 3.10 or newer.
2015-05-01 07:06:49 -06:00
2015-02-01 14:12:28 -07:00
## Get Involved
If you want to keep up with development or contribute, join #truecraft on
irc.esper.net. Pull requests will be rejected from authors who have read any
2015-02-01 14:12:28 -07:00
decompiled official Minecraft code.
2014-12-27 22:53:22 -07:00
2015-02-02 12:18:02 -07:00
To get started, sign the [Contributor License
Agreement](https://www.clahub.com/agreements/SirCmpwn/TrueCraft) to establish
that you have not, in fact, ever read decompiled Minecraft code.
2015-05-03 12:27:21 -06:00
If you *have* read the Minecraft source, you can contribute to the TrueCraft
wiki [here](https://github.com/SirCmpwn/TrueCraft/wiki). *Under no
circumstances should you expose clean devs to source code*.
2014-12-27 22:53:22 -07:00
## Roadmap
2014-12-26 22:35:26 -07:00
2014-12-27 22:53:22 -07:00
1. Implement server (in progress)
2015-05-14 19:07:29 -06:00
1. Implement client (in progress)
2014-12-27 22:53:22 -07:00
1. New authentication
1. Backport the good
1. Modding support
2014-12-26 22:35:26 -07:00
2015-05-14 19:07:29 -06:00
The client and server are pretty straightforward but will require *loads* of
work.
2014-12-26 22:35:26 -07:00
2014-12-27 22:53:22 -07:00
Mojang has shut off the old authentication servers, which means that it's no
longer possible to use beta 1.7.3 in online mode. We'll have to build our own.
After that, we'll have effectively reimplemented Minecraft from scratch and can
start (conservatively) adding things.
2014-12-26 22:35:26 -07:00
2014-12-27 22:53:22 -07:00
"Backporting the good" refers to implementing features from newer versions of
Minecraft that aren't bad. This also includes refactoring the internal details
of beta 1.7.3 to not suck so much (like the protocol). Some examples of features
I want to bring backwards are sprinting, more food types (but not hunger), and
smaller changes like lighting improvements and bow usage mechanics.
2014-12-27 00:24:31 -07:00
2014-12-27 22:53:22 -07:00
Finally, if we've got a nice mature project and a good community going, modding
support would be great.
2014-12-27 00:24:31 -07:00
## Textures
TrueCraft currently distributes
[ProgrammerArt](https://github.com/deathcap/ProgrammerArt) as the default
texture pack.
2014-12-26 22:35:26 -07:00
## Blah blah blah
TrueCraft is not associated with Mojang or Minecraft in any sort of official
capacity.