73 lines
1.7 KiB
Markdown
73 lines
1.7 KiB
Markdown
# Contributing
|
|
|
|
Fallout 4 Together is currently in the research and prototype stage.
|
|
|
|
At this stage, contributions should focus on documentation, research, setup notes, tooling experiments, and small isolated prototypes.
|
|
|
|
## Current Contribution Areas
|
|
|
|
Useful contributions include:
|
|
|
|
- F4SE setup notes
|
|
- CommonLibF4 setup notes
|
|
- Creation Kit test cell documentation
|
|
- Fallout 4 actor sync research
|
|
- Network packet design
|
|
- Server architecture experiments
|
|
- Safe testing workflows
|
|
- Crash reports from controlled test builds
|
|
|
|
## Scope
|
|
|
|
Please keep contributions focused on the first prototype goal:
|
|
|
|
> Two Fallout 4 clients in a controlled test environment, with each player visible as a synced remote actor.
|
|
|
|
Avoid adding large systems before the core prototype works.
|
|
|
|
Out of scope for early development:
|
|
|
|
- Full campaign co-op
|
|
- Quest sync
|
|
- Settlement sync
|
|
- Public matchmaking
|
|
- Anti-cheat
|
|
- Large modlist support
|
|
- MMO-style gameplay
|
|
|
|
## Legal Requirements
|
|
|
|
Do not contribute:
|
|
|
|
- Fallout 4 executable files
|
|
- Bethesda game assets
|
|
- Bethesda archives
|
|
- DLC files
|
|
- F4SE binaries
|
|
- Proprietary game code
|
|
- Decompiled Bethesda scripts
|
|
- Other mods' files without permission
|
|
|
|
Only contribute files that you have the right to share.
|
|
|
|
## Recommended Workflow
|
|
|
|
1. Open an issue describing the problem or idea.
|
|
2. Keep changes small and focused.
|
|
3. Document what was tested.
|
|
4. Use a clean Fallout 4 test profile when testing.
|
|
5. Avoid testing with large modlists.
|
|
|
|
## Commit Style
|
|
|
|
Suggested commit prefixes:
|
|
|
|
```text
|
|
docs: update setup notes
|
|
research: add actor sync notes
|
|
plugin: add basic plugin skeleton
|
|
server: add connection prototype
|
|
ck: document test cell plan
|
|
protocol: define transform packet
|
|
```
|