You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
An open source rewrite of the *Minecraft: Java Edition* client, written in Swift for macOS. Currently Delta Client only supports connecting to 1.16.1 servers.
5
+
An open source rewrite of the *Minecraft: Java Edition* client, written in Swift for macOS and iOS (experimental). Currently Delta Client only supports connecting to **1.16.1** servers.
6
6
7
7
## Disclaimers
8
8
9
-
This client is not finished yet. If you're looking for a client to use to play Minecraft today, then this is not for you.
10
-
11
-
**I am NOT responsible for anti-cheat bans, the client has not been thoroughly tested yet and is still deep in development.**
9
+
This client is not finished yet. If you're looking for a client to use to play Minecraft today, then this is not for you. **I am NOT responsible for anti-cheat bans, the client has not been thoroughly tested yet and is still deep in development.**
12
10
13
11
**This software is not affiliated with Mojang AB, the original developer of Minecraft.**
14
12
15
13
## Overview
16
14
17
-
The main focus of this project is to create a highly efficient Java Edition compatible client written in Swift for macOS. Using Swift means that in the future the client may be able to run on iOS, iPadOS and maybe tvOS. This would allow playing on Java Edition servers with devices usually limited to Bedrock Edition. If there is sufficient interest, a separate renderer and UI could be created to support Linux and Windows as well (likely using the WebGPU graphics API instead of Metal).
15
+
The main focus of this project is to create a highly efficient Java Edition compatible client written in Swift for macOS. The client also has experimental support for iOS, and is in the process of getting ported to Linux using SwiftCrossUI and eventually Kinzoku (once it is ready).
18
16
19
17
If you want to have a say in the development of the client or have any questions, feel free to join the community on [Discord](https://discord.gg/xZPyDbmR6k).
20
18
21
-
19
+
20
+
21
+
## Performance
22
+
23
+
One of the biggest advantages of Delta Client is its performance. Epic comparison graphs are in progress, but for now have some dot-points.
- FPS on 10 render distance in the mountains (bad for fps):
29
+
- M2 MacBook Air (on 1080p monitor): ~120 fps (vanilla gets ~75 fps)
30
+
- i5 MacBook Air: ~70 fps (vanilla gets ~35fps)
22
31
23
32
## Installation
24
33
25
34
### Prebuilt
26
35
27
-
1. Visit [Delta Client's GitHub Actions page](https://delta.stackotter.dev/downloads) and download the `DeltaClient.zip` artifact from the latest successful build (you must be signed in to GitHub to download the artifact).
36
+
1. Visit [Delta Client's downloads page](https://delta.stackotter.dev/downloads) and download the
37
+
latest build from the `main` branch.
28
38
2. Unzip the downloaded zip archive and open the app inside
29
39
3. You will get a security alert, click ok
30
40
4. Right click the app in finder and select open
31
41
5. You should get another pop-up, click 'Open'
32
42
6. Delta Client will now open and start downloading the required assets (this only has to happen once and should take around 40s with a mediocre internet speed)
33
43
7. You can move Delta Client to your Applications folder for ease of use if you want
34
44
45
+
To run Delta Client from terminal you can run this command: `/path/to/DeltaClient.app/Contents/MacOS/DeltaClient --log-level debug`. This allows you to see the debug logs as the app is running.
46
+
35
47
### Building from source
36
48
37
-
To build Delta Client you'll first need to install Xcode and the latest version of [swift-bundler](https://github.com/stackotter/swift-bundler). Once you've installed both of those, run the following commands in terminal;
49
+
To build Delta Client you'll first need to install Xcode and the latest version of [Swift Bundler](https://github.com/stackotter/swift-bundler). Once you've installed both of those, run the following commands in terminal;
# Perform a release build, output the bundled app to the current directory
56
+
# Perform a release build and output the bundled app to the current directory
45
57
sh ./build.sh
46
58
47
59
# If you want to develop Delta Client using Xcode, run the following command
@@ -51,12 +63,12 @@ swift bundler generate-xcode-support
51
63
52
64
## Minecraft version support
53
65
54
-
At the moment the client only supports joining **1.16.1** servers. In the future I plan to support more versions. But not now, as that'd slow down development of more important features because it would create more maintenance work.
66
+
At the moment the client only supports joining **1.16.1** servers. In the future I plan to support more versions.
55
67
56
68
Not every version will be perfectly supported but I will try and have the most polished support for the following versions;
57
69
58
70
- 1.8.9
59
-
- the latest speedrunning version (currently 1.16.1 and may be for a while)
71
+
- the latest speedrunning version (currently 1.16.1)
60
72
- the latest stable version
61
73
62
74
## Features
@@ -110,7 +122,7 @@ Not every version will be perfectly supported but I will try and have the most p
110
122
-[x] Input system
111
123
-[x] Collision system
112
124
-[ ] Interaction
113
-
-[] Block placing
125
+
-[x] Block placing
114
126
-[ ] Block breaking
115
127
-[ ] Block entity interaction
116
128
-[ ] Entity interaction
@@ -123,26 +135,16 @@ Not every version will be perfectly supported but I will try and have the most p
123
135
124
136
## Contributing
125
137
126
-
First, please check out the [contributing guidelines](Contributing.md). Then you can checkout the [issues](https://github.com/stackotter/delta-client/issues) for a place to get started. Make sure to leave a comment on the issue you choose, so that people know that someone's already working on it.
138
+
First, please check out the [contributing guidelines](Contributing.md). Then you can checkout the [issues](https://github.com/stackotter/delta-client/issues) for a place to get started. Make sure to leave a comment on the issue you choose so that people know that someone's already working on it.
127
139
128
140
## Servers
129
141
130
-
We now have an official test server made by @ninjadev64! The address is `play.stackotter.dev`. To run it cheaply, the server goes to sleep. To join it click play and you'll get a message telling you that it's starting up. Wait around 10 seconds and then click play again and you should be good to go. Alternatively, you can run your own server on your computer (see below).
131
-
132
-
To start a test server, download a 1.16.1 server jar from [here](https://mcversions.net/download/1.16.1). Then in Terminal type `java -jar ` and then drag the download .jar file onto the terminal window and then hit enter. Wait for the server to start up. Now add a new server with the address `127.0.0.1` in Delta Client and you should be able to connect to it. Keep in mind the server may use a significant amount of resources and slow down Delta Client.
133
-
134
-
To run Delta Client from terminal you can run this command: `/path/to/DeltaClient.app/Contents/MacOS/DeltaClient`. This allows you to see the logs as the app is running.
135
-
136
-
## Troubleshooting
137
-
138
-
As Delta Client is still in development it is expected that you will probably run into some errors. Here are the basic troubleshooting steps you should take if you run into any errors;
139
-
140
-
First, create an issue on GitHub for the error.
142
+
We now have an official testing server (`play.deltaclient.app`)! However, if you want to mess around to your hearts content you can run a server on your computer for full control (see below).
141
143
142
-
If the error is in app startup, you can try running `rm ~/Library/Application Support/dev.stackotter.delta-client/.haslaunched`in Terminal to perform a fresh install. Next time the app starts it will perform a fresh install. Your configuration gets wiped but it is backed up in a zip archive in the same folder as .haslauncher
144
+
To start a test server, download a 1.16.1 server jar from [here](https://mcversions.net/download/1.16.1). Then in Terminal type `java -jar ` and then drag the downloaded .jar file onto the terminal window and then hit enter. Wait for the server to start up. Now add a new server with the address `localhost` in Delta Client and you should be able to connect to it. Keep in mind the server may use a significant amount of resources and slow down Delta Client.
0 commit comments