Files / folder structure added
This commit is contained in:
@@ -0,0 +1,38 @@
|
||||
# Native Plugin
|
||||
|
||||
This folder is for the native Fallout 4 Together plugin.
|
||||
|
||||
The plugin is expected to be built using F4SE and CommonLibF4.
|
||||
|
||||
## Responsibilities
|
||||
|
||||
The plugin should eventually:
|
||||
|
||||
- Load through F4SE
|
||||
- Create log output
|
||||
- Detect the local player
|
||||
- Read player transform data
|
||||
- Connect to the external server
|
||||
- Send local player state
|
||||
- Receive remote player state
|
||||
- Apply remote actor updates
|
||||
|
||||
## External Dependencies
|
||||
|
||||
Do not commit F4SE or CommonLibF4 binaries directly into this repository.
|
||||
|
||||
Document dependency setup in:
|
||||
|
||||
```text
|
||||
plugin/external/README.md
|
||||
```
|
||||
|
||||
## Build Output
|
||||
|
||||
Compiled plugin files should not be committed unless part of an official release.
|
||||
|
||||
Expected output eventually:
|
||||
|
||||
```text
|
||||
Data/F4SE/Plugins/Fallout4Together.dll
|
||||
```
|
||||
Vendored
+29
@@ -0,0 +1,29 @@
|
||||
# External Plugin Dependencies
|
||||
|
||||
This folder documents external dependencies.
|
||||
|
||||
Do not commit downloaded dependency binaries here unless their license allows it and the project intentionally vendors them.
|
||||
|
||||
Expected dependencies:
|
||||
|
||||
- Fallout 4 Script Extender, F4SE
|
||||
- CommonLibF4 or CommonLibF4 NG
|
||||
- CMake or XMake, depending on the selected template
|
||||
- Visual Studio C++ toolchain
|
||||
|
||||
## F4SE
|
||||
|
||||
Install F4SE into the Fallout 4 game folder according to the official instructions.
|
||||
|
||||
## CommonLibF4
|
||||
|
||||
Use a CommonLibF4 template as the starting point for the native plugin project.
|
||||
|
||||
Record the selected template here:
|
||||
|
||||
```text
|
||||
Selected template:
|
||||
Template URL:
|
||||
Commit/tag used:
|
||||
Date added:
|
||||
```
|
||||
@@ -0,0 +1,11 @@
|
||||
# Include
|
||||
|
||||
This folder is for shared native plugin header files.
|
||||
|
||||
Possible future headers:
|
||||
|
||||
- protocol types
|
||||
- player state types
|
||||
- network client declarations
|
||||
- logging declarations
|
||||
- configuration types
|
||||
@@ -0,0 +1,13 @@
|
||||
# Source
|
||||
|
||||
This folder is for Fallout 4 Together native plugin source files.
|
||||
|
||||
Initial planned source areas:
|
||||
|
||||
- Plugin entry point
|
||||
- Logging
|
||||
- F4SE/CommonLibF4 integration
|
||||
- Player state reading
|
||||
- Networking client
|
||||
- Remote player state storage
|
||||
- Safe game update application
|
||||
Reference in New Issue
Block a user