This repository has been archived on 2024-05-14. You can view files and clone it, but cannot push or open issues or pull requests.
awesome-xlabs/README.md

57 lines
2.0 KiB
Markdown
Raw Normal View History

2023-08-13 16:33:31 -04:00
# XLabs
2023-08-13 17:40:07 -04:00
[![patreon](https://img.shields.io/badge/patreon-support-blue.svg?logo=patreon)](https://www.patreon.com/xlabsproject)
[![discord](https://img.shields.io/endpoint?url=https://momo5502.com/iw4x/members-badge.php)](https://discord.gg/sKeVmR3)
<p align="center">
<img src="assets/github/banner-s1x.png?raw=true" />
</p>
<br/>
<p align="center">
<img alig src="assets/github/banner-iw6x.png?raw=true"/>
</p>
2023-08-13 18:31:19 -04:00
## Prerequisites: Installing Git
2023-08-13 16:33:31 -04:00
If you don't have `git` installed on your machine, follow these steps:
1. Visit the [Git download page](https://git-scm.com/downloads).
2. Download the appropriate version for your operating system.
2023-08-13 16:46:26 -04:00
3. Run the installer.
2023-08-13 16:33:31 -04:00
- During the installation, you will be asked if you want to add Git to your system's PATH environment variable. Ensure you choose the option to do so. This allows you to use Git from the command line without specifying its full path.
4. After installation, open a terminal or command prompt and type `git --version` to ensure Git is correctly installed.
2023-08-13 18:31:19 -04:00
## Download
2023-08-13 17:40:07 -04:00
Clone the Git repo. Do NOT download it as ZIP, that won't work.
2023-08-13 16:33:31 -04:00
- Open a terminal or command prompt.
- Run the following command:
```
2023-08-13 17:40:07 -04:00
git clone https://github.com/Ahrimdon/test-repo.git
2023-08-13 16:33:31 -04:00
```
2023-08-13 16:46:26 -04:00
2023-08-13 18:31:19 -04:00
## Repository Contents
- All XLabs Clients
- All XLabs Dedicated Server Configuration Files
- Complete XLabs Launcher
- All Original Game Binaries
- xlabs.dev Website
- Client Documentation (e.g. Changelogs, README's, etc.)
## Installation
### Clients
1. Move the the folder contents of the desired client into your game folder.
2. Launch the executable.
> **Note**: The executable and any accompanying folders should be in the base game directory.
2023-08-13 16:46:26 -04:00
2023-08-13 18:31:19 -04:00
### Launcher
2023-08-13 16:46:26 -04:00
2023-08-13 18:31:19 -04:00
1. Move the `xlabs` folder from `localappdata/xlabs` to your LocalAppData directory.
2023-08-13 17:40:07 -04:00
> **Note**: On Windows, press `Win + R`, type `%localappdata%`, click ok.
2023-08-13 18:31:19 -04:00
2. Extract `IW4XLauncher.exe` and run it.
3. Select the proper game path for your game(s) of choice and launch.