mirror of
https://gitlab.bixilon.de/bixilon/minosoft.git
synced 2025-09-07 22:39:01 -04:00
update readme, update screenshots
This commit is contained in:
parent
efd02d1593
commit
aded63eba9
@ -24,11 +24,6 @@ Minosoft is an open source project, it helps if you recommend it and share it mo
|
||||
|
||||
I started this project in mind, that I'll never earn money from it. Just doing it for fun, so I am not dependent on it. So: Currently not available and not planned.
|
||||
|
||||
## Issue and MR rules
|
||||
- Do not spam, we will answer when we have time.
|
||||
- Use english whenever possible, we would even allow using german, but try to use english.
|
||||
- Don't hesitate against other developers.
|
||||
|
||||
## Contact us
|
||||
|
||||
If you want to ask me, the team or whoever in this project a question, you can do the following things:
|
||||
|
13
Credits.md
13
Credits.md
@ -1,14 +1,13 @@
|
||||
# Credits
|
||||
First of all: Thanks to the authors from [wiki.vg](https://wiki.vg) for documenting the protocol.
|
||||
Also, special thanks to [Pokechu22](https://github.com/Pokechu22) for being available on their irc and for helping with some problems.
|
||||
First: Thanks to the authors from [wiki.vg](https://wiki.vg) for documenting the protocol. Also, special thanks to the #mcdevs irc, there are many great people that helped us.
|
||||
|
||||
## Thanks to the following projects:
|
||||
- [Burger](https://github.com/Pokechu22/Burger)
|
||||
- [wiki.vg](https://wiki.vg)
|
||||
- [Glowstone](https://glowstone.net/) For letting me see how you did, when something was documented pretty badly
|
||||
- [Mojang](https://mojang.com) For including data generators in 1.13 (after flattening update)
|
||||
- [Mojang](https://mojang.com) For the original game
|
||||
|
||||
## Thanks to all contributors:
|
||||
- [Bixilon](https://bixilon.de) (Wow, that's me :D)
|
||||
- [Lukas](https://gitlab.bixilon.de/lukas) For giving me motivation and developing the rendering (Game graphics)
|
||||
- [Alex](https://gitlab.bixilon.de/alexamg) For the awesome logo
|
||||
|
||||
- [Bixilon](https://bixilon.de) (Wow, that's me :D)
|
||||
- [Lukas](https://gitlab.bixilon.de/lukas) For giving me motivation and developing part of the rendering and doing some voodoo math for me :)
|
||||
- [Alex](https://gitlab.bixilon.de/alexamg) For the awesome logo
|
||||
|
81
ReadMe.md
81
ReadMe.md
@ -5,85 +5,86 @@ Minosoft is an open source minecraft client, written from scratch in java. It ai
|
||||
[](https://jitpack.io/#de.bixilon.gitlab.bixilon/minosoft)
|
||||
|
||||
## Feature overview
|
||||
- Rendering (WIP)
|
||||
- Multi protocol support (1.7 - latest)
|
||||
- Modding
|
||||
- Fast performance (incredible start time of 3 - 5 seconds on modern hardware (tested on Intel i7-4800MQ))
|
||||
- Free (as far as we consider original minecraft as free) and open source
|
||||
- Multi accounting
|
||||
- Multi "sessions" (Connections to a server)
|
||||
- Multi threading
|
||||
- Async loading
|
||||
- Debugging on protocol layer
|
||||
- LAN Servers
|
||||
|
||||
- Rendering
|
||||
- Multi protocol support (1.7 - latest)
|
||||
- Stable modding API
|
||||
- Unsafe modding API
|
||||
- Fast performance (incredible start time of 3 - 5 seconds on modern hardware)
|
||||
- Free (as far as we consider original minecraft as free) and open source
|
||||
- Multi accounting (also multiple account vendors: Offline, Mojang, Microsoft)
|
||||
- Multi "sessions" (Connections to a server)
|
||||
- Multi threading and asynchronous loading
|
||||
- Debugging on protocol layer
|
||||
- LAN servers
|
||||
- Way more stuff
|
||||
|
||||
## System requirements
|
||||
|
||||
- CPU: Minosoft benefits from multiple cores (at least for most stuff). CPU is kind of important, but for the rendering clock speed is more important. 4 cores recommended with at least 2 Ghz.
|
||||
- RAM: Our goal was it to run without compromises on an 8 Gib computer and at least limited on an 4 Gib one.
|
||||
- Disk space: Minosoft itself is pretty small (2-3 Mib), the libraries are a bit bigger. You also need to have the "normal" minecraft assets (~ 300 MB for one version). Assets never get saved duplicated, so if you use multiple versions, it is not a multiple of that value! If you only play 1 version, 500 MB is recommended. If not, use at least 1 GB.
|
||||
- GPU: Currently only needed for rendering, no clue yet.
|
||||
- Java 15 (This is really important, we use specific (experimental) features that are only available in the latest version. Java 8 is **not** supported).
|
||||
OpenJDK is (of course) also supported.
|
||||
- CPU: Minosoft works mostly asynchronous, so multiple cores are good. For FPS more clock speed is better.
|
||||
- RAM: Our goal was it to run without compromises on an 8 GiB computer and at least limited on an 4 GiB one.
|
||||
- Disk space: Minosoft itself is pretty small (2-3 Mib), the libraries are a bit bigger. You also need to have the "normal" minecraft assets (~ 300 MB for one version).
|
||||
- GPU: OpenGL 3.3+. Every moden GPU works and is recommended.
|
||||
- Java 15 (This is really important, we use experimental features that are only available in this version. Java 8 is currently **not** supported).
|
||||
|
||||
|
||||
## Rendering
|
||||
Rendering is developed and maintained by Lukas Eisenhauer. It is very WIP, but it works. See !8 for more details.
|
||||
|
||||

|
||||
The current result of rendering (taken in 739f861bf62341698abcd58386c353a4831f4818).
|
||||
Works. Still missing many features, but heavily developed.
|
||||
|
||||

|
||||
The Hypixel prototype lobby (taken in 91ab431004fa1ae132a1eb1115550f84c27f48f8).
|
||||

|
||||
Lighting demo.
|
||||
|
||||
## Launcher
|
||||

|
||||
Biomes demo (picture not up to date, contains bugs)
|
||||
|
||||
## Starting, etc
|
||||
|
||||
There is no "launcher" or anything familliar. Just start Minosoft and you are practically in the game. You will be greeted with a server list. Once you know what server you want to join, click on it. All data will then be loaded, and the rendering window starts, once everything is done.
|
||||
|
||||
The "Launcher" is not really a launcher, it is just a (beautifully designed and functional) server list 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 this window will be shown to you. All downloads, loadings, ... happen before it asynchronous before showing it. After double-clicking on the server. you can connect to it. Once connected (= Received spawn location), you can play :)
|
||||

|
||||
|
||||
## 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.
|
||||
|
||||
I always try to add support for the newest version of minecraft. Mostly it is pretty easy, just declaring it and generate all data. 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.
|
||||
|
||||
### Supported versions
|
||||
Almost all versions are supported, starting with 13w41b (pre 1.7 snapshot) and ending with the newest (1.16.4 as of writing this). I plan to maintain Minosoft to at least version 1.20, so stay tuned. Old versions are supported, but it is highly recommended using the latest stable release.
|
||||
|
||||
Almost all versions (and snapshots!) between 1.7 and the latest one (21w07a as of writing this, snapshot for 1.17). I plan to maintain Minosoft to at least version 1.20, so stay tuned. Support for older protocols will not be dropped as newer protocols are added. And I can only recommend using the latest stable version.
|
||||
|
||||
### 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.
|
||||
|
||||
### Partly supported versions
|
||||
|
||||
- Protocol lacking; See [snapSupportToDo.txt](/doc/snapSupportToDo.txt)
|
||||
- Entities everything below `19w36a` (shortly after 1.14.4) (except `1.14.4` and `1.8.9`). Why? There is simply no time to create an `entities.json`. The [Generator](/util) only works after that version. And 1.8.9 is only supported, because this version is widely spread, and I wrote (~ 1000 lines) by hand.
|
||||
Minosoft uses [PixLyzer](https://gitlab.bixilon.de/bixilon/pixlyzer) as data source for all kind of data (like block ids, item ids, ...). PixLyzer currently works for 1.14.4+. We will backport it for <1.13 soon.
|
||||
|
||||
## Modding
|
||||
|
||||
Minosoft is modding friendly. A decent API was introduced with !17. It is pretty final, but some things might still change. See [Modding.md](doc/Modding.md) for more details. The code is pretty dynamic (all blocks, items, entities, etc are stored in json files). It is pretty easy to load custom entities, etc. Spoiler: Forge mods are NOT compatible. Feel free to write a compatibility layer (This is a really hard thing, we do things completely different).
|
||||
Minosoft is modding friendly. A decent and stable API was introduced with !17. It is pretty final, but some things might still change. See [Modding.md](doc/Modding.md) for more details. The code is pretty dynamic (all blocks, items, entities, etc are stored in json files). It is pretty easy to load custom entities, etc, so adding custom blocks, etc is easily possible. Spoiler: Forge mods are NOT compatible. Feel free to write a compatibility layer (This is a really hard thing, we do things
|
||||
completely different).
|
||||
|
||||
## Botting
|
||||
On the ToDo List
|
||||
|
||||
## Contribution or helping out
|
||||
You're welcome. Because this is still work-in-progress, consider contacting us first, but feel free to take a look at [Contributing.md](/Contributing.md).
|
||||
|
||||
You're welcome, but feel free to take a look at [Contributing.md](/Contributing.md).
|
||||
|
||||
## Tools and generators
|
||||
We wrote some tools to help out, see [Utility](util/ReadMe.md).
|
||||
|
||||
## Credits
|
||||
Some projects and persons helped this project a lot. See [Credits](Credits.md).
|
||||
|
||||
See [Credits](Credits.md).
|
||||
|
||||
## Releases and beta
|
||||
No clue, but still waiting for !8. Also, some features need to be implemented, so not soo soon (but we are getting closer).
|
||||
|
||||
No clue, but still waiting for !21. Also, some features need to be implemented, so not soo soon (but we are getting closer).
|
||||
|
||||
## Compiling and running
|
||||
|
||||
1. Install Maven and java 15 (On Ubuntu based distributions: `sudo apt install maven openjdk-15-jdk`).
|
||||
2. Clone this repo (`git clone https://gitlab.bixilon.de/bixilon/minosoft.git`).
|
||||
3. Change directory (`cd minosoft`).
|
||||
4. Checkout the branch (`git checkout <branch>`). Eventually `render` or `development`.
|
||||
4. Checkout the branch (`git checkout <branch>`). Eventually `rendering` or `development`.
|
||||
5. Build and run Minosoft with `mvn clean verify exec:java`. If any errors occur, feel free to open an issue. In this early stage it might be helpful to delete the app data folder (only of minosoft).
|
||||
|
||||
## Code mirrors
|
||||
|
Binary file not shown.
Before Width: | Height: | Size: 247 KiB |
BIN
doc/img/rendering1.png
Normal file
BIN
doc/img/rendering1.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 1.2 MiB |
BIN
doc/img/rendering2.png
Normal file
BIN
doc/img/rendering2.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 1.6 MiB |
Binary file not shown.
Before Width: | Height: | Size: 560 KiB |
Loading…
x
Reference in New Issue
Block a user