AstralTransRocketries/minosoft
1
0
Fork 0
mirror of https://gitlab.bixilon.de/bixilon/minosoft.git synced 2025-09-12 17:07:55 -04:00
Code Issues Packages Projects Releases Wiki Activity

Improve Readmes

Browse Source
This commit is contained in:
Bixilon 2020-12-06 14:19:17 +01:00
parent 005f3c0f01
commit 263ba8c799
No known key found for this signature in database
GPG Key ID: 5CAD791931B09AC4
3 changed files with 22 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Contribution.md
View File

@ -1,6 +1,6 @@
# How to contribute
First of all, thank you for visiting this page and for even thinking about contributing.
First, thank you for visiting this page and for even thinking about contributing.
## Things you can do
@ -22,8 +22,8 @@ Minosoft is an open source project, it helps if you recommend it and share it mo
that I developed something useful, and people start contributing.
### Donating
I started this project with the mind, that I'll never earn money from it. Just doing it for fun, so I am not dependent on it.
In short: Currently not available and not planned.
I started this project inb 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.

28
ReadMe.md
View File

@ -8,21 +8,20 @@ Minosoft is an open source minecraft client, written from scratch in java. It ai
- 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)
- 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
- Search for LAN Server
- LAN Servers
## 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: Out 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 (up to 100 MB).
You also need to have the "normal" minecraft assets (~ 300 MB). So a total of 500 MB is recommended.
- 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 (up to 100 MB). You also need to have the "normal" minecraft assets (~ 300 MB). So a total of 500 MB is recommended.
- 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.
@ -38,9 +37,8 @@ The current result of rendering (taken in 739f861bf62341698abcd58386c353a4831f48
The Hypixel prototype lobby (taken in 91ab431004fa1ae132a1eb1115550f84c27f48f8).
## Launcher
The "Launcher" is not really a launcher, it is just a (beautifully designed, but 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 see this window. All downloads, loadings, ... happen before it asynchronous in the background.
If you double-click on the server. you can connect to it. Once connected (= Received spawn location), you can play :)
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 :)
![Server list](doc/img/server_list.png)
## Version support
@ -57,13 +55,13 @@ Sadly, we cannot support all versions. We will add support for all major version
- 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 generate 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.
- 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.
## Modding
Minosoft is modding friendly. I am working hard on a reasonable API. See !17 for more details. 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.
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).
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).
## Botting
On the ToDo List

11
doc/contributing/Development.md
View File

@ -5,11 +5,12 @@ Also, (before someone asks): I don't care if you use Kotlin or Java.
## Git Rules
- Small Features in `development`.
- `master` is always functional.
- No force pushes (or modifying the git history) on `master`.
- Bigger features on own branches. Merge only via Merge Request.
- No commits directly on `master`
- Small Features in `development`.
- `master` must always be stable and functional.
- No force pushes (or modifying the git history) in protected branches (aka. `master`).
- Bigger features on own branches. Merge only via Merge Request.
- No commits directly in `master`
## Git access
- Don't just request developer access, I'll not just give you access, instead create a fork, and a pull requests, we will accept (or decline) it. Probably a bit of discussion.