Skip to content

Commit 49511e8

Browse files
Merge branch 'libxse:main' into main
2 parents fcb5794 + 3486476 commit 49511e8

2 files changed

Lines changed: 26 additions & 14 deletions

File tree

README.md

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,31 @@
11
# CommonLibF4
22

3-
## General Requirements
3+
### Requirements
4+
* [XMake](https://xmake.io) [2.8.2+]
5+
* C++23 Compiler (MSVC or Clang-CL)
46

5-
### Build Dependencies
6-
* [Visual Studio Community 2022 Preview](https://visualstudio.microsoft.com/vs/preview/)
7-
* Desktop development with C++
8-
* [binary-io](https://github.com/Ryan-rsm-McKenzie/binary_io)
9-
* [mmio](https://github.com/Ryan-rsm-McKenzie/mmio)
10-
* [spdlog](https://github.com/gabime/spdlog)
7+
## Getting Started
8+
```bat
9+
git clone --recurse-submodules https://github.com/libxse/commonlibf4
10+
cd commonlibf4
11+
```
1112

12-
### Development
13-
* [xmake](https://xmake.io/)
13+
### Build
14+
To build the project, run the following command:
15+
```bat
16+
xmake build
17+
```
1418

15-
## F4SE Plugin Requirements
19+
> ***Note:*** *This will generate a `build/windows/` directory in the **project's root directory** with the build output.*
1620
17-
### End User Dependencies
18-
* [Address Library for F4SE Plugins](https://www.nexusmods.com/fallout4/mods/47327)
19-
* [F4SE](https://f4se.silverlock.org/)
21+
### Project Generation (Optional)
22+
If you want to generate a Visual Studio project, run the following command:
23+
```bat
24+
xmake project -k vsxmake
25+
```
26+
27+
> ***Note:*** *This will generate a `vsxmakeXXXX/` directory in the **project's root directory** using the latest version of Visual Studio installed on the system.*
28+
29+
## Notes
30+
31+
CommonLibF4 is intended to replace F4SE as a static dependency. However, the runtime component of F4SE is still required.

0 commit comments

Comments
 (0)