wip readme

.idea/dictionaries/moritz.xml

@@ -33,6 +33,7 @@
       <w>drippinglava</w>
       <w>drippingwater</w>
       <w>dyearmor</w>
+      <w>eisenhauer</w>
       <w>elderguardian</w>
       <w>elytra</w>
       <w>enchantedhit</w>

ReadMe.md

@@ -0,0 +1,54 @@
+# Minosoft
+Minosoft is an open source minecraft client, written from scratch in java. It aims to bring more functionality and stability.
+
+## Feature overview
+ - Rendering (WIP)
+ - Multi protocol support (1.7 - latest)
+ - Modding
+ - Fast performance (start time on my laptop: 3 seconds)
+ - Free and open source
+ - Multi accounting
+ - Multi "sessions" (Connections to a server)
+ - Multi threading
+ - Async loading
+ - Debugging on protocol layer
+
+## Rendering
+Rendering is developed and maintained by Lukas Eisenhauer. It is very WIP, but it works. See !8 for more details.
+
+![Rendering](doc/img/rendering.png)
+The current result of rendering (taken in 739f861bf62341698abcd58386c353a4831f4818).
+
+## Launcher
+The "Launcher" is not really a launcher, it is just a (badly designed, but functional) Serverlist with account management functionality.
+Launcher is in quotation marks, because it is not really a launcher. It is the game. You click on run and see this window. All downloads, loadings, ... happen async in the background.
+If you double-click on the server. you can connect to it. Once connected (= Received spawn location), you can play :)
+![Server list](doc/img/server_list.png)
+
+## Version support
+I always try to add support for the newest version of minecraft. Mostly it is pretty easy, just add the newest version to the `versions.json` and generate the mappings.
+After pushing it, it is supported. Some versions are more complicated and need a bit of coding. I always try it as fast as possible, but sometimes I just need time.
+Check out [wiki.vg](https://wiki.vg/Main_Page) for more information.
+
+### Supported versions
+Almost all versions are supported, starting with 13w41b (pre 1.7 snapshot) and ending with the newest (1.16.3 as of writing this.)
+
+### Unsupported versions
+Sadly, we cannot support all versions. We will add support for all major versions (like 1.8.9, 1.9.4, 1.14.4, etc), but it is simply not possible to support all snapshots.
+ - `1.13-pre6`, `1.13-pre5`, `17w50a`, `17w49b`, `17w49a`, `17w48a`, `17w47b`, `17w47a`: Missing blocks.json (Mappings)
+ - April fools: I will not add any support for them, there are only a few things known. They might work, untested
+ 
+## Modding
+Minosoft is modding friendly. Currently (because of WIP), there is no modding API. The code is pretty dynamic (all blocks, items, entities, etc are stored in json files). It is pretty easy to load custom entities, etc.
+We will add a real modding API once Rendering is complete. Spoiler: Forge mods are NOT compatible. Feel free to write a compatibility layer (This is a really hard thing, we do things completely different).
+
+## Contribution
+You're welcome. Because this is pretty much incomplete, contact us before working on it and submitting a pull request.
+
+## Tools
+We wrote some tools to help out, see [Utility](util/ReadMe.md).
+
+# Releases and beta
+We are almost ready to release a beta once !8 is merged.
+
+This readme is work in progress, things may change over time.