Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 8 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,13 @@
# Flarial Client
Welcome to **Flarial Client**, the ultimate modded client designed specifically for Minecraft Bedrock Edition (MCBE). Flarial Client enhances your gameplay with a suite of tools and features that optimize performance, improve visual quality, and provide a smoother gaming experience. yo.
Welcome to **Flarial Client**, the ultimate modded client designed specifically for Minecraft Bedrock Edition (MCBE). Flarial Client enhances your gameplay with a suite of tools and features that optimize performance, improve visual quality, and provide a smoother gaming experience.
## Support us on Ko-Fi! https://ko-fi.com/flarialmc

## CONTRIBUTION MODEL
Our current open-source model works as follows. Key portions of Flarial that we deem should be private are not part of this repository.
Alongside this, the current model contains delayed releases for version updates. For instance, if the current Minecraft version is 1.21.200, Flarial's signatures and offsets on this repository will stay on the previous version of Minecraft.

## Installation Options

Flarial Client is available in 2 forms:

### Flarial Launcher (Recommended)
- A user-friendly launcher that manages Flarial and other MCBE clients.
- Includes Discord integration for community and support.
- Offers additional Minecraft management features.

### Standalone DLL
- A minimal, lightweight version for advanced users.
- Requires an external injector to set up and run.
Furthermore, as an open-source contributor, you can make pull requests to Flarial with your feature of choice.
**However**, it is highly encouraged to **apply** to be part of the development team, for the moment, open a ticket in our discord.

## Supported Platforms

Expand All @@ -37,38 +30,8 @@ If you encounter issues, check out our [FAQ](https://discord.gg/flarial-communit

### Steps to Clone and Build the Project:

1. **Clone the Repository**:
Open a terminal or command prompt and clone the repository using Git:
```bash
git clone https://github.com/flarialmc/dll.git
```

2. **Navigate to the Project Directory**:
Change into the directory of the cloned repository:
```bash
cd dll
```

3. **Create a Build Directory**:
It's a good practice to create a separate directory for out-of-source builds. This keeps your source directory clean and allows for easier management of builds:
```bash
mkdir build
cd build
```

4. **Configure with CMake**:
Run CMake to configure the build environment. Specify the path to the CMakeLists.txt file in the root of the cloned repository:
```bash
cmake ..
```
This command generates the necessary build files based on the CMake configuration.

5. **Build the Project**:
Once CMake has configured the build files successfully, you can build the project using a suitable build tool (like `make` on Unix-like systems or Visual Studio on Windows):
```bash
cmake --build .
```
This command compiles the project according to the generated build files.
Method 1 - You can open this project in CLion or Visual Studio, and make sure to use the MSVC toolchain, preferably combined with Ninja. If you don't know what any of this means, please do some research on this matter.
Method 2 - You can use **build.bat** file as well.

By following these steps, you should be able to clone and build the project using CMake successfully.

Expand Down