andrew
8c09e91534
Add optional movement-state fields (isMoving, isSprinting, isSneaking, isJumping, weaponDrawn, movementSpeed) to transform packets and wire them end-to-end. Plugin changes: extend F4TNetworking API and RemotePlayerState, derive movement speed/jump state on the game-thread, validate values, include fields when formatting transform JSON, and add throttled remote movement-state logging. main.cpp adds sampling, speed/vertical calculations, jump hold logic, and change-detection to avoid extra sends. Networking parsing (F4TNetworking.cpp) reads optional booleans/floats safely, preserves backwards compatibility, and clears movement-state logs on disconnect. Proxy controller includes a TODO note for future animation use. Server and docs: update protocol and packet docs, dev-log, server README, and fake_client.py to parse/display optional fields safely. Also add several .cursor rule files for coding, documentation, protocol, project overview, and testing guidance. This milestone prepares the data model for later animation/behavior work while keeping existing relay behavior unchanged.
55 lines
1.2 KiB
Plaintext
55 lines
1.2 KiB
Plaintext
---
|
|
description: Documentation and development log update rules
|
|
alwaysApply: true
|
|
---
|
|
|
|
# Documentation Rules
|
|
|
|
After every meaningful code change, update the relevant documentation. Do not let code and documentation drift apart.
|
|
|
|
Always consider whether these files need updates:
|
|
- `docs/dev-log.md`
|
|
- `docs/protocol.md`
|
|
- `docs/architecture.md`
|
|
- `docs/setup.md`
|
|
- `docs/testing.md`
|
|
|
|
At minimum, after every milestone or feature change, update `docs/dev-log.md` with:
|
|
- Date
|
|
- Summary of what changed
|
|
- Files modified
|
|
- What was tested
|
|
- What worked
|
|
- Any known issues
|
|
- Suggested next steps
|
|
|
|
Use this dev-log format:
|
|
|
|
```md
|
|
## YYYY-MM-DD - Feature or Milestone Name
|
|
|
|
### Summary
|
|
Briefly explain what changed.
|
|
|
|
### Files Changed
|
|
- `path/to/file`
|
|
- `path/to/file`
|
|
|
|
### Details
|
|
- Important technical detail
|
|
- Important technical detail
|
|
|
|
### Testing
|
|
- What was tested
|
|
- What the expected result was
|
|
- What actually happened
|
|
|
|
### Known Issues
|
|
- Issue or `None currently known`
|
|
|
|
### Next Steps
|
|
- Suggested next task
|
|
```
|
|
|
|
If the protocol changes, update `docs/protocol.md`. If the architecture changes, update `docs/architecture.md`. If setup changes, update `docs/setup.md`. If testing workflow changes, update `docs/testing.md`.
|