andrew
8dfec0a4b3
Replace occurrences of "Fallout 4 Together" with "Commonwealth Online" across docs and testing guidance. Add Interface assets and tooling: MainMenu/Pipboy SWFs, translation/fonts, exported scripts (Interface/exported/scripts/MainMenu.as) and a PATCH_MainMenu_Multiplayer.md describing how to add a Multiplayer menu entry that calls root.f4se.plugins.commonwealthOnline.openManager(). Also add build/run batch scripts and apply assorted updates to README, plugin, server and protocol documentation/source to align with the rename and UI changes.
56 lines
1.8 KiB
Markdown
56 lines
1.8 KiB
Markdown
# Commonwealth Online Plugin
|
|
|
|
This is the native Commonwealth Online F4SE plugin using CommonLibF4.
|
|
|
|
### Requirements
|
|
* [XMake](https://xmake.io) [3.0.0+]
|
|
* C++23 Compiler (MSVC or Clang-CL)
|
|
|
|
## Getting Started
|
|
```bat
|
|
git clone --recurse-submodules https://github.com/libxse/Fallout4Together
|
|
cd Fallout4Together
|
|
```
|
|
|
|
### Build
|
|
To build the project, run the following command:
|
|
```bat
|
|
xmake build
|
|
```
|
|
|
|
> ***Note:*** *This will generate a `build/windows/` directory in the **project's root directory** with the build output.*
|
|
|
|
### Build Output (Optional)
|
|
If you want to redirect the build output, set one of the following environment variables:
|
|
|
|
- Path to a Mod Manager mods folder: `XSE_FO4_MODS_PATH`
|
|
|
|
or
|
|
|
|
- Path to a Fallout 4 install folder: `XSE_FO4_GAME_PATH`
|
|
|
|
### Project Generation (Optional)
|
|
If you use Visual Studio, run the following command:
|
|
```bat
|
|
xmake project -k vsxmake
|
|
```
|
|
|
|
> ***Note:*** *This will generate a `vsxmakeXXXX/` directory in the **project's root directory** using the latest version of Visual Studio installed on the system.*
|
|
|
|
**Alternatively**, if you do not use Visual Studio, you can generate a `compile_commands.json` file for use with a laguage server like clangd in any code editor that supports it, like vscode:
|
|
```bat
|
|
xmake project -k compile_commands
|
|
```
|
|
|
|
> ***Note:*** *You must have a language server extension installed to make use of this file. I recommend `clangd`. Do not have more than one installed at a time as they will conflict with each other. I also recommend installing the `xmake` extension if available to make building the project easier.*
|
|
|
|
### Upgrading Packages (Optional)
|
|
If you want to upgrade the project's dependencies, run the following commands:
|
|
```bat
|
|
xmake repo --update
|
|
xmake require --upgrade
|
|
```
|
|
|
|
## Documentation
|
|
Please refer to the [Wiki](../../wiki/Home) for more advanced topics.
|