garv-shah / delta-client

An open source Minecraft Java Edition client built for speed.

Delta Client - Changing the meaning of speed

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.

Disclaimers

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.

This software is not affiliated with Mojang AB, the original developer of Minecraft.

Overview

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).

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.

Installation

Prebuilt

1. Visit Delta Client's GitHub Actions page and download the DeltaClient.zip artifact from the latest successful build (you must be signed in to GitHub to download the artifact).
2. Unzip the downloaded zip archive and open the app inside
3. You will get a security alert, click ok
4. Right click the app in finder and select open
5. You should get another pop-up, click 'Open'
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)
7. You can move Delta Client to your Applications folder for ease of use if you want

Building from source

To build Delta Client you'll first need to install Xcode and the latest version of swift-bundler. Once you've installed both of those, run the following commands in terminal;

# Clone Delta Client
git clone https://github.com/stackotter/delta-client
cd delta-client

# Perform a release build, output the bundled app to the current directory
sh ./build.sh

# If you want to develop Delta Client using Xcode, run the following command
swift bundler generate-xcode-support
# And then open Package.swift with Xcode and you'll be able to build it from Xcode too

Minecraft version support

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.

Not every version will be perfectly supported but I will try and have the most polished support for the following versions;

• 1.8.9
• the latest speedrunning version (currently 1.16.1 and may be for a while)
• the latest stable version

Features

• Networking
  • Basic networking
  • Server list ping
  • Encryption (for non-offline mode servers)
    • Mojang accounts
    • Microsoft accounts
  • LAN server detection
• Basic config system
  • Multi-accounting
• Rendering
  • World
    • Basic block rendering
    • Basic chunk rendering
    • Block culling
    • Block models
    • Multipart structures (e.g. fences)
    • Multiple chunks
    • Lighting
    • Animated textures (e.g. lava)
    • Translucency
    • Fluids (lava and water)
    • Chunk frustum culling
    • Biome blending (mostly)
  • Entities
    • Basic entity rendering (just coloured cubes)
    • Render entity models
    • Entity animations
    • Block entities (e.g. chests)
    • Item entities
  • GUI
    • Chat
    • F3-style stuff
    • Bossbars
    • Scoreboard
    • Health, hunger and experience
    • Hotbar
    • Inventory
      • Basic inventory
      • Basic crafting
      • Inventory actions
      • Using recipe blocks (like crafting tables and stuff)
      • Creative inventory
• Sound
  • Basic sounds system
• Physics
  • Physics loop
  • Input system
  • Collision system
• Interaction
  • Block placing
  • Block breaking
  • Block entity interaction
  • Entity interaction
• Particles
  • Basic particle system
  • Block break particles
  • Ambient particles
  • Hit particles
  • Particles from server

Contributing

First, please check out the contributing guidelines. Then you can checkout the 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.

Servers

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).

To start a test server, download a 1.16.1 server jar from here. 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.

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.

Troubleshooting

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;

First, create an issue on GitHub for the error.

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

More screenshots