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.
43 lines
892 B
Markdown
43 lines
892 B
Markdown
# F4SE Notes
|
|
|
|
F4SE is expected to be the main entry point for the native plugin side of Commonwealth Online.
|
|
|
|
## Plugin Goals
|
|
|
|
The first plugin goals are:
|
|
|
|
- Confirm the plugin loads
|
|
- Create a log file
|
|
- Detect the game version
|
|
- Read the local player reference
|
|
- Read the local player position
|
|
- Send basic data to a local server
|
|
|
|
## Expected Plugin Output
|
|
|
|
Eventually, the compiled plugin should output something like:
|
|
|
|
```text
|
|
Data/F4SE/Plugins/CommonwealthOnline.dll
|
|
```
|
|
|
|
## Important Notes
|
|
|
|
Do not commit F4SE binaries to this repository.
|
|
|
|
Do not commit Fallout 4 executable files or game assets.
|
|
|
|
Use a CommonLibF4 template to reduce setup friction.
|
|
|
|
## Plugin Safety
|
|
|
|
Avoid modifying Fallout 4 game objects directly from a networking thread.
|
|
|
|
Recommended flow:
|
|
|
|
```text
|
|
Networking thread receives packets
|
|
Networking thread stores packet data
|
|
Main/game update applies safe changes
|
|
```
|