Skip to content

Update README to remove DLL info and clarify build steps #600

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
prathfr merged 2 commits into from
Nov 9, 2025
Merged

Update README to remove DLL info and clarify build steps #600

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc2a767
Update README to remove DLL info and clarify build steps
TheBarii Nov 8, 2025
176ac5d
Update README with contribution model and install options
TheBarii Nov 8, 2025
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
38 changes: 2 additions & 36 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,6 @@ Flarial Client is available in 2 forms:
- 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.

## Supported Platforms

- **Operating System:** Windows 10/11 (64-bit processors only)
Expand All @@ -37,38 +33,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